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

Commit e0d51e3

Browse files
committed
Update src/tools/pginclude/README to match recent changes to cpluspluscheck
Commit 7b8e2ae 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
1 parent 2c7cea5 commit e0d51e3

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

src/tools/pginclude/README

+14-12
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
src/tools/pginclude/README
22

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.
89

910

1011
pginclude
@@ -84,16 +85,17 @@ prerequisite, even if postgres_fe.h or c.h would be more appropriate.
8485
Also note that the contents of macros are not checked; this is intentional.
8586

8687

87-
cpluspluscheck
88-
==============
88+
headerscheck --cplusplus
89+
========================
8990

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.
9496

9597
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.
9799

98100
The easy way to run the script is to say "make -s cpluspluscheck" in
99101
the top-level build directory after completing a build. You should

0 commit comments

Comments
 (0)