# making docs 4 messages from 2009-04-14 to 2009-04-14. Participants: Ulrich Windl, David Symonds, Brian Gernhardt, Luciano Miguel Ferreira Rocha. Thread: https://gitlist.dev/t/18864 ## Ulrich Windl, 2009-04-14 13:09 Subject: making docs Message-ID: <49E4A72D.21604.198A9AD@Ulrich.Windl.rkdvmks1.ngate.uni-regensburg.de> URL: https://gitlist.dev/e/49E4A72D.21604.198A9AD%40Ulrich.Windl.rkdvmks1.ngate.uni-regensburg.de ``` 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 ``` ## David Symonds, 2009-04-14 13:14 Subject: Re: making docs Message-ID: URL: https://gitlist.dev/e/ee77f5c20904140614ofa0753apaec52584f2a3878c%40mail.gmail.com In-Reply-To: <49E4A72D.21604.198A9AD@Ulrich.Windl.rkdvmks1.ngate.uni-regensburg.de> ``` On Tue, Apr 14, 2009 at 11:09 PM, Ulrich Windl 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. ``` ## Luciano Miguel Ferreira Rocha, 2009-04-14 13:14 Subject: Re: making docs Message-ID: <20090414131424.GB16419@bit.office.eurotux.com> URL: https://gitlist.dev/e/20090414131424.GB16419%40bit.office.eurotux.com In-Reply-To: <49E4A72D.21604.198A9AD@Ulrich.Windl.rkdvmks1.ngate.uni-regensburg.de> ``` 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 Eurotux Informática, S.A. ``` ## Brian Gernhardt, 2009-04-14 13:18 Subject: Re: making docs Message-ID: <5788C28F-8C24-439D-9119-D96AFB266354@silverinsanity.com> URL: https://gitlist.dev/e/5788C28F-8C24-439D-9119-D96AFB266354%40silverinsanity.com In-Reply-To: ``` On Apr 14, 2009, at 9:14 AM, David Symonds wrote: > On Tue, Apr 14, 2009 at 11:09 PM, Ulrich Windl > 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 ```