8000 Doc: update src/tools/pginclude/README. · postgrespro/postgres@be3f62a · GitHub
[go: up one dir, main page]
Skip to content

Commit be3f62a

Browse files
tglsfdctglsfdc
committed
Doc: update src/tools/pginclude/README.
Commit f62975b made headerscheck and cpluspluscheck a little smarter than this documentation gave them credit for. Make their docs match current reality. Also add a warning about the layer of dust that has settled on the rest of these scripts. Discussion: https://postgr.es/m/769950.1684797558@sss.pgh.pa.us
1 parent 5df5bea commit be3f62a

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

‎src/tools/pginclude/README

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
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.
8+
9+
310
pginclude
411
=========
512

@@ -71,10 +78,10 @@ the top-level build directory after completing a build. You should
7178
have included "--with-perl --with-python" in your configure options,
7279
else you're likely to get errors about related headers not being found.
7380

74-
A limitation of the current script is that it doesn't know which headers
75-
are for frontend or backend, so it tests everything with postgres.h
76-
as prerequisite, even if postgres_fe.h would be more appropriate. Also
77-
note that the contents of macros are not checked; this is intentional.
81+
A limitation of the current script is that it doesn't know exactly which
82+
headers are for frontend or backend; when in doubt it uses postgres.h as
83+
prerequisite, even if postgres_fe.h or c.h would be more appropriate.
84+
Also note that the contents of macros are not checked; this is intentional.
7885

7986

8087
cpluspluscheck
@@ -97,7 +104,7 @@ If you are using a non-g++-compatible C++ compiler, you may need to
97104
override the script's CXXFLAGS setting by setting a suitable environment
98105
value.
99106

100-
A limitation of the current script is that it doesn't know which headers
101-
are for frontend or backend, so it tests everything with postgres.h
102-
as prerequisite, even if postgres_fe.h would be more appropriate. Also
103-
note that the contents of macros are not checked; this is intentional.
107+
A limitation of the current script is that it doesn't know exactly which
108+
headers are for frontend or backend; when in doubt it uses postgres.h as
109+
prerequisite, even if postgres_fe.h or c.h would be more appropriate.
110+
Also note that the contents of macros are not checked; this is intentional.

0 commit comments

Comments
 (0)
0