llvm-project/openmp/docs
Jonathan Peyton df20599597 [OpenMP][libomp] Add core attributes to KMP_HW_SUBSET
Allow filtering of resources based on core attributes. There are two new
attributes added:
1) Core Type (intel_atom, intel_core)
2) Core Efficiency (integer) where the higher the efficiency, the more
   performant the core
On hybrid architectures , e.g., Alder Lake, users can specify
KMP_HW_SUBSET=4c:intel_atom,4c:intel_core to select the first four Atom
and first four Big cores. The can also use the efficiency syntax. e.g.,
KMP_HW_SUBSET=2c:eff0,2c:eff1

Differential Revision: https://reviews.llvm.org/D114901
2021-12-10 14:34:33 -06:00
..
_static [OpenMP] Add Missing _static Director for OpenMP Documentation 2020-09-27 15:35:47 -04:00
_templates
_themes [OpenMP][Docs] Structure and content for the OpenMP documentation 2020-10-30 01:31:48 -05:00
design [OpenMP][libomp] Add core attributes to KMP_HW_SUBSET 2021-12-10 14:34:33 -06:00
openacc [OpenMP][OpenACC] Implement `ompx_hold` map type modifier extension in Clang (1/2) 2021-08-31 16:13:49 -04:00
optimizations [NFC] Trim trailing whitespace in *.rst 2021-11-15 09:17:08 +08:00
remarks [NFC] Trim trailing whitespace in *.rst 2021-11-15 09:17:08 +08:00
CMakeLists.txt [OpenMP] Add doxygen generation for the runtime 2020-12-08 16:20:45 -08:00
README.txt
ReleaseNotes.rst [NFC] Correct documentation error in OpenMP release ReleaseNotes 2021-07-20 02:04:43 +00:00
SupportAndFAQ.rst [NFC] Trim trailing whitespace in *.rst 2021-11-15 09:17:08 +08:00
conf.py [OpenMP][Docs] Structure and content for the OpenMP documentation 2020-10-30 01:31:48 -05:00
doxygen-mainpage.dox [OpenMP] Add doxygen generation for the runtime 2020-12-08 16:20:45 -08:00
doxygen.cfg.in [NFC] Inclusive Language: change master to main for .chm files 2021-11-08 08:23:04 -06:00
index.rst [OpenMP][OpenACC] Implement `ompx_hold` map type modifier extension in Clang (1/2) 2021-08-31 16:13:49 -04:00

README.txt

OpenMP LLVM Documentation
==================

OpenMP LLVM's documentation is written in reStructuredText, a lightweight
plaintext markup language (file extension `.rst`). While the
reStructuredText documentation should be quite readable in source form, it
is mostly meant to be processed by the Sphinx documentation generation
system to create HTML pages which are hosted on <https://llvm.org/docs/> and
updated after every commit. Manpage output is also supported, see below.

If you instead would like to generate and view the HTML locally, install
Sphinx <http://sphinx-doc.org/> and then do:

    cd <build-dir>
    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
    make
    $BROWSER <build-dir>/projects/openmp/docs//html/index.html

The mapping between reStructuredText files and generated documentation is
`docs/Foo.rst` <-> `<build-dir>/projects/openmp/docs//html/Foo.html` <->
`https://openmp.llvm.org/docs/Foo.html`.

If you are interested in writing new documentation, you will want to read
`llvm/docs/SphinxQuickstartTemplate.rst` which will get you writing
documentation very fast and includes examples of the most important
reStructuredText markup syntax.

Manpage Output
===============

Building the manpages is similar to building the HTML documentation. The
primary difference is to use the `man` makefile target, instead of the
default (which is `html`). Sphinx then produces the man pages in the
directory `<build-dir>/docs/man/`.

    cd <build-dir>
    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
    make
    man -l >build-dir>/docs/man/FileCheck.1

The correspondence between .rst files and man pages is
`docs/CommandGuide/Foo.rst` <-> `<build-dir>/projects/openmp/docs//man/Foo.1`.
These .rst files are also included during HTML generation so they are also
viewable online (as noted above) at e.g.
`https://openmp.llvm.org/docs/CommandGuide/Foo.html`.