| /llvm-project/openmp/docs/ |
| H A D | README.txt | 1 OpenMP LLVM Documentation
4 OpenMP LLVM's documentation is written in reStructuredText, a lightweight
8 system to create HTML pages which are hosted on <https://llvm.org/docs/> and
11 If you instead would like to generate and view the HTML locally, install
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` <->
[all …]
|
| H A D | index.rst | 1 .. title:: Welcome to the documentation of OpenMP in LLVM!
6 additions. Please post on the `Discourse forums (Runtimes -
7 OpenMP) <https://discourse.llvm.org/c/runtimes/openmp/35>`__..
13 LLVM/OpenMP Documentation <self>
16 LLVM/OpenMP Design & Overview
19 OpenMP impacts various parts of the LLVM project, from the frontends (`Clang
20 <https://clang.llvm.org/docs/OpenMPSupport.html>`_ and Flang), through
21 middle-end :ref:`optimizations <llvm_openmp_optimizations>`, up to the
22 multitude of available :ref:`OpenMP runtimes <openmp_runtimes>`.
24 A high-level overview of OpenMP in LLVM can be found :doc:`here <design/Overview>`.
[all …]
|
| H A D | CMakeLists.txt | 27 set(OPENMP_DOXYGEN_QCH_FILENAME "org.llvm.openmp.qch" CACHE STRING
29 set(OPENMP_DOXYGEN_QHP_NAMESPACE "org.llvm.openmp" CACHE STRING
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-openmp
80 COMMENT "Generating openmp doxygen documentation." VERBATIM)
81 set_target_properties(doxygen-openmp PROPERTIES FOLDER "OpenMP/Docs")
84 add_dependencies(doxygen doxygen-openmp)
88 install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doxygen/html
89 DESTINATION docs/html)
[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 -----
13 OpenMP in LLVM Technical Call
16 - Developmen
[all...] |
| H A D | conf.py | 1 # -*- coding: utf-8 -*-
4 # sphinx-quickstart on Sun Dec 9 20:01:55 2012.
22 # -- General configuration -----------------------------------------------------
38 # source_encoding = 'utf-8-sig'
44 project = "LLVM/OpenMP"
45 copyright = "2013-%d, LLVM/OpenMP" % date.today().year
63 # non-false value, then it is used:
75 # If true, '()' will be appended to :func: etc. cross-reference text.
93 # -- Options for HTML output ---------------------------------------------------
95 # The theme to use for HTML and HTML Help pages. See the documentation for
[all …]
|
| H A D | CommandLineArgumentReference.rst | 1 OpenMP Command-Line Argument Reference
3 Welcome to the OpenMP in LLVM command line argument reference. The content is
4 not a complete list of arguments but includes the essential command-line
5 arguments you may need when compiling and linking OpenMP.
6 Section :ref:`general_command_line_arguments` lists OpenMP command line options
8 options relevant to OpenMP target offloading.
12 OpenMP Command-Line Arguments
13 -----------------------------
15 ``-fopenmp``
17 Enable the OpenMP compilation toolchain. The compiler will parse OpenMP
[all …]
|
| H A D | doxygen.cfg.in | 16 #---------------------------------------------------------------------------
18 #---------------------------------------------------------------------------
21 # that follow. The default is UTF-8 which is also the encoding used for all text
25 # The default value is: UTF-8.
27 DOXYFILE_ENCODING = UTF-8
30 # double-quotes, unless you are using Doxywizard) that should identify the
35 PROJECT_NAME = "LLVM OpenMP"
63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
77 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
79 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
[all …]
|
| /llvm-project/.github/workflows/ |
| H A D | docs.yml | 4 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
14 - 'main'
16 - 'llvm/docs/**'
17 - 'clang/docs/**'
18 - 'clan
[all...] |
| /llvm-project/openmp/docs/remarks/ |
| H A D | OptimizationRemarks.rst | 1 OpenMP Optimization Remarks
4 The :doc:`OpenMP-Aware optimization pass </optimizations/OpenMPOpt>` is able to
6 pass these options to the Clang invocation: ``-Rpass=openmp-opt
7 -Rpass-analysis=openmp-opt -Rpass-missed=openmp-opt``. For more information and
10 … emit optimization reports <https://clang.llvm.org/docs/UsersManual.html#options-to-emit-optimizat…
11 … diagnostic and remark flags <https://clang.llvm.org/docs/ClangCommandLineReference.html#diagnosti…
12 + The `-foptimization-record-file flag
13 …<https://clang.llvm.org/docs/ClangCommandLineReference.html#cmdoption-clang-foptimization-record-f…
14 and the `-fsave-optimization-record flag
15 …<https://clang.llvm.org/docs/ClangCommandLineReference.html#cmdoption-clang1-fsave-optimization-re…
[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 ---
28 https://llvm.org/docs/GettingStarted.html.
35 which it depends. These projects include mlir, clang, flang, openmp, and
36 compiler-rt. Note that compiler-rt is only needed to access libraries that
39 includig GNU and clang. But building compiler-rt requres using the clang
44 into a directory called llvm-project. The build will also
[all …]
|
| H A D | DesignGuideline.md | 1 <!--===- docs/DesignGuideline.md
5 SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 -->
11 ---
13 ---
33 The design document should be added to the `docs` folder as a markdown document,
35 Phabricator is the pre-requisite to submitting patches implementing new
48 [LLVM Testing Guide](https://llvm.org/docs/TestingGuide.html)), and if some
49 existing end-to-end test suite or application can be used to validate the
52 Features impacting projects outside of flang (like work OpenMP or OpenACC that
[all …]
|
| /llvm-project/clang-tools-extra/docs/clang-tidy/checks/ |
| H A D | list.rst | 1 .. title:: clang-tidy - Clang-Tidy Checks
3 Clang-Tidy Checks
16 clang-analyzer/*
30 openmp/*
36 .. csv-table::
39 :doc:`abseil-cleanup-ctad <abseil/cleanup-cta
[all...] |
| /llvm-project/libc/docs/gpu/ |
| H A D | using.rst | 20 library for offloading languages such as OpenMP, CUDA, or HIP. These aim to
27 ---------
[all...] |
| H A D | building.rst | 17 it *must* be built with an up-to-date ``clang`` compiler. This is because the
21 ``nvptx64-nvidia-cuda`` for NVIDIA GPUs or ``amdgcn-amd-amdhsa`` for AMD GPUs.
22 Targeting these architectures is done through ``clang``'s cross-compiling
23 support using the ``--target=<triple>`` flag. The following sections will
30 -
[all...] |
| /llvm-project/llvm/docs/ |
| 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...] |
| H A D | CMake.rst | 11 `CMake <http://www.cmake.org/>`_ is a cross-platform build-generator tool. CMake
34 We use here the command-line, non-interactive CMake interface.
36 #. `Download <http://www.cmake.org/cmake/resources/software.html>`_ and install
45 .. code-block:: console
53 .. code-block:: console
70 components are built; see the `Frequently Used LLVM-related
76 .. code-block:: console
78 $ cmake -
[all...] |
| H A D | DiscourseMigrationGuide.md | 35 …to a category or topic](https://discourse.mozilla.org/t/how-do-i-subscribe-to-categories-and-topic…
37 ([tested](https://llvm.discourse.group/t/email-interaction-with-discourse/3306/4) on GMail).
38 …vious topics in an reply](https://meta.discourse.org/t/single-quote-block-dropped-in-email-reply/1…
40 `List-ID` email header field.
52 <tr><td>IR & Optimizations - Loop Optimizations</td><td>IR.Optimizations-Loops@discourse.llvm.org</…
54 <tr><td>Code Generation - AMDGPU</td><td>codegen-amdgpu@discourse.llvm.org</td></tr>
55 <tr><td>Code Generation - Common Infrastructure</td><td>codegen-common@discourse.llvm.org</td></tr>
56 <tr><td>Code Generation - AArch64</td><td>codegen-aarch64@discourse.llvm.org</td></tr>
57 <tr><td>Code Generation - Arm</td><td>codegen-arm@discourse.llvm.org</td></tr>
58 <tr><td>Code Generation - PowerPC</td><td>codegen-powerpc@discourse.llvm.org</td></tr>
[all …]
|
| /llvm-project/openmp/ |
| H A D | README.rst | 2 How to Build the LLVM* OpenMP* Libraries
5 and Clang need a more recent version which also applies for in-tree builds. For
7 `LLVM's CMake documentation <https://llvm.org/docs/CMake.html>`_ and the
8 `official documentation <https://cmake.org/cmake/help/v2.8.0/cmake.html>`_.
15 - When calling CMake for the first time, all needed compiler options must be
20 - Example of configuring, building, reconfiguring, rebuilding:
22 .. code-block:: console
26 $ cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ .. # Initial configuration
30 $ cmake -DCMAKE_BUILD_TYPE=Debug .. # Second configuration
33 $ rm -rf *
[all …]
|
| /llvm-project/polly/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/ -->
4 <html>
6 <META http-equi
[all...] |
| /llvm-project/polly/docs/ |
| H A D | UsingPollyWithClang.rst | 23 Optimizing with Polly is as easy as adding -O3 -mllvm -polly to your compiler
25 -O1,-O2,-O3; Optimizing for size with -Os or -Oz is not recommended).
27 .. code-block:: console
29 clang -O
[all...] |
| /llvm-project/clang/docs/ |
| H A D | ClangLinkerWrapper.rst | 8 .. _clang-linker-wrapper:
28 .. code-block:: console
30 USAGE: clang-linker-wrapper [options] -- <options to passed to the linker>
33 --cuda-pat
[all...] |
| H A D | ClangOffloadBundler.rst | 8 .. _clang-offload-bundler:
14 ``--offload-arch=<target-id>`` Clang options to specify the target IDs of the
19 devices. The ``clang-offload-bundler`` tool may be used as part of the tool
24 non-heterogeneous tool chains. The bundled code object contains the code objects
30 offload kind (see :ref:`clang-offloa
[all...] |
| /llvm-project/clang-tools-extra/docs/clang-tidy/ |
| H A D | index.rst | 2 Clang-Tidy
12 List of Clang-Tidy Checks <checks/list>
13 Clang-tidy IDE/Editor Integrations <Integrations>
15 External Clang-Tidy Examples <ExternalClang-TidyExamples>
17 :program:`clang-tidy` is a clang-based C++ "linter" tool. Its purpose is to
20 static analysis. :program:`clang-tidy` is modular and provides a convenient
24 Using Clang-Tidy
27 :program:`clang-tid
[all...] |
| /llvm-project/llvm/docs/Proposals/ |
| H A D | VariableNames.rst | 12 inevitably be some details that are flawed. You can help - you can edit this
15 <http://lists.llvm.org/pipermail/llvm-dev/2019-February/130083.html>`_.
26 <../CodingStandards.html#name-types-functions-variables-and-enumerators-properly>`_
43 The proliferation of acronyms leads to hard-to-read code such as `this
44 <https://github.com/llvm/llvm-project/blob/0a8bc14ad7f3209fe702d18e250194cd90188596/llvm/lib/Transf…
61 This work-in-progress proposal is to change the coding standard for variable
65 …<https://github.com/llvm/llvm-project/blob/8b72080d4d7b13072f371712eed333f987b7a18e/llvm/lib/CodeG…
74 but here we use the terminology from clang-tidy).
91 ------------------------------
114 While switching coding standard will make it easier to use non-acronym names for
[all …]
|
| /llvm-project/llvm/docs/CommandGuide/ |
| H A D | tblgen.rst | 1 tblgen - Description to C++ Code
7 --------
9 :program:`clang-tblge
[all...] |