git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Luciano Miguel Ferreira Rocha <luciano@eurotux.com>
To: Ulrich Windl <ulrich.windl@rz.uni-regensburg.de>
Cc: git@vger.kernel.org
Subject: Re: making docs
Date: Tue, 14 Apr 2009 14:14:24 +0100	[thread overview]
Message-ID: <20090414131424.GB16419@bit.office.eurotux.com> (raw)
In-Reply-To: <49E4A72D.21604.198A9AD@Ulrich.Windl.rkdvmks1.ngate.uni-regensburg.de>

[-- Attachment #1: Type: text/plain, Size: 1225 bytes --]

On Tue, Apr 14, 2009 at 03:09:33PM +0200, Ulrich Windl wrote:
> Hi!
> 
> THis is a change request: When building Git, many systems lack the tools to build 
> the documentation, so the Manual pages (among others) are not built. When 
> installing, several ".txt" files are installed, but when invoking help like "git 
> commit --help", git only complains about not finding the manual page.
> 
> Obvious solutions are:
> 1) Pre-build the documentation (manual pages) with the source archive. If the 
> sources are used unmodified, the manual pages should be fine
> 2) If nothing better is found when invoking help, display the text files with a 
> pager
> 
> An alternative to 1) would be a add-on "source" package that contains the pre-
> built documentation. Documentation files should be platform-independent, so that 
> should be fine for almost everyone.
> 
> Comments?

If using the git repository, there's the man branch with prebuilt man
pages.

There's already the 'add-on "source" package', e.g.
http://www.kernel.org/pub/software/scm/git/git-manpages-1.6.2.3.tar.bz2

Regards,
Luciano Rocha

-- 
Luciano Rocha <luciano@eurotux.com>
Eurotux Informática, S.A. <http://www.eurotux.com/>

[-- Attachment #2: Type: application/pgp-signature, Size: 197 bytes --]

      parent reply	other threads:[~2009-04-14 13:22 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-04-14 13:09 making docs Ulrich Windl
2009-04-14 13:14 ` David Symonds
2009-04-14 13:18   ` Brian Gernhardt
2009-04-14 13:14 ` Luciano Miguel Ferreira Rocha [this message]

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=20090414131424.GB16419@bit.office.eurotux.com \
    --to=luciano@eurotux.com \
    --cc=git@vger.kernel.org \
    --cc=ulrich.windl@rz.uni-regensburg.de \
    /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;
as well as URLs for NNTP newsgroup(s).