Repository navigation
Report usage more consistently as "git foo" - #1277
Merged
Merged
Conversation
hyperupcall
self-requested a review
September 30, 2026 21:17
hyperupcall
approved these changes
Sep 30, 2026
hyperupcall
left a comment
hyperupcall
left a comment
Collaborator
There was a problem hiding this comment.
I appreciate the AI disclosure - I do prefer this approach as well (mentioned in #1154). Changes LGTM.
git-force-clone, git-guilt, and git-magic spelled the command as "git-foo" in their usage strings. git-changelog and git-clear set PROGNAME to "git-changelog" and "git-clear" and interpolate it into their usage text; PROGNAME is used nowhere else in either script. Man page synopses for these commands remain inconsistent and are unchanged here. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Follow the convention in git-clone(1): the dashed form "git-clone"
appears only on the NAME line, while the SYNOPSIS, the prose, and the
examples all spell the invocation "git clone". References to other
manual pages stay dashed and keep their section, as in "git-config(1)".
Applied here as:
- NAME lines unchanged.
- SYNOPSIS blocks now spell the command "git foo". git-force-clone
had omitted "git" altogether.
- Prose and example invocations now spell the command "git foo".
- Existing "git-foo(1)" cross-references unchanged.
Left dashed because they are not invocations: file paths such as
bin/git-browse and man/git-magic.md, URLs, the git-extras.default-branch
config key, branch names in git-brv and git-guilt examples, and command
names quoted inside sample command output.
The generated man/*.1 and man/*.html carry the same edits, applied in
place rather than by regenerating. Regenerating would have rewritten
every page, because 40 of the 78 were built by Ronn v0.7.3, which cannot
be installed on current Ruby: it needs hpricot 0.8.6, whose fast_xs.c
does not compile against the Ruby 3.4 C API, and Ronn-NG v0.7.4 fails
the same way via rdiscount 1.6.8. Building those with a newer generator
replaced their whole body, since it drops v0.7.3's stray "." lines and
renders bullet lists as .IP rather than .br. Editing in place leaves
each page's generator, date, and formatting untouched.
Eight pages already used the "git foo" form and are untouched.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
sparr
force-pushed
the
consistent-usage-naming
branch
from
October 2, 2026 13:32
73b06e6 to
6dd6bb3
Compare
Collaborator
|
Hey please don't force-push in the future, that makes it more difficult to review, we prefer merging as stated in the pull request template. |
Collaborator
|
@sparr |
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
3 participants
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.
Report usage as
git fooin more places, instead of the current mix ofgit foo,git-foo, and/whatever/git-foo.This is the easy half of #1154, all the sites that can be reached with a straightforward text substitution. The remaining work involves some script parameter parsing or more complex invocations of setup/usage functions.
This PR updates 5 scripts and 65 man pages.
The man pages were updated directly, rather than re-generated, because many were generated with very old ronn versions and re-generating them now causes thousands of lines of churn.
AI Disclosure This PR was implemented mostly by Claude Opus 5 and 5.5. I have reviewed the changes and understand what they are doing and why.