threads / discuss / 49795

Git Reference Manual enhance

Subject: Git Reference Manual enhance

## tl;dr

3 messages between Nov 11, 2018 and Nov 12, 2018.

replies: 2people: 3as markdown or json

Fredi Fowler· Nov 11, 2018, 00:20 UTC · lore

Is there any way to create pull request to git man (https://git-scm.com/docs)?

I found there some inconsistencies. For example, almost in all pages are using [no-], but at https://git-scm.com/docs/git-merge each command (with [no-] or without) write separately.

There are some same inconsistencies that a easy to fix. So, if I can sent a pull-request for such fix – inform me.

Eric Sunshine· Nov 11, 2018, 01:25 UTC · re: Fredi Fowler · lore

Re: Git Reference Manual enhance

On Sat, Nov 10, 2018 at 7:21 PM Fredi Fowler <inredikawb@gmail.com> wrote:

> Is there any way to create pull request to git man (https://git-scm.com/docs)?

That website is maintained as a project separate from Git, so you can report issues specific to the website, or create pull requests, at its project page (https://github.com/git/git-scm.com), however...

Show 6 quoted lines

> I found there some inconsistencies. For example, almost in all pages
> are using [no-], but at https://git-scm.com/docs/git-merge each
> command (with [no-] or without) write separately.
>
> There are some same inconsistencies that a easy to fix. So, if I can
> sent a pull-request for such fix – inform me.

Those manual pages are generated from documentation sources in the Git project, thus those fixes should be submitted to Git itself, not to the website project. Changes to Git are sent to this mailing list as patches (see Documentation/SubmittingPatches), although see gitgitgadget[1], which acts as a Github pull-request-to-Git-mailing-list gateway, as a possible alternative.

[1]: https://github.com/gitgitgadget/gitgitgadget/blob/master/README.md

Jonathan Nieder· Nov 12, 2018, 18:39 UTC · re: Fredi Fowler · lore

Re: Git Reference Manual enhance

Hi Fredi,

Fredi Fowler wrote:

Show 8 quoted lines

> Is there any way to create pull request to git man (https://git-scm.com/docs)?
>
> I found there some inconsistencies. For example, almost in all pages
> are using [no-], but at https://git-scm.com/docs/git-merge each
> command (with [no-] or without) write separately.
>
> There are some same inconsistencies that a easy to fix. So, if I can
> sent a pull-request for such fix – inform me.

Welcome! Yes, feel free to make improvements to the manual. First, you'll want to clone the repo:

 git clone https://kernel.googlesource.com/pub/scm/git/git

Then make changes.  You can test using "make":

 make -C Documentation git-merge.html
 open Documentation/git-merges.html

Once you're happy with the patch, it's time to send it out for review. The Git project uses a decentralized review process using email. See https://www.kernel.org/pub/software/scm/git/docs/SubmittingPatches.html for details about how it works.

If you are used to the GitHub pull request process, you may enjoy GitGitGadget, which acts as a sort of bridge. See [1] for instructions. Please do also keep in mind the hints from SubmittingPatches e.g. about how to describe your changes and how to certify your work.

Thanks, and looking forward to seeing your contributions, Jonathan

[1] https://github.com/gitgitgadget/gitgitgadget/blob/master/README.md#a-bot-to-serve-as-glue-between-github-pull-requests-and-the-git-mailing-list