diff options
| author | Brian Gesiak <modocache@gmail.com> | 2018-01-13 18:34:07 +0000 |
|---|---|---|
| committer | Brian Gesiak <modocache@gmail.com> | 2018-01-13 18:34:07 +0000 |
| commit | 4995614f7c2da89a36487d832617d8ff0e958a6f (patch) | |
| tree | da5556d4be23832dd459c7eae555f96cd5d012ee /clang/docs/UsersManual.rst | |
| parent | 652f9a1896a551b6a115b90f33fda4b95dee3c7b (diff) | |
| download | bcm5719-llvm-4995614f7c2da89a36487d832617d8ff0e958a6f.tar.gz bcm5719-llvm-4995614f7c2da89a36487d832617d8ff0e958a6f.zip | |
[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.
Reviewers: sepavloff, aaron.ballman
Reviewed By: aaron.ballman
Subscribers: cfe-commits
Differential Revision: https://reviews.llvm.org/D42005
llvm-svn: 322447
Diffstat (limited to 'clang/docs/UsersManual.rst')
| -rw-r--r-- | clang/docs/UsersManual.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst index 11f77e58798..48ea714304b 100644 --- a/clang/docs/UsersManual.rst +++ b/clang/docs/UsersManual.rst @@ -1075,7 +1075,7 @@ location. Building a relocatable precompiled header requires two additional arguments. First, pass the ``--relocatable-pch`` flag to indicate that 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: .. code-block:: console @@ -1085,9 +1085,9 @@ relative to the build directory. For example: 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`` 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 -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``. Relocatable precompiled headers are intended to be used in a limited |
