[ANNOUNCE] GIT preformatted documentation available.

Previous thread: [ANNOUNCE] GIT 1.0.5 by Junio C Hamano on Tuesday, December 27, 2005 - 4:47 am. (4 messages)

Next thread: [PATCH] copy_fd: close ifd on error by Sam Ravnborg on Tuesday, December 27, 2005 - 4:19 am. (2 messages)
To: <git@...>, <linux-kernel@...>
Cc: Willy Tarreau <willy@...>
Date: Tuesday, December 27, 2005 - 4:49 am

I was asked to provide pre-formatted man pages (and perhaps html
pages), since the time of kernel developers are better spent on
what they do best, rather than preparing the xmlto toolchain.

I was planning to do a tarball every time I do a "release", but
that would mean it is no better than the current way --- you
could extract manpages out of rpm anyway.

So instead, I'll do independent branches "html" and "man" in
git.git repository to keep the preformatted documentation.

$ mkdir git.man ; cd git.man
$ git init-db
$ ID=$(git fetch-pack -k git://git.kernel.org/pub/scm/git/git man)
$ expr "$ID" : '\(.*\) .*' >.git/refs/heads/master
$ cat .git/refs/heads/master >.git/refs/heads/origin
$ git checkout; /bin/ls -aF
./ ../ .git/ man1/ man7/
$ echo >.git/remotes/origin <<\EOF
URL: git://git.kernel.org/pub/scm/git/git
Pull: man:origin
EOF

Would set you up, and you can
to keep them up-to-date, and install them like so:

$ cd git.man
$ git pull
$ cp -a man1 man7 /usr/local/man/

The "html" branch is similar; it is a copy of what is shown at
http://www.kernel.org/pub/software/scm/git/docs/.

This means if you clone from git.git repository, you would end
up with something like this in .git/remotes/origin file:

URL: git://git.kernel.org/pub/scm/git/git.git
Pull: master:origin
Pull: todo:todo
Pull: html:html
Pull: man:man
Pull: pu:pu
Pull: maint:maint

Typically, for the repository to track GIT itself, you would
want to trim them like this:

URL: git://git.kernel.org/pub/scm/git/git.git
Pull: master:origin
Pull: maint:maint
Pull: +pu:pu

-

To: Junio C Hamano <junkio@...>
Cc: <git@...>
Date: Wednesday, December 28, 2005 - 12:51 pm

Having preformatted documentation is a great step forward, but it
would be even better if we could have it without installing some weird
RPM tool or a local copy of the Git repository -- not all my machines
have that.

Besides, it's not very beginner- or newcomer-friendly. Grab the
source; discover you need a complex toolchain to have manpages; maybe
learn sometime later that "all you had to do" was get an RPM and
explode some parts of it -- nah, it just doesn't feel right.

You're already generating five RPMs and two tarballs everytime you
release a version, would it be much more taxing to generate a third
tarball?

That said, those two new branches are neat. Thanks!
-

Previous thread: [ANNOUNCE] GIT 1.0.5 by Junio C Hamano on Tuesday, December 27, 2005 - 4:47 am. (4 messages)

Next thread: [PATCH] copy_fd: close ifd on error by Sam Ravnborg on Tuesday, December 27, 2005 - 4:19 am. (2 messages)