Add negative refspec examples to 10.5 Git Internals - The Refspec

Open Beginner friendly
#1,816 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
git
Domain
documentation

Research direction

Start with the Git Book's “10.5 Git Internals - The Refspec” section linked in the issue, then compare the linked pull-fetch documentation and Stack Overflow example. Add a subheading and/or negative refspec examples that explain the feature in that section. Done means the chapter clearly covers negative refspec markers and the documentation builds successfully.

Written by the indexing model from the issue text.

Description

enhancement
General overview of your idea.

Since Git v2.29.0, it has been possible to add negative refspec markers to the fetch config. These are modestly popular, but the documentation is buried in a multi-paragraph explanation on a fairly obscure doc page. Please consider adding a subheading and/or some examples to the relevant section of the Git Book.

What problem will this solve?

Negative refspecs are a fairly helpful tool for people whose upstream branches are not optimally named[^1]. It's a shame that the feature is not more widely covered.

[^1]: This isn't the user's fault. It's the project's fault.

Have you thought about other solutions?

Please feel totally free[^2] to lift, adapt, etc. the text from my Stack Overflow example if that's helpful.

[^2]: For the purposes of this project, any copyright I hold on that answer is waived.

Do you want to help with this enhancement idea?

Maybe Edit: Sure. See #2025

Dominant language
CSS
Stars
6.6k
Forks
2.1k
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from progit/progit2

All issues in progit/progit2

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.