Web lists-archives.com

Re: is http://git-scm.com an *official* git-affiliated site?




On Wed, Feb 07 2018, Robert P. J. Day jotted:

>   i ask WRT whether it should be up to date. i'm currently writing a
> number of git-related wiki pages, and i want to link to whatever are
> the canonical man pages for various git commands, but that site seems
> a bit off.
>
>   if one follows a link to get here:
>
> https://git-scm.com/doc
>
> there is another link to the "Reference Manual" that promises "The
> official and comprehensive man pages that are included in the Git
> package itself."
>
>   but upon getting there:
>
> https://git-scm.com/docs
>
> it seems clear that that page doesn't come close to covering all of
> the available git commands.
>
>   as an example, there is a link "submodule" on that page, which does
> indeed take one to the page https://git-scm.com/docs/git-submodule. so
> far, so good.
>
>   however, while there is no link for the "worktree" command, there
> does in fact exist a similarly-named web page
> https://git-scm.com/docs/git-worktree.

It is an official site, of the git project. The project is legally
managed by the SFC which owns the domain, Github happens to host it (for
free) for us.

It's not fully auto-generated so stuff like git-worktree doesn't get
added automatically, I just added a PR for that:
https://github.com/git/git-scm.com/pull/1133

>   finally, there is no reference to the git "subtree" command, either
> as a link *or* as an existing web page
> https://git-scm.com/docs/git-subtree. it all seems kind of arbitrary.

Unlike git-worktree, git-subtree is not shipped as a "proper" git
command, it lives in contrib/. What the status of that is I'm not sure,
but that's why it's not on git-scm or kernel.org in any form.

>   is there an actual, canonical set of online web pages for all
> current git commands one should use?

You can use git-scm.com or the kernel.org link Duy noted.

The thing that's the most official is the man pages we ship with any
given release, and as seen above the online presence may lag behind in
some ways, but that can always be fixed.

Even though we may have some official online sources, it's better to
direct users to the documentation that ships with git on their system,
since it'll reflect the version they're using.