/llvm-project/.github/workflows/ |
H A D | docs.yml | 4 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 name: "Test documentation build" 14 - 'main' 16 - 'llvm/docs/**' 17 - 'clang/docs/**' [all...] |
H A D | release-documentation.yml | 9 release-version: 20 release-version: 30 release-documentation: 31 name: Build and Upload Release Documentation 32 runs-on: ubuntu-latest 34 upload: ${{ inputs.upload && !contains(inputs.release-version, 'rc') }} 36 - name: Checkout LLVM 39 - name: Setup Python env 40 uses: actions/setup-pytho [all...] |
H A D | release-doxygen.yml | 9 release-version: 20 release-version: 34 release-doxygen: 35 name: Build and Upload Release Doxygen 36 runs-on: ubuntu-latest 40 upload: ${{ inputs.upload && !contains(inputs.release-version, 'rc') }} 42 - name: Checkout LLVM 45 - name: Setup Python env 46 uses: actions/setup-pytho [all...] |
/llvm-project/llvm/docs/ |
H A D | README.txt | 8 system to create HTML pages which are hosted on <https://llvm.org/docs/> and 12 Sphinx <http://sphinx-doc.org/> and then do: 14 cd <build-dir> 15 cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir> 16 make -j3 docs-llvm-html 17 $BROWSER <build-dir>/docs/html/index.html 20 `docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `https://llvm.org/docs/Foo.html`. 33 directory `<build-dir>/docs/man/`. 35 cd <build-dir> 36 cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir> [all …]
|
H A D | SphinxQuickstartTemplate.rst | 5 …in the state of “I want to write documentation and get it added to LLVM’s docs” and help them star… 15 .. _`reStructuredText`: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html 16 .. _`Sphinx`: http://www.sphinx-doc.org 21 …docs/SphinxQuickstartTemplate.rst``. To use it as a template, make a copy and open it in a text ed… 30 plain-text conventions so it should be quite natural. A basic knowledge of 36 Sphinx's output, see ``docs/README.txt`` for information. Once you have finished with the content, … 37 llvm-commits for review. 40 --------------------- 50 A standard best practice is to make your articles task-oriented. You generally should not be writin… 54 When creating a task-oriented article, follow existing LLVM articles by giving it a filename that s… [all …]
|
H A D | TestSuiteGuide.md | 1 test-suite Guide 5 --------- [all...] |
H A D | CompilerWriterInfo.rst | 10 This document is a work-in-progress. Additions and clarifications are 17 ------------- 19 * `ARMv8-A Architecture Reference Manual <https://developer.arm.com/docs/ddi0487/latest>`_ This doc… 21 * `ARMv7-A Architecture Reference Manual <https://developer.arm.com/docs/ddi0406/latest>`_ This has… 23 * `ARMv7-M Architecture Reference Manual <https://developer.arm.com/docs/ddi0403/latest>`_ This cov… 25 * `ARMv6-M Architecture Reference Manual <https://developer.arm.com/docs/ddi0419/latest>`_ This cov… 33 * `Cortex-A57 Software Optimization Guide <http://infocenter.arm.com/help/topic/com.arm.doc.uan0015… 35 * `Run-time ABI for the ARM Architecture <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0043d… 38 -------------- 43 ----- [all …]
|
H A D | GettingInvolved.rst | 31 The LLVM project's code-review process. 34 The LLVM support policy for core and non-core components. 52 Describes how to use the llvm-project repository and code reviews on GitHub. 60 .. _development-process: 63 ------ [all...] |
/llvm-project/llvm/utils/release/ |
H A D | build-docs.sh | 2 #===-- build-docs.sh - Tag the LLVM release candidates ---------------------===# 6 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 8 #===------------------------------------------------------------------------===# 10 # Build documentation for LLVM releases. 14 # * dnf install doxygen texlive-epstopdf ghostscript \ 15 # ninja-build gcc-c++ 16 # * pip install --user -r ./llvm/docs/requirements.txt 18 # * apt-get install doxygen \ 19 # ninja-build graphviz texlive-font-utils 20 # * pip install --user -r ./llvm/docs/requirements.txt [all …]
|
/llvm-project/openmp/docs/ |
H A D | README.txt | 8 system to create HTML pages which are hosted on <https://llvm.org/docs/> and 12 Sphinx <http://sphinx-doc.org/> and then do: 14 cd <build-dir> 15 …cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true -DCMAKE_MODULE_PATH=/path/to/llvm/cmake/… 16 make docs-openmp-html 17 $BROWSER <build-dir>/docs/html/index.html 20 `docs/Foo.rst` <-> `<build-dir>/projects/openmp/docs//html/Foo.html` <-> 21 `https://openmp.llvm.org/docs/Foo.html`. 24 `llvm/docs/SphinxQuickstartTemplate.rst` which will get you writing 34 directory `<build-dir>/docs/man/`. [all …]
|
H A D | SupportAndFAQ.rst | 4 Please do not hesitate to reach out to us on the `Discourse forums (Runtimes - OpenMP) <https://discourse.llvm.org/c/runtimes/openmp/35>`_ or join 11 ----- 16 - Development updates on OpenMP (and OpenACC) in the LLVM Project, including Clang, optimization, and runtime work. 17 - Join `OpenMP in LLVM Technical Call <https://bluejeans.com/544112769//webrtc>`__. 18 - Time: Weekly call on every Wednesday 7:00 AM Pacific time. 19 - Meetin [all...] |
/llvm-project/flang/docs/ |
H A D | GettingStarted.md | 1 <!--===- docs/GettingStarted.md 5 SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 7 --> 12 --- 14 --- 18 There are two ways to build flang. The first method is to build it at the same 19 time that you build all of the projects on which it depends. This is called 20 building in tree. The second method is to first do an in tree build to create 22 build, only build the flang code itself. This is called building standalone. 24 create the base build and base install areas, you can create multiple [all …]
|
/llvm-project/clang/www/analyzer/ |
H A D | scan-build.html | 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" 5 <title>The scan-build documentation has moved to clang.llvm.org</title> 6 …nk rel="canonical" href="https://clang.llvm.org/docs/analyzer/user-docs/CommandLineUsage.html#scan… 7 …<meta http-equiv="refresh" content="0;url=https://clang.llvm.org/docs/analyzer/user-docs/CommandLi… 15 <!--#include virtual="menu.html.incl"--> 18 <h1>The scan-build documentation has moved to clang.llvm.org</h1> 19 <p style="color:red; font-size:200%">This page is deprecated and will be removed in release 21.0</p> 20 <a href="https://clang.llvm.org/docs/analyzer/user-docs/CommandLineUsage.html#scan-build">The new s… 21 <script>window.location='https://clang.llvm.org/docs/analyzer/user-docs/CommandLineUsage.html#scan-… 23 </div> <!-- content --> [all …]
|
/llvm-project/third-party/benchmark/ |
H A D | README.md | 3 …build-and-test](https://github.com/google/benchmark/workflows/build-and-test/badge.svg)](https://g… 6 …st-bindings](https://github.com/google/benchmark/workflows/test-bindings/badge.svg)](https://githu… 33 [User Guide](docs/user_guide.md) for a more comprehensive feature overview. 35 …read the [Google Test documentation](https://github.com/google/googletest/blob/main/docs/primer.md) 40 [Discussion group](https://groups.google.com/d/forum/benchmark-discuss) 45 [Additional Tooling Documentation](docs/tools.md) 47 [Assembly Testing Documentation](docs/AssemblyTests.md) 49 [Building and installing Python bindings](docs/python_bindings.md) 53 The library can be used with C++03. However, it requires C++11 to build, 56 The following minimum versions are required to build the library: [all …]
|
/llvm-project/compiler-rt/www/ |
H A D | index.html | 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" 3 <!-- Material used from: HTML 4.01 specs: http://www.w3.org/TR/html401/ --> 6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 7 <title>"compiler-r [all...] |
/llvm-project/utils/bazel/ |
H A D | README.md | 3 *Warning* The Bazel build is experimental and best-effort, supported in line 5 [LLVM's peripheral support tier](https://llvm.org/docs/SupportPolicy.html). 6 LLVM's official build system is CMake. If in doubt use that. If you make changes 7 to LLVM, you're expected to update the CMake build but you don't need to update 8 Bazel build files. Reviewers should not ask authors to update Bazel build files 9 unless the author has opted in to support Bazel. Keeping the Bazel build files 10 up-to-dat [all...] |
/llvm-project/clang/docs/ |
H A D | CMakeLists.txt | 32 "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters") 34 "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes") 77 add_custom_target(doxygen-clang 81 set_target_properties(doxygen-clang PROPERTIES FOLDER "Clang/Docs") 84 add_dependencies(doxygen doxygen-clan [all...] |
/llvm-project/polly/www/ |
H A D | get_started.html | 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" 5 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> 6 <title>Polly - Getting Started</title> 13 <!--#include virtual="menu.html.incl"--> [all...] |
/llvm-project/clang-tools-extra/docs/clang-tidy/ |
H A D | Contributing.rst | 5 :program:`clang-tidy` has several own checks and can run Clang static analyzer 8 Checks are organized in modules, which can be linked into :program:`clang-tidy` 9 with minimal or no code changes in :program:`clang-tidy`. 13 report them in a way similar to how Clang diagnostics work. A fix-it hint can be 16 The interface provided by :program:`clang-tidy` makes it easy to write useful 20 There are a few tools particularly useful when developing clang-tidy checks: 25 * :program:`pp-trace` logs method calls on `PPCallbacks` for a source file 27 * :program:`clang-query` is invaluable for interactive prototyping of AST 29 * `clang-check`_ with the ``-as [all...] |
/llvm-project/lldb/docs/resources/ |
H A D | fuzzing.rst | 5 -------- 7 …mponents of LLDB. The fuzzers are built with `libFuzzer <https://llvm.org/docs/LibFuzzer.html>`_ .… 10 -------------------- 12 …build configuration that has the address sanitizer and sanitizer coverage enabled. In addition to … 16 -DLLVM_USE_SANITIZER='Address' \ 17 -DLLVM_USE_SANITIZE_COVERAGE=On \ 18 -DCLANG_ENABLE_PROTO_FUZZER=ON 20 …zzer's sanitizer coverage is available here: `<https://llvm.org/docs/LibFuzzer.html#fuzzer-usage>`_ 22 If you want to debug LLDB itself when you find a bug using the fuzzers, use the CMake option ``-DCM… 24 To build a fuzzer, run the desired ninja command for the fuzzer(s) you want to build: [all …]
|
H A D | contributing.rst | 5 --------------- 8 <https://llvm.org/docs/GettingStarted.html>`_ for general information on how to 9 get started on the LLVM project. A detailed explanation on how to build and 10 test LLDB can be found in the `build instructions <build.html>`_ and `test 14 -------------------- 17 <https://llvm.org/docs/DeveloperPolicy.html>`_ for information about 27 LLDB's code style differs from `LLVM's coding style <https://llvm.org/docs/CodingStandards.html>`_ 30 …e and function naming <https://llvm.org/docs/CodingStandards.html#name-types-functions-variables-a… 39 * `Use of asserts <https://llvm.org/docs/CodingStandards.html#assert-liberally>`_: 43 `golden rule <https://llvm.org/docs/CodingStandards.html#introduction>`_ [all …]
|
H A D | build.rst | 5 ---------- [all...] |
/llvm-project/mlir/docs/Tools/ |
H A D | MLIRLSP.md | 6 [LSP](https://microsoft.github.io/language-server-protocol/) IDE language 7 extensions for various MLIR-related languages. An LSP language extension is 14 ## MLIR LSP Language Server : `mlir-lsp-server` 17 in the form of the `mlir-lsp-server` tool. This tool interacts with the MLIR C++ 22 `mlir-lsp-server`, like many other MLIR based tools, relies on having the 24 formats used in the textual .mlir files. The `mlir-lsp-server` found within the 26 Downstream and out-of-tree users will need to provide a custom 27 `mlir-lsp-server` executable that registers the entities that they are 28 interested in. The implementation of `mlir-lsp-server` is provided as a library, 33 #include "mlir/Tools/mlir-lsp-server/MlirLspServerMain.h" [all …]
|
/llvm-project/clang/www/ |
H A D | hacking.html | 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" 3 <!-- Material used from: HTML 4.01 specs: http://www.w3.org/TR/html401/ --> 6 <META http-equiv="Content-Type" content="text/html; charset=utf-8"> 11 pre { margin-left: 1.5em; } 15 <!- [all...] |
/llvm-project/ |
H A D | README.md | 3 …ds.dev/projects/github.com/llvm/llvm-project/badge)](https://securityscorecards.dev/viewer/?uri=gi… 5 …-project/actions/workflows/libcxx-build-and-test.yaml/badge.svg?branch=main&event=schedule)](https… 10 construction of highly optimized compilers, optimizers, and run-time 19 C-like languages use the [Clang](https://clang.llvm.org/) frontend. This 20 component compiles C, C++, Objective-C, and Objective-C++ code into LLVM bitcode 21 -- and from there into object files, using LLVM. 30 [Getting Started with LLVM](https://llvm.org/docs/GettingStarted.html#getting-the-source-code-and-b… 34 the [Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide. 40 [LLVM Office Hours](https://llvm.org/docs/GettingInvolved.html#office-hours) or 41 [Regular sync-ups](https://llvm.org/docs/GettingInvolved.html#online-sync-ups). [all …]
|