Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 2256d29

Browse files
committed
Mention dependency problems caused by pgrminclude on include files.
1 parent d77f73e commit 2256d29

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

src/tools/pginclude/README

+15-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ pgrminclude [-v]
1313
pgcheckdefines
1414
check for #ifdef tests on symbols defined in files that
1515
weren't included --- this is a necessary sanity check on
16-
pgrminclude!
16+
pgrminclude
1717

1818
pgdefine create macro calls for all defines in the file (used by
1919
the above routines)
@@ -22,9 +22,19 @@ It is also a good idea to sort the pg-specific include files in
2222
alphabetic order. This is best done with a text editor. Typical usage
2323
order would be:
2424

25-
pgfixinclude
26-
pgcompinclude
27-
pgrminclude /src/include
28-
pgcompinclude
25+
pgfixinclude
26+
sort include references
27+
run multiple times:
28+
pgcompinclude
29+
pgrminclude /src/include
2930
pgrminclude /
3031
pgcheckdefines
32+
33+
There is a complexity when modifying /src/include. If include file 1
34+
includes file 2, and file 2 includes file 3, then when file 1 is
35+
processed, it needs only file 2, not file 3. However, if later, include
36+
file 2 is processed, and file 3 is not needed by file 2 and is removed,
37+
file 1 might then need to include file 3. For this reason, the
38+
pgcompinclude and pgrminclude /src/include steps must be run several
39+
times until all includes compile cleanly.
40+

0 commit comments

Comments
 (0)