diff options
author | neil <neil@138bc75d-0d04-0410-961f-82ee72b054a4> | 2002-03-11 21:11:36 +0000 |
---|---|---|
committer | neil <neil@138bc75d-0d04-0410-961f-82ee72b054a4> | 2002-03-11 21:11:36 +0000 |
commit | deb88e7d3a914d8932486b31e13b78d538c2dd48 (patch) | |
tree | 0a940070bdd33bb337e019f4c4afcb0d8c78f7b0 /gcc/doc/cppenv.texi | |
parent | 42917ce72702aec14a72a2b0a539edd51e38572f (diff) | |
download | gcc-deb88e7d3a914d8932486b31e13b78d538c2dd48.tar.gz |
* Makefile.in: Update.
doc:
* cppenv.texi, cppopts.texi: Split out of cpp.texi and gcc.texi.
Update documentation.
* gcc.texi: Include cppopts.texi and cppenv.texi.
* cpp.texi: Include cppopts.texi and cppenv.texi.
git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@50599 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'gcc/doc/cppenv.texi')
-rw-r--r-- | gcc/doc/cppenv.texi | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/gcc/doc/cppenv.texi b/gcc/doc/cppenv.texi new file mode 100644 index 00000000000..31407bdfd8b --- /dev/null +++ b/gcc/doc/cppenv.texi @@ -0,0 +1,76 @@ +@c Copyright (c) 1999, 2000, 2001, 2002 +@c Free Software Foundation, Inc. +@c This is part of the CPP and GCC manuals. +@c For copying conditions, see the file gcc.texi. + +@c --------------------------------------------------------------------- +@c Environment variables affecting the preprocessor +@c --------------------------------------------------------------------- + +@c If this file is included with the flag ``cppmanual'' set, it is +@c formatted for inclusion in the CPP manual; otherwise the main GCC manual. + +@ftable @env +@item CPATH +@itemx C_INCLUDE_PATH +@itemx CPLUS_INCLUDE_PATH +@itemx OBJC_INCLUDE_PATH +@c Commented out until ObjC++ is part of GCC: +@c @itemx OBJCPLUS_INCLUDE_PATH +Each variable's value is a list of directories separated by a special +character, much like @env{PATH}, in which to look for header files. +The special character, @code{PATH_SEPARATOR}, is target-dependent and +determined at GCC build time. For Windows-based targets it is a +semicolon, and for almost all other targets it is a colon. + +@env{CPATH} specifies a list of directories to be searched as if +specified with @option{-I}, but after any paths given with @option{-I} +options on the command line. The environment variable is used +regardless of which language is being preprocessed. + +The remaining environment variables apply only when preprocessing the +particular language indicated. Each specifies a list of directories +to be searched as if specified with @option{-isystem}, but after any +paths given with @option{-isystem} options on the command line. + +@ifset cppmanual +See also @ref{Search Path}. +@end ifset + +@item DEPENDENCIES_OUTPUT +@anchor{DEPENDENCIES_OUTPUT} +@cindex dependencies for make as output +If this variable is set, its value specifies how to output +dependencies for Make based on the non-system header files processed +by the compiler. System header files are ignored in the dependency +output. + +The value of @env{DEPENDENCIES_OUTPUT} can be just a file name, in +which case the Make rules are written to that file, guessing the target +name from the source file name. Or the value can have the form +@samp{@var{file} @var{target}}, in which case the rules are written to +file @var{file} using @var{target} as the target name. + +In other words, this environment variable is equivalent to combining +the options @option{-MM} and @option{-MF} +@ifset cppmanual +(@pxref{Invocation}), +@end ifset +@ifclear cppmanual +(@pxref{Preprocessor Options}), +@end ifclear +with an optional @option{-MT} switch too. + +@item SUNPRO_DEPENDENCIES +@cindex dependencies for make as output +This variable is the same as the environment variable +@env{DEPENDENCIES_OUTPUT} (@pxref{DEPENDENCIES_OUTPUT}), except that +system header files are not ignored, so it implies @option{-M} rather +than @option{-MM}. +@ifset cppmanual +@xref{Invocation}. +@end ifset +@ifclear cppmanual +@xref{Preprocessor Options}. +@end ifclear +@end ftable |