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

Re: [RFC/WIP 0/2] Documentation clean-up: git commands

From
Jeff King <peff@peff.net>
Date
Mar 24, 2009, 03:34 UTC
Message-ID
<20090324033410.GB12829@coredump.intra.peff.net>
In-Reply-To
<37FD43AD-E43A-4565-8085-95E606E0B868@pobox.com>
On Mon, Mar 23, 2009 at 06:13:11PM -0500, Chris Johnsen wrote:
Show 14 quoted lines
> I have a series of patches prepared to "cleanup" and modify  
> {callout,manpage-1.72}.xsl and asciidoc.conf, but I am still running a 
> series of "make doc" runs across the changes to try to make sure they are 
> sane. Here is a preview:
>
> Documentation: move callouts.xsl to manpage-{base,normal}.xsl
> Documentation: use parametrized manpage-base.xsl with manpage- 
> {1.72,normal}.xsl
> Documentation: rename docbook-xsl-172 attribute to git-asciidoc-no-roff
> Documentation: move quieting params into manpage-base.xsl
> Documentation: move "spurious .sp" code into manpage-base.xsl
> Documentation: asciidoc.conf: always use <literallayout> for [blocktext]
> Documentation: asciidoc.conf: fix verse block with block titles
> Documentation: option to render literal text as italic for manpages

Oh, good, thanks for working on this. I was actually about to start looking at it tonight.

For the final one, italicized or emphasized text will often end up underlined in most terminals. Peeking at other manpages led me to the conclusion that bolding literal text is the most common convention.

-Peff
Previous: Chris JohnsenNext: Michael J Gruber
Message 10 of 11 in “[RFC/WIP 0/2] Documentation clean-up: git commands”
  1. Michael J GruberMar 23, 2009
  2. 1/2 Documentation: fix minor inconsistencyMichael J Gruber, Mar 23, 2009
  3. 2/2 Documentation: format git commands consistentlyMichael J Gruber, Mar 23, 2009
  4. Matthieu MoyMar 23, 2009
  5. Michael J GruberMar 23, 2009
  6. Michael J GruberMar 23, 2009
  7. Junio C HamanoMar 23, 2009
  8. Michael J GruberMar 23, 2009
  9. Chris JohnsenMar 23, 2009
  10. Jeff KingMar 24, 2009
  11. Michael J GruberMar 24, 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.