Rename internal-only variables to the _PGXNTOOL_ shape - #93
Draft
jnasbyupgrade wants to merge 1 commit into
Draft
Conversation
Several Make variables that are pure internal plumbing -- never designed as user override points -- were named with a bare `PGXNTOOL_` prefix, which reads like a supported override point by name alone (this is what issue Postgres-Extensions#87 flagged for `PGXNTOOL_INSTALL_SCHEDULE` specifically). Renamed all five to the `_PGXNTOOL_` shape (leading underscore, still namespaced), matching the existing `_CHECK_STALE_EXPECTED_SCRIPT` precedent: - `PGXNTOOL_BASE_MK_INCLUDED` -> `_PGXNTOOL_BASE_MK_INCLUDED` (include guard) - `PGXNTOOL_CONTROL_FILES` -> `_PGXNTOOL_CONTROL_FILES` - `PGXNTOOL_EXTENSIONS` -> `_PGXNTOOL_EXTENSIONS` - `PGXNTOOL_INSTALL_SCHEDULE` -> `_PGXNTOOL_INSTALL_SCHEDULE` - `_CHECK_STALE_EXPECTED_SCRIPT` -> `_PGXNTOOL_CHECK_STALE_EXPECTED_SCRIPT` (renamed too, for consistency with the new shape) `PGXNTOOL_DIR` is deliberately excluded: present since pgxntool's very first release and referenced across `base.mk` plus four separate shell scripts, making it the highest-risk name in the framework to touch. None of the five renamed variables are documented anywhere as override points, but if a project happened to reference one directly (unsupported, but possible), it will need updating. Fixes Postgres-Extensions#87. Related changes in pgxntool-test: - `test/standard/make-test.bats` and `test/lib/helpers.bash`: updated `_CHECK_STALE_EXPECTED_SCRIPT` references to the new name - `test/sequential/04-pgtle.bats`: updated `make print-PGXNTOOL_CONTROL_FILES` to the new name - `CLAUDE.md`: updated the internal-variable-naming-convention section Co-Authored-By: Claude <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PGXNTOOL_prefix (which reads like a supported override point) to_PGXNTOOL_...:PGXNTOOL_BASE_MK_INCLUDED,PGXNTOOL_CONTROL_FILES,PGXNTOOL_EXTENSIONS,PGXNTOOL_INSTALL_SCHEDULE, and_CHECK_STALE_EXPECTED_SCRIPT(renamed too, for_PGXNTOOL_consistency).PGXNTOOL_DIRdeliberately left as-is: present since Release 0.1 (2016), referenced acrossbase.mkplus 4 shell scripts — highest-risk name in the framework to touch, out of scope here.Issues fixed in this release: #87).Fixes #87.
Paired with Postgres-Extensions/pgxntool-test#72 for the corresponding test/doc updates.
Test plan