Author: Ivan Murashko Date: 2022-05-03T08:26:13+01:00 New Revision: f6112f490cfeed05b42ae33cc994292000aee0da
URL: https://github.com/llvm/llvm-project/commit/f6112f490cfeed05b42ae33cc994292000aee0da DIFF: https://github.com/llvm/llvm-project/commit/f6112f490cfeed05b42ae33cc994292000aee0da.diff LOG: [docs] PCH usage documentation update The documentation has an incorrect example of PCH files usage via `-include` option. The possibility has not been available since [llvm-svn: 174385](https://reviews.llvm.org/rG48b72d81c8968f3d342557582db986a60aef2c54). Differential Revision: https://reviews.llvm.org/D124719 Added: Modified: clang/docs/UsersManual.rst Removed: ################################################################################ diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst index 2dc32448f959b..402029c8a64b3 100644 --- a/clang/docs/UsersManual.rst +++ b/clang/docs/UsersManual.rst @@ -1219,23 +1219,22 @@ for generating PCH files: Using a PCH File ^^^^^^^^^^^^^^^^ -A PCH file can then be used as a prefix header when a :option:`-include` +A PCH file can then be used as a prefix header when a :option:`-include-pch` option is passed to ``clang``: .. code-block:: console - $ clang -include test.h test.c -o test + $ clang -include-pch test.h.pch test.c -o test -The ``clang`` driver will first check if a PCH file for ``test.h`` is +The ``clang`` driver will check if the PCH file ``test.h.pch`` is available; if so, the contents of ``test.h`` (and the files it includes) -will be processed from the PCH file. Otherwise, Clang falls back to -directly processing the content of ``test.h``. This mirrors the behavior -of GCC. +will be processed from the PCH file. Otherwise, Clang will report an error. .. note:: Clang does *not* automatically use PCH files for headers that are directly - included within a source file. For example: + included within a source file or indirectly via :option:`-include`. + For example: .. code-block:: console @@ -1246,7 +1245,7 @@ of GCC. In this example, ``clang`` will not automatically use the PCH file for ``test.h`` since ``test.h`` was included directly in the source file and not - specified on the command line using :option:`-include`. + specified on the command line using :option:`-include-pch`. Relocatable PCH Files ^^^^^^^^^^^^^^^^^^^^^ _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
