threads / discuss / 6611

git docs on kernel.org too new?

Subject: git docs on kernel.org too new?

## tl;dr

5 messages between Feb 1, 2007 and Feb 1, 2007.

replies: 4people: 3as markdown or json

Brandon Casey· Feb 1, 2007, 17:26 UTC · lore
The git documentation here:
   http://www.kernel.org/pub/software/scm/git/docs/

does not seem to describe the current stable release of git: git-1.4.4.4 (there is a release candidate of 1.5.0 on kernel.org)

I just want to let you know that it has been making it difficult to learn how to use git.

I think in some cases the documentation is out of date, but I suspect that in other cases the documentation refers to the future 1.5.0 release?

For example:
-Step one of tutorial.html:
    $ git config --global user.name "Your Name Comes Here"
    But git-config does not exist.
-Step two of tutorial "Importing a new project"
    $ git init
    But git-init does not exist.
-git-remote does not exist.
-Later "$ git merge experimental" is suggested, but see below, this
  appears to be the wrong usage.
-The everyday.html and git-merge.html pages describe
   a different usage for git-merge than the git-1.4.4.4 docs and
   executables.
   everyday.html(kernel.org):
     $ git checkout master (9)
     $ git merge alsa-audio (10)
   git-merge(kernel.org):
     git-merge [-n] [--no-commit] [--squash] [-s <strategy>] -m=<msg> <remote> <remote>
   git-merge(1.4.4.4):
     Usage: git-merge [-n] [--no-commit] [--squash] [-s <strategy>]... <merge-message> <head> <remote>+
-brandon
Shawn O. Pearce· Feb 1, 2007, 19:20 UTC · re: Stefano Spinucci · lore

Re: git docs on kernel.org too new?

Stefano Spinucci <virgo977virgo@gmail.com> wrote:
> this isn't the first time someone is confused by git docs, and I guess
> why we can't have a documentation page as
> http://www.python.org/doc/versions/

Indeed. Or at least only post docs which correspond to a downloadable tar file?

Perhaps we could embed in at least the HTML version of the docs the output of `GIT-VERSION-GEN` ? Then users at least have a chance at knowing the docs are referring to 1.5.0-rc3 and not to 1.4.4.4?

-- 
Shawn.
Shawn O. Pearce· Feb 1, 2007, 19:17 UTC · re: Brandon Casey · lore

Re: git docs on kernel.org too new?

Brandon Casey <casey@nrlssc.navy.mil> wrote:
Show 6 quoted lines
> The git documentation here:
> 
>   http://www.kernel.org/pub/software/scm/git/docs/
> 
> does not seem to describe the current stable release of
> git: git-1.4.4.4 (there is a release candidate of 1.5.0 on kernel.org)

Yes. The docs on kernel.org roughly track the `master` branch of git.git, which is stablizing the 1.5.0 release. Git 1.5.0-rc3 was posted last night, and with the exception of a couple of minor cleanups for the detached HEAD warning messages, will be the 1.5.0 final release.

Despite being a release candidate I think we would all encourage you to try working with 1.5.0-rc3 or later. It is extremely stable, the documentation has been significantly improved and updated since 1.4.4.4, and the learning curve should be easier for new users.

-- 
Shawn.
Brandon Casey· Feb 1, 2007, 19:21 UTC · re: Shawn O. Pearce · lore

Re: git docs on kernel.org too new?

On Thu, 1 Feb 2007, Shawn O. Pearce wrote:
Show 13 quoted lines
> Brandon Casey <casey@nrlssc.navy.mil> wrote:
>> The git documentation here:
>>
>>   http://www.kernel.org/pub/software/scm/git/docs/
>>
>> does not seem to describe the current stable release of
>> git: git-1.4.4.4 (there is a release candidate of 1.5.0 on kernel.org)
>
> Yes.  The docs on kernel.org roughly track the `master` branch
> of git.git, which is stablizing the 1.5.0 release.  Git 1.5.0-rc3
> was posted last night, and with the exception of a couple of minor
> cleanups for the detached HEAD warning messages, will be the 1.5.0
> final release.
Ah. I thought you might be doing something clever like that.
> Despite being a release candidate I think we would all encourage
> you to try working with 1.5.0-rc3 or later.  It is extremely stable,
> the documentation has been significantly improved and updated since
> 1.4.4.4, and the learning curve should be easier for new users.
will do, thanks.
-brandon

← back to recent threads