mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Junio C Hamano <junkio@cox.net>
To: git@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: Willy Tarreau <willy@w.ods.org>
Subject: [ANNOUNCE] GIT preformatted documentation available.
Date: Tue, 27 Dec 2005 00:49:17 -0800	[thread overview]
Message-ID: <7vu0cuc4c2.fsf@assigned-by-dhcp.cox.net> (raw)

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




                 reply	other threads:[~2005-12-27  8:49 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7vu0cuc4c2.fsf@assigned-by-dhcp.cox.net \
    --to=junkio@cox.net \
    --cc=git@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=willy@w.ods.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®