Re: [StGit] Debian packaging update

From: Karl Hasselström <kha@treskal.com>
Date: Aug 31, 2008, 07:00 UTC
Message-ID: <20080831070043.GA1125@diana.vm.bytemark.co.uk>
In-Reply-To: <b0943d9e0808301533x7a652c59x1a227d6fa4a35961@mail.gmail.com>

On 2008-08-30 23:33:01 +0100, Catalin Marinas wrote:

Show 15 quoted lines

> 2008/8/28 Karl Hasselström <kha@treskal.com>:
>
> > On 2008-08-28 22:52:55 +0200, Yann Dirson wrote:
> >
> > > The official package ships a copy of documentation pages from
> > > the wiki, because they contain information not otherwise
> > > available. Do we want to keep a copy of these files in the
> > > official repo ?
> >
> > We discussed this a while back, and i believe we agreed that
> > having the primary copy in the StGit tree is a good idea. So, yes.
>
> Yes, indeed. And it's on my plan to tidy up and improve the
> documentation (though I wasn't that active recently either :-( ).
> The generated html docs could be put on the web somewhere.

Relatedly, I'm right now teaching the command-line option parser thingy to be able to generate asciidoc man page output (in addition to the interactive help it already features). The end result should be man pages for all stg commands -- with contents that can and should be improved over time. :-)

This would allow some documentation about a specific command to live in its man page, and allow the other docs to hyperlink to the man page, etc.

-- 
Karl Hasselström, kha@treskal.com
      www.treskal.com/kalle