Skip to content

README: give every feature an honest status marker - #74

Merged
seanwevans merged 2 commits into
mainfrom
claude/pg-git-upgrade-deps-rk0oxk-readme-status
Sep 3, 2026
Merged

seanwevans merged 2 commits into
mainfrom
claude/pg-git-upgrade-deps-rk0oxk-readme-status

Conversation

@seanwevans

Copy link
Copy Markdown
Owner

The problem

Core Operations carried ✅/🧭 markers while Advanced Operations were listed flat with no status at all.

Investigating to add the markers turned up more than asymmetry:

  • A duplicated block under "Administrative" marked most of the advanced features 🧭 — understating them. Submodules, sparse checkout, rerere, repack, object replacement, bisect, blame, stash and grep all ship as callable functions in sql/pgit-*.sql.
  • The section listed the same features twice and had two ### Administrative headings.
  • Features that ship were missing entirely (bundles, merge_trees, commit notes), and the plumbing set cat_file / hash_object / ls_tree / rev_list was listed as planned when all four are shipped.

The fix

One marked list, with function names spelled out the way Core Operations already did.

Two markers were not enough. Several features are exported and callable but have a placeholder at their centre, and calling those ✅ would oversell them exactly as badly as 🧭 undersells the rest. So there is now a ⚠️ tier, with a note naming the missing part:

Feature What's actually missing
create_archive concatenates blob contents behind placeholder tar/zip headers — not a valid archive for tar/unzip
verify_commit / verify_tag enforces key trust levels but does no cryptographic verification: any stored signature is reported valid
start_instaweb records config and returns a URL; starts no web server
merge_branches raises Only fast-forward merges are currently supported on divergent history
push resolves the ref and raises a notice; transfers nothing

The last two are in Core Operations, which previously listed them under an "(Implemented)" heading with no qualification.

Reflog and fsck are marked 🧭 — nothing in sql/ implements them.

Verification

Every function name in the new list was checked to exist in sql/pg_git--0.4.0.sql; the ⚠️ notes are each traceable to a specific placeholder in the source (-- In a real implementation, this would..., -- For now, we'll assume any stored signature is valid, -- tar file header (simplified)).

Docs only — no code changes.

🤖 Generated with Claude Code

https://claude.ai/code/session_017nq3xZcPqSTKtskyP2DzkK


Generated by Claude Code

claude and others added 2 commits September 3, 2026 17:39
Core Operations carried ✅/🧭 markers while Advanced Operations were
listed flat with no status at all, and a duplicated block under
"Administrative" marked most of those same advanced features 🧭 —
understating them, since submodules, sparse checkout, rerere, repack,
object replacement, bisect, blame, stash, grep and the rest all ship as
callable functions in sql/pgit-*.sql. The section also listed the same
features twice and had two "Administrative" headings.

Rewrite the whole Features section as one marked list, with the function
names spelled out the way Core Operations already did.

Two markers were not enough. Several features are exported and callable
but have a placeholder at their centre, and calling those ✅ would
oversell them exactly as badly as calling them 🧭 undersells the rest, so
add ⚠️ with a note naming the missing part:

  - create_archive concatenates blob contents behind placeholder tar/zip
    headers, so the output is not a valid archive;
  - verify_commit / verify_tag check trust levels but do no cryptographic
    verification — any stored signature is reported valid;
  - start_instaweb records config and returns a URL without starting a
    server;
  - merge_branches raises on divergent history (fast-forward only);
  - push resolves the ref and raises a notice without transferring
    anything.

The last two are in Core Operations, which previously listed them under
an "(Implemented)" heading with no qualification.

Also add features that shipped but were never documented (bundles,
merge_trees, commit notes, the cat_file/hash_object/ls_tree/rev_list
plumbing set, which the old text listed as planned), and mark reflog and
fsck 🧭 since nothing in sql/ implements them.

Every function name in the new list was checked against
sql/pg_git--0.4.0.sql.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017nq3xZcPqSTKtskyP2DzkK
@seanwevans
seanwevans merged commit e44fd1a into main Sep 3, 2026
2 checks passed
@seanwevans
seanwevans deleted the claude/pg-git-upgrade-deps-rk0oxk-readme-status branch September 3, 2026 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants