mirrors
/
postgres
mirror of https://github.com/postgres/postgres
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Mention dependency problems caused by pgrminclude on include files.

This commit is contained in:
Bruce Momjian 2006-07-17 19:37:21 +00:00
parent d77f73eb2a
commit 2256d299bb
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/tools/pginclude/README
View File

@ -13,7 +13,7 @@ pgrminclude [-v]
pgcheckdefines pgcheckdefines
check for #ifdef tests on symbols defined in files that check for #ifdef tests on symbols defined in files that
weren't included --- this is a necessary sanity check on weren't included --- this is a necessary sanity check on
pgrminclude! pgrminclude
pgdefine create macro calls for all defines in the file (used by pgdefine create macro calls for all defines in the file (used by
the above routines) the above routines)
@ -22,9 +22,19 @@ It is also a good idea to sort the pg-specific include files in
alphabetic order. This is best done with a text editor. Typical usage alphabetic order. This is best done with a text editor. Typical usage
order would be: order would be:
pgfixinclude pgfixinclude
pgcompinclude sort include references
pgrminclude /src/include run multiple times:
pgcompinclude pgcompinclude
pgrminclude /src/include
pgrminclude / pgrminclude /
pgcheckdefines pgcheckdefines
There is a complexity when modifying /src/include. If include file 1
includes file 2, and file 2 includes file 3, then when file 1 is
processed, it needs only file 2, not file 3. However, if later, include
file 2 is processed, and file 3 is not needed by file 2 and is removed,
file 1 might then need to include file 3. For this reason, the
pgcompinclude and pgrminclude /src/include steps must be run several
times until all includes compile cleanly.