git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* git docs on kernel.org too new?
@ 2007-02-01 17:26 Brandon Casey
  2007-02-01 18:14 ` Stefano Spinucci
  2007-02-01 19:17 ` Shawn O. Pearce
  0 siblings, 2 replies; 5+ messages in thread
From: Brandon Casey @ 2007-02-01 17:26 UTC (permalink / raw)
  To: git



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

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: git docs on kernel.org too new?
  2007-02-01 17:26 git docs on kernel.org too new? Brandon Casey
@ 2007-02-01 18:14 ` Stefano Spinucci
  2007-02-01 19:20   ` Shawn O. Pearce
  2007-02-01 19:17 ` Shawn O. Pearce
  1 sibling, 1 reply; 5+ messages in thread
From: Stefano Spinucci @ 2007-02-01 18:14 UTC (permalink / raw)
  To: git

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/

---
Stefano Spinucci

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: git docs on kernel.org too new?
  2007-02-01 17:26 git docs on kernel.org too new? Brandon Casey
  2007-02-01 18:14 ` Stefano Spinucci
@ 2007-02-01 19:17 ` Shawn O. Pearce
  2007-02-01 19:21   ` Brandon Casey
  1 sibling, 1 reply; 5+ messages in thread
From: Shawn O. Pearce @ 2007-02-01 19:17 UTC (permalink / raw)
  To: Brandon Casey; +Cc: git

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.

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.

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: git docs on kernel.org too new?
  2007-02-01 18:14 ` Stefano Spinucci
@ 2007-02-01 19:20   ` Shawn O. Pearce
  0 siblings, 0 replies; 5+ messages in thread
From: Shawn O. Pearce @ 2007-02-01 19:20 UTC (permalink / raw)
  To: Stefano Spinucci; +Cc: git

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.

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: git docs on kernel.org too new?
  2007-02-01 19:17 ` Shawn O. Pearce
@ 2007-02-01 19:21   ` Brandon Casey
  0 siblings, 0 replies; 5+ messages in thread
From: Brandon Casey @ 2007-02-01 19:21 UTC (permalink / raw)
  To: git

On Thu, 1 Feb 2007, Shawn O. Pearce wrote:

> 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

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2007-02-01 19:22 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2007-02-01 17:26 git docs on kernel.org too new? Brandon Casey
2007-02-01 18:14 ` Stefano Spinucci
2007-02-01 19:20   ` Shawn O. Pearce
2007-02-01 19:17 ` Shawn O. Pearce
2007-02-01 19:21   ` Brandon Casey

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).