making docs

making docs

[Ulrich Windl]

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?

Regards,
Ulrich

Re: making docs

[David Symonds]

On Tue, Apr 14, 2009 at 11:09 PM, Ulrich Windl
<ulrich.windl@rz.uni-regensburg.de> wrote:

> 1) Pre-build the documentation (manual pages) with the source archive. If the
> sources are used unmodified, the manual pages should be fine

This is already in the git.git repository, in the 'man' and 'html' branches.


Dave.

Re: making docs

[Luciano Miguel Ferreira Rocha]

[-- 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 --]

Re: making docs

[Brian Gernhardt]

On Apr 14, 2009, at 9:14 AM, David Symonds wrote:

> On Tue, Apr 14, 2009 at 11:09 PM, Ulrich Windl
> <ulrich.windl@rz.uni-regensburg.de> wrote:
>
>> 1) Pre-build the documentation (manual pages) with the source  
>> archive. If the
>> sources are used unmodified, the manual pages should be fine
>
> This is already in the git.git repository, in the 'man' and 'html'  
> branches.

Which can be installed using `make quick-install-man` or `make quick- 
install-html`.

~~ Brian