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

Re: [PATCH] git-branch.txt: document -f correctly

From
git@drmicha.warpmail.net <git@drmicha.warpmail.net>
Date
Mar 17, 2009, 16:51 UTC
Message-ID
<49BFD4FC.40707@drmicha.warpmail.net>
In-Reply-To
<450196A1AAAE4B42A00A8B27A59278E70A3FC05C@EXCHANGE.trad.tradestation.com>
John Dlugosz venit, vidit, dixit 17.03.2009 17:07:
Show 10 quoted lines
> ===  Re: ===
> BTW, I noticed that 'git-subcmd' is used everywhere in here which does
> not feel right, but I followed the existing style, leaving a consistent
> clean-up for a later patch. Also, typesetting is inconsistent:
> We have <branch> as well as `<branch>` when the text talks about the
> options. Do we have a style guide or such?
> === end ===
> 
> I would agree that being factually correct and available immediately
> trumps being wrong but pretty.

I can't really make much sense out of this but I guess I doesn't matter. In any case, by "style guide" I mean something saying "write options as monospaced", "write git commands without dash unless in links"...

Show 5 quoted lines
> As an experienced writer and editor, the documentation is something I
> might hack long before I tackle the code.  I see you edited a file with
> .txt extension, and some kind of markup that's not the HTML files I'm
> reading.  Beyond any kind of style guide, is there a guide to the
> documentation _system_ in use?

It's asciidoc. Rather, asciidoc 7ish, current asciidoc is at 8.4.1. The backticks are used for displaying commands, e.g., and usually come out as monospaced in html, underlined in man.

Cheers, Michael

Previous: John Dlugosz
Message 2 of 2 in “Re: [PATCH] git-branch.txt: document -f correctly”
  1. John DlugoszMar 17, 2009
  2. git@drmicha.warpmail.netMar 17, 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.