Skip to content

[Clang][Docs][NFC] Correct documentation for the CPATH environment variable #129113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 6, 2025
Merged

[Clang][Docs][NFC] Correct documentation for the CPATH environment variable #129113

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b274bb5
[Clang][Docs][NFC] Correct documentation for the CPATH environment va…
tahonermann Feb 27, 2025
3998ad4
Squash: Addressed review comments from Erich Keane.
tahonermann Mar 6, 2025
d78fccd
Squash: Correct documentation regardling the handling of empty entrie…
tahonermann Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions clang/docs/CommandGuide/clang.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -733,16 +733,19 @@ ENVIRONMENT

.. envvar:: CPATH

If this environment variable is present, it is treated as a delimited list of
paths to be added to the default system include path list. The delimiter is
the platform dependent delimiter, as used in the PATH environment variable.

Empty components in the environment variable are ignored.
This environment variable specifies additional (non-system) header search
paths to be used to find included header files. These paths are searched after
paths specified with the :option:`-I\<directory\>` option, but before any
system header search paths. Paths are delimited by the platform dependent
delimiter as used in the ``PATH`` environment variable. Empty entries in the
delimited path list are ignored. The treatment of empty entries differs from
gcc which treats them as specifying the compiler's current working directory.

.. envvar:: C_INCLUDE_PATH, OBJC_INCLUDE_PATH, CPLUS_INCLUDE_PATH, OBJCPLUS_INCLUDE_PATH

These environment variables specify additional paths, as for :envvar:`CPATH`, which are
only used when processing the appropriate language.
These environment variables specify additional system header file search
paths to be used when processing the corresponding language. Search paths are
delimited as for the :envvar:`CPATH` environment variable.

.. envvar:: MACOSX_DEPLOYMENT_TARGET

Expand Down
Loading