This is an archive of the discontinued LLVM Phabricator instance.

Differential D42005

[docs] Use monospace for PCH option flags
ClosedPublic

Authored by modocache on Jan 12 2018, 11:43 AM.

Details

Reviewers
sepavloff
aaron.ballman
Commits
rG4995614f7c2d: [docs] Use monospace for PCH option flags
rL322447: [docs] Use monospace for PCH option flags
rC322447: [docs] Use monospace for PCH option flags
Summary

Use monospace for option flags in the PCH section, instead of the
italics that were being used previously.

I believe these used to be links, for which single backticks would
have been appropriate, but since they were un-link-ified in
https://reviews.llvm.org/rL275560, I believe monospace is now more
appropriate, and so two backticks are needed.

Test Plan:
Build the docs-clang-html target and confirm the options are rendered
using monospace font.

Diff Detail

Repository
rC Clang

Event Timeline

modocache created this revision.Jan 12 2018, 11:43 AM
Harbormaster completed remote builds in B13793: Diff 129675.Jan 12 2018, 11:43 AM
aaron.ballman accepted this revision.Jan 13 2018, 8:23 AM

LGTM, thanks!

This revision is now accepted and ready to land.Jan 13 2018, 8:23 AM
Closed by commit rC322447: [docs] Use monospace for PCH option flags (authored by modocache). · Explain WhyJan 13 2018, 10:35 AM
This revision was automatically updated to reflect the committed changes.
modocache added a comment.Jan 13 2018, 10:35 AM

Great, thanks for the review, @aaron.ballman!

Revision Contents

PathSize
docs/
6 lines

Diff 129768

docs/UsersManual.rst

Show First 20 Lines • Show All 1,069 Lines • ▼ Show 20 Lines
``build/usr/include`` and place the header ``mylib.h`` into that ``build/usr/include`` and place the header ``mylib.h`` into that
subdirectory. If ``mylib.h`` depends on other headers, then they can be subdirectory. If ``mylib.h`` depends on other headers, then they can be
stored within ``build/usr/include`` in a way that mimics the installed stored within ``build/usr/include`` in a way that mimics the installed
location. location.
Building a relocatable precompiled header requires two additional Building a relocatable precompiled header requires two additional
arguments. First, pass the ``--relocatable-pch`` flag to indicate that arguments. First, pass the ``--relocatable-pch`` flag to indicate that
the resulting PCH file should be relocatable. Second, pass the resulting PCH file should be relocatable. Second, pass
`-isysroot /path/to/build`, which makes all includes for your library ``-isysroot /path/to/build``, which makes all includes for your library
relative to the build directory. For example: relative to the build directory. For example:
.. code-block:: console .. code-block:: console
# clang -x c-header --relocatable-pch -isysroot /path/to/build /path/to/build/mylib.h mylib.h.pch # clang -x c-header --relocatable-pch -isysroot /path/to/build /path/to/build/mylib.h mylib.h.pch
When loading the relocatable PCH file, the various headers used in the When loading the relocatable PCH file, the various headers used in the
PCH file are found from the system header root. For example, ``mylib.h`` PCH file are found from the system header root. For example, ``mylib.h``
can be found in ``/usr/include/mylib.h``. If the headers are installed can be found in ``/usr/include/mylib.h``. If the headers are installed
in some other system root, the `-isysroot` option can be used provide in some other system root, the ``-isysroot`` option can be used provide
a different system root from which the headers will be based. For a different system root from which the headers will be based. For
example, `-isysroot /Developer/SDKs/MacOSX10.4u.sdk` will look for example, ``-isysroot /Developer/SDKs/MacOSX10.4u.sdk`` will look for
``mylib.h`` in ``/Developer/SDKs/MacOSX10.4u.sdk/usr/include/mylib.h``. ``mylib.h`` in ``/Developer/SDKs/MacOSX10.4u.sdk/usr/include/mylib.h``.
Relocatable precompiled headers are intended to be used in a limited Relocatable precompiled headers are intended to be used in a limited
number of cases where the compilation environment is tightly controlled number of cases where the compilation environment is tightly controlled
and the precompiled header cannot be generated after headers have been and the precompiled header cannot be generated after headers have been
installed. installed.
.. _controlling-code-generation: .. _controlling-code-generation:
▲ Show 20 Lines • Show All 1,832 Lines • Show Last 20 Lines