Skip to content

Fix stale and inaccurate user docs - #129

Merged
jnasbyupgrade merged 1 commit into
Postgres-Extensions:masterfrom
jnasbyupgrade:release-2.4.0-doc-fixes
Oct 7, 2026
Merged

jnasbyupgrade merged 1 commit into
Postgres-Extensions:masterfrom
jnasbyupgrade:release-2.4.0-doc-fixes

Conversation

@jnasbyupgrade

@jnasbyupgrade jnasbyupgrade commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Documentation fixes; no behavior changes. (Found while preparing the next release.)

README.asc

  • PGXNTOOL_PGTLE_VERSION takes an exact range name (1.0.0-1.4.0, 1.4.0-1.5.0, 1.5.0+), not a plain pg_tle version that gets mapped to a range. The value is passed straight through to pgtle.sh --pgtle-version, so the old example (PGXNTOOL_PGTLE_VERSION=1.5.0) produced a bogus pg_tle/1.5.0/ directory. Fixed the example and both descriptions.
  • make test: documents that install is skipped with PGXNTOOL_ENABLE_FS_INSTALL=no, and that the stale-expected-file check and the test/install ON_ERROR_STOP check both run as part of it.
  • Test files run in byte-value (ASCII) order, not "alphabetical" ($(sort)).
  • Removed history narration from the make test exit-status note.
  • PGXNTOOL_ENABLE_FS_INSTALL=no also drops test-build's install prerequisite.
  • make tag pushes to $(PGXN_REMOTE), not always origin.
  • The test/install layout no longer lists a test/install/.gitignore; pgxntool never creates one (those ignores live in the top-level .gitignore from setup.sh).
  • testdeps' pgtap prerequisite is a no-op with PGXNTOOL_ENABLE_PGXN_INSTALL=no; installcheck reaches all only through install.
  • Documented the built-in pgxntool-sync-master / -local / -local-master sources, the characters PGXNTOOL_POST_TAG_VERSION allows ([A-Za-z0-9.-]+), and bin/version's optional <history-file> argument.
  • Fixed the case of the <<_Document_Handling>> cross-reference, which didn't resolve.

CLAUDE.md

  • Canonical Postgres-Extensions/pgxntool subtree URL; .asc listed as an accepted doc extension.
  • The make test chain now shows test-build, the FS_INSTALL/PGXN_INSTALL gating, and the safeguard checks.

pgtle.sh

Comment and message text only: canonical repo URL (header and the delimiter-error message), and SEE ALSO now points at README.asc's "pg_tle Support" section instead of a nonexistent README-pgtle.md. No logic changes. Because pgtle.sh isn't a doc file, check-test-pr may require a paired pgxntool-test PR or the maintainer-applied commit-with-no-tests label.

README.html

Regenerated from README.asc with asciidoctor. This also picks up README.asc changes already on master that the committed HTML lacked.

Full pgxntool-test suite run locally against this branch: 306/306 pass.

🤖 Generated with Claude Code

README.asc:
- PGXNTOOL_PGTLE_VERSION takes an exact range name (e.g. 1.5.0+), not
  a plain version mapped to a range; a plain version creates a bogus
  pg_tle/<value>/ directory. Fix the example and both descriptions.
- make test: document the FS_INSTALL gating of install and the two
  safeguard checks (stale expected files, test/install ON_ERROR_STOP);
  test files run in byte-value order, not alphabetical; drop history
  narration from the exit-status note.
- PGXNTOOL_ENABLE_FS_INSTALL=no also drops test-build's install
  prerequisite.
- tag pushes to $(PGXN_REMOTE), not always origin.
- test/install layout: there is no test/install/.gitignore.
- testdeps/pgtap is a no-op with PGXNTOOL_ENABLE_PGXN_INSTALL=no;
  installcheck reaches all only through install.
- Document the built-in pgxntool-sync-master/-local/-local-master
  sources, PGXNTOOL_POST_TAG_VERSION's allowed characters, and
  bin/version's optional history-file argument.
- Fix the <<_Document_Handling>> cross-reference's case.

CLAUDE.md: canonical repo URL, .asc doc extension, and the full make
test chain with its gating and safeguard checks.

pgtle.sh: comment/message-only changes (canonical repo URL, SEE ALSO
pointing at README.asc's pg_tle Support section).

README.html regenerated with asciidoctor.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 7, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 762a5593-c53f-4263-8be0-94bcbd77f014

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@jnasbyupgrade jnasbyupgrade changed the title Fix stale and inaccurate user docs found in 2.4.0 release review Fix stale and inaccurate user docs Oct 7, 2026
@jnasbyupgrade jnasbyupgrade added the commit-with-no-tests No paired test PR needed; maintainer-verified. Tests run against pgxntool-test/master. label Oct 7, 2026
@jnasbyupgrade
jnasbyupgrade merged commit c25cdf4 into Postgres-Extensions:master Oct 7, 2026
10 of 11 checks passed
@jnasbyupgrade
jnasbyupgrade deleted the release-2.4.0-doc-fixes branch October 7, 2026 21:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

commit-with-no-tests No paired test PR needed; maintainer-verified. Tests run against pgxntool-test/master.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant