|
1 | 1 | src/tools/pginclude/README
|
2 | 2 |
|
3 |
| -NOTE: headerscheck and cpluspluscheck are in current use, and any |
4 |
| -problems they find should generally get fixed. The other scripts |
5 |
| -in this directory have not been used in some time, and have issues. |
6 |
| -pgrminclude in particular has a history of creating more problems |
7 |
| -than it fixes. Be very wary of applying their results blindly. |
| 3 | +NOTE: headerscheck and headerscheck --cplusplus are in current use, |
| 4 | +and any problems they find should generally get fixed. The other |
| 5 | +scripts in this directory have not been used in some time, and have |
| 6 | +issues. pgrminclude in particular has a history of creating more |
| 7 | +problems than it fixes. Be very wary of applying their results |
| 8 | +blindly. |
8 | 9 |
|
9 | 10 |
|
10 | 11 | pginclude
|
@@ -84,16 +85,17 @@ prerequisite, even if postgres_fe.h or c.h would be more appropriate.
|
84 | 85 | Also note that the contents of macros are not checked; this is intentional.
|
85 | 86 |
|
86 | 87 |
|
87 |
| -cpluspluscheck |
88 |
| -============== |
| 88 | +headerscheck --cplusplus |
| 89 | +======================== |
89 | 90 |
|
90 |
| -This script can be run to verify that all Postgres include files meet |
91 |
| -the project convention that they will compile as C++ code. Although |
92 |
| -the project's coding language is C, some people write extensions in C++, |
93 |
| -so it's helpful for include files to be C++-clean. |
| 91 | +The headerscheck in --cplusplus mode can be run to verify that all |
| 92 | +Postgres include files meet the project convention that they will |
| 93 | +compile as C++ code. Although the project's coding language is C, |
| 94 | +some people write extensions in C++, so it's helpful for include files |
| 95 | +to be C++-clean. |
94 | 96 |
|
95 | 97 | A small number of header files are exempted from this requirement,
|
96 |
| -and are skipped by the cpluspluscheck script. |
| 98 | +and are skipped by the script in the --cplusplus mode. |
97 | 99 |
|
98 | 100 | The easy way to run the script is to say "make -s cpluspluscheck" in
|
99 | 101 | the top-level build directory after completing a build. You should
|
|
0 commit comments