Add comments about internal headers #15689
Conversation
A common convention is to name internal C header files as `*_int.h`. Since a couple of these are actually installed, we add comments that this is not supposed to happen, (a) to avoid installing further internal headers, and (b) to pave the way to fix this in the next major PHP version. Somewhat special is php_gmp_int.h, where "int" is meant as abbreviation for "interface". Another common convention is appending `_priv` or `_private`, but since there have not been any issues regarding these headers so far, we refrain from adding respective comments to these headers. Anyhow, it might be a good idea to introduce some common naming convention for such internal/private headers.
cmb69
requested review from
bukka,
devnexen,
SakiTakamachi,
NattyNarwhal and
Girgias
as code owners
Shouldn't the file be named php_gmp_interface.h to avoid the confusion? |
|
Semi-related note: I've also "read" the |
Either that, or php_gmp.h should be renamed tog php_gmp_int.h and php_gmp_int.h to php_gmp.h. However, the file is installed (aka. public) for 7 years, so that would be a BC break (extensions including the file would need to be changed to be able to be built, and would need `#if's to cater to both names), and I wouldn't want to do that for PHP 8.4 (just a bit late), and probably only for a major PHP version (where more serious changes have to be expected by extension authors anyway). |
A common convention is to name internal C header files as
*_int.h. Since a couple of these are actually installed, we add comments that this is not supposed to happen, (a) to avoid installing further internal headers, and (b) to pave the way to fix this in the next major PHP version.Somewhat special is php_gmp_int.h, where "int" is meant as abbreviation for "interface".
Another common convention is appending
_privor_private, but since there have not been any issues regarding these headers so far, we refrain from adding respective comments to these headers.Anyhow, it might be a good idea to introduce some common naming convention for such internal/private headers.
See also #15688.