Skip to content

Commit 16af476

Browse files
committed
Document environment variables we handle, and don't mention -pipe (it
isn't yet supported... lazy developers). llvm-svn: 71109
1 parent 72b6582 commit 16af476

File tree

1 file changed

+30
-8
lines changed

1 file changed

+30
-8
lines changed

clang/docs/tools/clang.pod

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -179,11 +179,6 @@ Pass I<arg> to the preprocessor.
179179

180180
Write output to I<file>.
181181

182-
=item B<-pipe>
183-
184-
FIXME: WHY DOCUMENT THIS.
185-
Use pipes between commands, when possible.
186-
187182
=item B<-print-file-name>=I<file>
188183

189184
Print the full library path of I<file>.
@@ -263,14 +258,41 @@ Treat subsequent input files as having type I<language>.
263258

264259
=head1 ENVIRONMENT
265260

266-
No environment variables read.
261+
=over
262+
263+
=item B<TMPDIR>, B<TEMP>, B<TMP>
264+
265+
These environment variables are checked, in order, for the location to
266+
write temporary files used during the compilation process.
267+
268+
=item B<CPATH>
269+
270+
If this environment variable is present, it is treated as a delimited
271+
list of paths to be added to the default system include path list. The
272+
delimiter is the platform dependent delimitor, as used in the I<PATH>
273+
environment variable.
274+
275+
Empty components in the environment variable are ignored.
276+
277+
=item B<C_INCLUDE_PATH>, B<OBJC_INCLUDE_PATH>, B<CPLUS_INCLUDE_PATH>,
278+
B<OBJCPLUS_INCLUDE_PATH>
279+
280+
These environment variables specify additional paths, as for CPATH,
281+
which are only used when processing the appropriate language.
282+
283+
=item B<MACOSX_DEPLOYMENT_TARGET> (Apple only)
284+
285+
If -mmacosx-version-min is unspecified, the default deployment target
286+
is read from this environment variable.
287+
288+
=back
267289

268290
=head1 BUGS
269291

270292
Clang currently does not have C++ support, and this manual page is incomplete.
271293
To report bugs, please visit L<http://llvm.org/bugs/>. Most bug reports should
272-
include preprocessed source files (use the B<-E> option) along with information
273-
to reproduce.
294+
include preprocessed source files (use the B<-E> option) and the full output of
295+
the compiler, along with information to reproduce.
274296

275297
=head1 SEE ALSO
276298

0 commit comments

Comments
 (0)