@@ -38,44 +38,43 @@ If no config file could be found, you'll be prompted to create a project. The ac
3838
3939=== Project Configuration
4040
41- The `.c-xrefrc` file defines which files belong to the project. A minimal config
42- looks like:
41+ The `.c-xrefrc` file marks the root of a source tree. The directory containing
42+ `.c-xrefrc` and its subdirectories are always scanned for compilation units. A
43+ minimal config only needs a section header naming the project:
4344
4445[source]
4546----
46- [/path/to/project]
47- /path/to/project
47+ [my-project]
4848----
4949
50- The section header `[...]` names the project (typically the project root path) .
50+ The section header `[...]` names the project.
5151Lines below it configure the project:
5252
53- Source directories:: Bare path lines list directories to scan for compilation units.
54- The project root is always scanned. Additional directories can be listed for
55- multi-directory or multi-repo projects:
53+ Source directories:: The project root (where `.c-xrefrc` lives) and its
54+ subdirectories are always scanned automatically. Additional source directories
55+ only need to be listed for multi-directory projects, e.g. when source files
56+ live outside the project root:
5657+
5758[source]
5859----
59- [/path/to/project]
60- /path/to/project
61- /path/to/shared/library
60+ [my-project]
61+ ../shared/library
6262----
6363
6464Include paths:: `-I` options tell c-xrefactory where to find header files, just
6565 like the compiler flag:
6666+
6767[source]
6868----
69- [/path/to/project]
70- /path/to/project
71- -I /path/to/external/headers
69+ [my-project]
70+ -I ../external/headers
7271----
7372
7473Preprocessor defines:: `-D` options define macros, equivalent to the compiler flag.
7574 Useful when the project uses conditional compilation.
7675
77- TIP: For projects that use auto-detection (project-local `.c-xrefrc`), absolute paths
78- are not required — the configuration is resolved relative to the file's location .
76+ TIP: Paths in `.c-xrefrc` are resolved relative to the config file's directory,
77+ so the configuration is portable and can be checked into version control .
7978
8079== Browsing
8180
0 commit comments