rdelaage
/
postgresql
mirror of https://git.postgresql.org/git/postgresql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update src/tools/pginclude/README to match recent changes to cpluspluscheck 

Commit 7b8e2ae2f has turned cpluspluscheck from separate script into a
--cplusplus option for headerscheck.  Update README correspondingly.

Author: Anton Voloshin <a.voloshin@postgrespro.ru>
Discussion: https://www.postgresql.org/message-id/02e69fa9-885d-4f41-9057-15a1d212eaf8@postgrespro.ru
This commit is contained in:
Peter Eisentraut 2024-04-18 11:32:22 +02:00
parent 2c7cea5a8e
commit e0d51e3bf4
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/tools/pginclude/README
View File

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