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

Re: Shipping man pages?

From
MRMark Rosenstand <mark@borkware.net>
Date
May 18, 2006, 09:41 UTC
Message-ID
<1147945298.1320.35.camel@mjollnir>
In-Reply-To
<7vac9f69la.fsf@assigned-by-dhcp.cox.net>
On Thu, 2006-05-18 at 01:06 -0700, Junio C Hamano wrote:
Show 5 quoted lines
> Tilman Sauerbeck <tilman@code-monkey.de> writes:
> 
> > atm, the git release tarballs don't contain man pages.
> 
> I ship *source* tarball.

Which is great for generating binaries and other things that are likely to be incompatible across systems.

Show 7 quoted lines
> I also happen to do RPM for people who do not want to build from
> the source (btw, I do that from pure inertia). In addition,
> preformatted manual pages and html docs are available from man
> and html branches of the git.git repository.
> 
> If you are building from the source, please build from the
> source.  Everything you need is right there.

But asciidoc is a royal PITA to package or install - it doesn't even provide a Makefile: http://www.methods.co.nz/asciidoc/userguide.html#X38

Additionally it carries the whole docbook dependency chain with it.
Show 5 quoted lines
> If you don't build from the source, please use whatever binary
> distribution available out there.  RPM happens to be available
> from kernel.org.  If you are on Debian/Ubuntu/Gentoo/others,
> please ask your distribution packager to include the manpages
> and html docs, if they don't already.

Even the packagers are likely to hate the unneccessary asciidoc dependency. As a result some of the small distributions that don't have the manpower to support 1000+ packages choose to ship git without the man pages, which is a shame, IMO.

> Why does this have to come up so often, and everybody who asks
> for them never supplies the patch to do so?

Because it seems like a political decision rather than a technical one (it's trivial to add the docs as a prerequisite for the dist target.)

Show 7 quoted lines
> > Or maybe offer them in a separate tarball?
> 
> Things that are buildable from the source do not belong in the
> source tarball.  If somebody wants to do this as a patch, I can
> be talked into accepting it, but the build procedure should
> build a separate tarball (or two; one for man and another for
> woman^Whtml).

That would be great! I'd love to submit a patch, but I wouldn't be able to test it, because I'd need asciidoc.

Previous: Junio C HamanoNext: Junio C Hamano
Message 3 of 7 in “Shipping man pages?”
  1. Tilman SauerbeckMay 18, 2006
  2. Junio C HamanoMay 18, 2006
  3. Mark RosenstandMay 18, 2006
  4. Junio C HamanoMay 18, 2006
  5. Linus TorvaldsMay 18, 2006
  6. Tilman SauerbeckMay 18, 2006
  7. Fernando J. PeredaMay 18, 2006

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.