summaryrefslogtreecommitdiffstats
path: root/clang/docs
diff options
context:
space:
mode:
authorDouglas Gregor <dgregor@apple.com>2009-06-03 22:37:00 +0000
committerDouglas Gregor <dgregor@apple.com>2009-06-03 22:37:00 +0000
commitb48c6eb794839b696dc97ff18e5a6bf3a490cf2a (patch)
treec165a57e86e7bb298f8d5da3c96c6a410c181187 /clang/docs
parentfa0c645baec7d344a8c5e819ae4118835ebde56f (diff)
downloadbcm5719-llvm-b48c6eb794839b696dc97ff18e5a6bf3a490cf2a.tar.gz
bcm5719-llvm-b48c6eb794839b696dc97ff18e5a6bf3a490cf2a.zip
PTH -> PCH in the user manual
llvm-svn: 72815
Diffstat (limited to 'clang/docs')
-rw-r--r--clang/docs/UsersManual.html27
1 files changed, 10 insertions, 17 deletions
diff --git a/clang/docs/UsersManual.html b/clang/docs/UsersManual.html
index 3f48c4abe6f..def16c1d307 100644
--- a/clang/docs/UsersManual.html
+++ b/clang/docs/UsersManual.html
@@ -431,50 +431,43 @@ headers vary between compilers, precompiled headers have been shown to be a
highly effective at speeding up program compilation on systems with very large
system headers (e.g., Mac OS/X).</p>
-<p>Clang supports an implementation of precompiled headers known as
-<em>pre-tokenized headers</em> (PTH). Clang's pre-tokenized headers support most
-of same interfaces as GCC's pre-compiled headers (as well as others) but are
-completely different in their implementation. If you are interested in how
-PTH is implemented, please see the <a href="PTHInternals.html">PTH Internals
- document</a>.</p>
+<h4>Generating a PCH File</h4>
-<h4>Generating a PTH File</h4>
-
-<p>To generate a PTH file using Clang, one invokes Clang with
+<p>To generate a PCH file using Clang, one invokes Clang with
the <b><tt>-x <i>&lt;language&gt;</i>-header</tt></b> option. This mirrors the
interface in GCC for generating PCH files:</p>
<pre>
$ gcc -x c-header test.h -o test.h.gch
- $ clang -x c-header test.h -o test.h.pth
+ $ clang -x c-header test.h -o test.h.pch
</pre>
-<h4>Using a PTH File</h4>
+<h4>Using a PCH File</h4>
-<p>A PTH file can then be used as a prefix header when a
+<p>A PCH file can then be used as a prefix header when a
<b><tt>-include</tt></b> option is passed to <tt>clang</tt>:</p>
<pre>
$ clang -include test.h test.c -o test
</pre>
-<p>The <tt>clang</tt> driver will first check if a PTH file for <tt>test.h</tt>
+<p>The <tt>clang</tt> driver will first check if a PCH file for <tt>test.h</tt>
is available; if so, the contents of <tt>test.h</tt> (and the files it includes)
-will be processed from the PTH file. Otherwise, Clang falls back to
+will be processed from the PCH file. Otherwise, Clang falls back to
directly processing the content of <tt>test.h</tt>. This mirrors the behavior of
GCC.</p>
-<p><b>NOTE:</b> Clang does <em>not</em> automatically use PTH files
+<p><b>NOTE:</b> Clang does <em>not</em> automatically use PCH files
for headers that are directly included within a source file. For example:</p>
<pre>
- $ clang -x c-header test.h -o test.h.pth
+ $ clang -x c-header test.h -o test.h.cth
$ cat test.c
#include "test.h"
$ clang test.c -o test
</pre>
-<p>In this example, <tt>clang</tt> will not automatically use the PTH file for
+<p>In this example, <tt>clang</tt> will not automatically use the PCH file for
<tt>test.h</tt> since <tt>test.h</tt> was included directly in the source file
and not specified on the command line using <tt>-include</tt>.</p>
OpenPOWER on IntegriCloud