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

Re: [PATCH] Documentation: fix git-clone manpage not to refer to itself

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
Nov 19, 2007, 13:35 UTC
Message-ID
<Pine.LNX.4.64.0711191430460.16728@wbgn129.biozentrum.uni-wuerzburg.de>
In-Reply-To
<87ejeq1131.fsf@osv.gnss.ru>
Hi,
On Fri, 16 Nov 2007, Sergei Organov wrote:
> +ifndef::git-clone[]

It is laudable that you want to fix the _generated_ documentation, but there are two things to keep in mind:

- it does _nothing_ to help readers of the sources, and asciidoc was 
  chosen purposely because the source is human-readable, and
- it makes writing the perl script to do a very tiny subset of asciidoc 
  formatting much harder.  We encounter enough problems with the different 
  versions of asciidoc/docbook combinations that I think this perl script 
  would be actually useful.

I know that the user manual uses some advanced features, too, but it did not use ifdef in the main text, for example, let alone nested ifdefs, which your patch would encourage much more than the source before.

Ciao, Dscho

Previous: Sergei OrganovNext: Jakub Narebski
Message 2 of 6 in “Documentation: fix git-clone manpage not to refer to itself”
  1. Documentation: fix git-clone manpage not to refer to itselfSergei Organov, Nov 16, 2007
  2. Johannes SchindelinNov 19, 2007
  3. Jakub NarebskiNov 19, 2007
  4. Sergei OrganovNov 19, 2007
  5. Wincent ColaiutaNov 20, 2007
  6. Johannes SchindelinNov 20, 2007

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.