Hello, hackers,
On 10/03/2024 12:03, Peter Eisentraut wrote:
Committed, thanks.
This commit (7b8e2ae2f) have turned cpluspluscheck script into a
--cplusplus option for headerscheck. I propose to update the
src/tools/pginclude/README correspondingly, please see the attached patch.
--
Anton Voloshin
Postgres Professional, The Russian Postgres Company
https://postgrespro.ru
From a50e58f117341e8a9df5f97fa05630f7b8f4bd86 Mon Sep 17 00:00:00 2001
From: Anton Voloshin <a.volos...@postgrespro.ru>
Date: Tue, 16 Apr 2024 17:19:28 +0300
Subject: [PATCH] Update src/tools/pginclude/README to match recent changes to
cpluspluscheck
7b8e2ae2f have turned cpluspluscheck from separate script into
a --cplusplus option for headerscheck. Update README correspondingly.
---
src/tools/pginclude/README | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/src/tools/pginclude/README b/src/tools/pginclude/README
index 712eca76fb3..65372057dad 100644
--- a/src/tools/pginclude/README
+++ b/src/tools/pginclude/README
@@ -1,10 +1,10 @@
src/tools/pginclude/README
-NOTE: headerscheck and cpluspluscheck are in current use, and any
-problems they find should generally get fixed. The other scripts
-in this directory have not been used in some time, and have issues.
-pgrminclude in particular has a history of creating more problems
-than it fixes. Be very wary of applying their results blindly.
+NOTE: headerscheck and headerscheck --cplusplus are in current use, and any
+problems they find should generally get fixed. The other scripts in this
+directory have not been used in some time, and have issues. pgrminclude in
+particular has a history of creating more problems than it fixes. Be very
+wary of applying their results blindly.
pginclude
@@ -84,16 +84,16 @@ 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.
-cpluspluscheck
-==============
+headerscheck --cplusplus
+========================
-This script can be run to verify that all Postgres include files meet
-the project convention that they will compile as C++ code. Although
-the project's coding language is C, some people write extensions in C++,
-so it's helpful for include files to be C++-clean.
+The headerscheck in --cplusplus mode can be run to verify that all Postgres
+include files meet the project convention that they will compile as C++
+code. Although the project's coding language is C, 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,
-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 top-level build directory after completing a build. You should
--
2.43.2
