Author: modocache Date: Sat Jan 13 10:34:07 2018 New Revision: 322447 URL: http://llvm.org/viewvc/llvm-project?rev=322447&view=rev Log: [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 Modified: cfe/trunk/docs/UsersManual.rst Modified: cfe/trunk/docs/UsersManual.rst URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/UsersManual.rst?rev=322447&r1=322446&r2=322447&view=diff ============================================================================== --- cfe/trunk/docs/UsersManual.rst (original) +++ cfe/trunk/docs/UsersManual.rst Sat Jan 13 10:34:07 2018 @@ -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 exa 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 _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
