diff options
| author | Bruce Momjian | 2006-07-17 19:37:21 +0000 |
|---|---|---|
| committer | Bruce Momjian | 2006-07-17 19:37:21 +0000 |
| commit | 619807bf21ded90a8a118d69872be06e34994d6d (patch) | |
| tree | 8ab3808e2346458efeb0efa5f4bcd926d046782e | |
| parent | f35c20fdcc721a6240cf528fbc82268b4e0d4bc3 (diff) | |
Mention dependency problems caused by pgrminclude on include files.
| -rw-r--r-- | src/tools/pginclude/README | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/src/tools/pginclude/README b/src/tools/pginclude/README index ac6cd7edfe..35f8220526 100644 --- a/src/tools/pginclude/README +++ b/src/tools/pginclude/README @@ -13,7 +13,7 @@ pgrminclude [-v] pgcheckdefines check for #ifdef tests on symbols defined in files that weren't included --- this is a necessary sanity check on - pgrminclude! + pgrminclude pgdefine create macro calls for all defines in the file (used by 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 order would be: - pgfixinclude - pgcompinclude - pgrminclude /src/include - pgcompinclude + pgfixinclude + sort include references + run multiple times: + pgcompinclude + pgrminclude /src/include pgrminclude / 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. + |