git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: making docs

From
LRLuciano Miguel Ferreira Rocha <luciano@eurotux.com>
Date
Apr 14, 2009, 13:14 UTC
Message-ID
<20090414131424.GB16419@bit.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:
Show 18 quoted lines
> 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/>
Previous: Brian Gernhardt
Message 4 of 4 in “making docs”
  1. Ulrich WindlApr 14, 2009
  2. David SymondsApr 14, 2009
  3. Brian GernhardtApr 14, 2009
  4. Luciano Miguel Ferreira RochaApr 14, 2009

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.