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

Fix asciidoc callouts in git man pages

From
Sean Estabrooks <seanlkml@sympatico.ca>
Date
Apr 28, 2006, 13:13 UTC
Message-ID
<BAYC1-PASMTP1046BB48C01D83AC57A694AEB20@CEZ.ICE>

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(-)
Next: Jakub Narebski
Message 1 of 3 in “Fix asciidoc callouts in git man pages”
  1. Sean EstabrooksApr 28, 2006
  2. Jakub NarebskiApr 28, 2006
  3. seanApr 28, 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.