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

Re: [PATCHv5/RFC 1/6] Documentation: Preparation for gitweb manpages

From
Junio C Hamano <gitster@pobox.com>
Date
Oct 11, 2011, 17:49 UTC
Message-ID
<7vvcrvfmg4.fsf@alter.siamese.dyndns.org>
In-Reply-To
<201110111739.49967.jnareb@gmail.com>
Jakub Narebski <jnareb@gmail.com> writes:
Show 22 quoted lines
> On Tue, 11 Oct 2011, Junio C Hamano wrote:
>
>> I probably do not have time to look into this, but just FYI my trial merge
>> to 'pu' of this topic is failing like this:
>> 
>> asciidoc: ERROR: gitweb.conf.txt: line 484: illegal style name: Default: ()
>> asciidoc: ERROR: gitweb.conf.txt: line 494: illegal style name: Default: 300
>
> Damn, I thought I have fixed that.  This probably depends on AsciiDoc
> version ("make doc" on 'master' generates a few _warnings_ for me related
> to similar situation), but the problem is with
>
>   [Default: <value>]
>
> that was copied from gitweb/README.  But [<sth>] is an attribute list
> (style name in simplest form), used more often in newer AsciiDoc.
>
> So either we have to escape '[' and ']', i.e. use {startsb} and {endsb},
> which would reduce human-friendliness, or move to different way of marking
> default values, e.g. _italic_.
>
> What do you think?

What do the other documents in the directory this file lives say? I think we explain what the variables does, and add "defaults to false" or somesuch in the text, without any funny mark-up.

Previous: Jakub NarebskiNext: Jakub Narebski
Message 7 of 22 in “[PATCHv5/RFC 0/6] Moving gitweb documentation to manpages”
  1. Jakub NarebskiOct 8, 2011
  2. 1/6 Documentation: Preparation for gitweb manpagesJakub Narebski, Oct 8, 2011
  3. Junio C HamanoOct 10, 2011
  4. Jakub NarebskiOct 10, 2011
  5. Junio C HamanoOct 10, 2011
  6. Jakub NarebskiOct 11, 2011
  7. Junio C HamanoOct 11, 2011
  8. Jakub NarebskiOct 11, 2011
  9. 2/6 gitweb: Add manpage for gitweb configuration filesJakub Narebski, Oct 8, 2011
  10. 3/6 gitweb: Add manpage for gitwebJakub Narebski, Oct 8, 2011
  11. Junio C HamanoOct 10, 2011
  12. Jakub NarebskiOct 10, 2011
  13. Jonathan NiederOct 10, 2011
  14. Drew NorthupOct 11, 2011
  15. Jakub NarebskiOct 11, 2011
  16. Drew NorthupOct 11, 2011
  17. Jakub NarebskiOct 11, 2011
  18. Drew NorthupOct 11, 2011
  19. 4/6 Documentation: Link to gitweb(1) and gitweb.conf(5) in other manpagesJakub Narebski, Oct 8, 2011
  20. 5/6 Documentation: Add gitweb config variables to git-config(1)Jakub Narebski, Oct 8, 2011
  21. 6/6 gitweb: Add gitweb manpages to 'gitweb' package in git.specJakub Narebski, Oct 8, 2011
  22. Junio C HamanoOct 10, 2011

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.