Fix asciidoc callouts in git man pages

Fix asciidoc callouts in git man pages

[Sean Estabrooks]

Started out just wanting to update the git-branch man page
to include the "-r" option but noticed that the asciidoc 
callouts weren't being rendered in its man page.  Then 
noticed the same was true for all the man pages where
they are used. 

It turns out we've not been following the guidelines 
properly on how to use them.  The fact that they show up
in a useful way in the html docs is really an accident.
Even there they're not showing up as intended.

Unfortunately, even after all the docs are fixed up to use
the proper format, they still don't render properly in the
man format.   Seems this is a missing feature in the "xmlto"
command.

The final patch in this series adds an xsl fragment which
is passed to xmlto so that the callouts appear properly in 
the man pages.

Sean

 Documentation/Makefile             |    2 +
 Documentation/callouts.xsl         |   16 ++++++++
 Documentation/everyday.txt         |   45 +++++++++++------------
 Documentation/git-branch.txt       |   57 ++++++++++++++++++++---------
 Documentation/git-checkout.txt     |   18 +++++----
 Documentation/git-diff.txt         |   38 ++++++++++---------
 Documentation/git-init-db.txt      |    8 ++--
 Documentation/git-log.txt          |    7 ++--
 Documentation/git-reset.txt        |   72 ++++++++++++++++++------------------
 Documentation/git-update-index.txt |   31 ++++++++--------
 10 files changed, 163 insertions(+), 131 deletions(-)

Re: Fix asciidoc callouts in git man pages

[Jakub Narebski]

<opublikowany i wysłany>

Sean Estabrooks wrote:

> Started out just wanting to update the git-branch man page
> to include the "-r" option but noticed that the asciidoc
> callouts weren't being rendered in its man page.  Then
> noticed the same was true for all the man pages where
> they are used.
> 
> It turns out we've not been following the guidelines
> properly on how to use them.  The fact that they show up
> in a useful way in the html docs is really an accident.
> Even there they're not showing up as intended.
> 
> Unfortunately, even after all the docs are fixed up to use
> the proper format, they still don't render properly in the
> man format.   Seems this is a missing feature in the "xmlto"
> command.
> 
> The final patch in this series adds an xsl fragment which
> is passed to xmlto so that the callouts appear properly in
> the man pages.

Have you sent bugreport/patch to the authors of asciidoc, by the way?

-- 
Jakub Narebski
Warsaw, Poland

Re: Fix asciidoc callouts in git man pages

[sean]

On Fri, 28 Apr 2006 16:06:06 +0200
Jakub Narebski <jnareb@gmail.com> wrote:

> Have you sent bugreport/patch to the authors of asciidoc, by the way?

Have now ;o)   My xsl skills probably won't impress them any, but perhaps 
they'll put some time into including the feature in a future release.

Cheers,
Sean