All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jakub Narebski <jnareb@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Drew Northup <drew.northup@maine.edu>,
	Jonathan Nieder <jrnieder@gmail.com>
Subject: Re: [PATCHv5/RFC 1/6] Documentation: Preparation for gitweb manpages
Date: Tue, 11 Oct 2011 20:16:09 +0200	[thread overview]
Message-ID: <201110112016.09620.jnareb@gmail.com> (raw)
In-Reply-To: <7vvcrvfmg4.fsf@alter.siamese.dyndns.org>

Junio C Hamano wrote:
> Jakub Narebski <jnareb@gmail.com> writes:
>> 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.

O.K., will do.

Now that reminds me that in a few situations gitweb.conf.txt uses literary
description "defaults to sth"...  I'll make the rest consistent with this.

-- 
Jakub Narebski
Poland

  reply	other threads:[~2011-10-11 18:16 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-10-08 18:31 [PATCHv5/RFC 0/6] Moving gitweb documentation to manpages Jakub Narebski
2011-10-08 18:31 ` [PATCHv5/RFC 1/6] Documentation: Preparation for gitweb manpages Jakub Narebski
2011-10-10 18:53   ` Junio C Hamano
2011-10-10 21:52     ` Jakub Narebski
2011-10-10 23:10       ` Junio C Hamano
2011-10-11 15:39         ` Jakub Narebski
2011-10-11 17:49           ` Junio C Hamano
2011-10-11 18:16             ` Jakub Narebski [this message]
2011-10-08 18:31 ` [PATCHv5 2/6] gitweb: Add manpage for gitweb configuration files Jakub Narebski
2011-10-08 18:32 ` [PATCHv5/RFC 3/6] gitweb: Add manpage for gitweb Jakub Narebski
2011-10-10 18:56   ` Junio C Hamano
2011-10-10 22:02     ` Jakub Narebski
2011-10-10 22:18       ` Jonathan Nieder
2011-10-11 13:02         ` Drew Northup
2011-10-11 13:51           ` Jakub Narebski
2011-10-11 14:01             ` [PATCHv5/RFC 3/6] gitweb: Add manpage for gitweb (APPLICATION!!!) Drew Northup
2011-10-11 14:20               ` Jakub Narebski
2011-10-11 16:56                 ` Drew Northup
2011-10-08 18:32 ` [PATCHv5 4/6] Documentation: Link to gitweb(1) and gitweb.conf(5) in other manpages Jakub Narebski
2011-10-08 18:32 ` [PATCHv5 5/6] Documentation: Add gitweb config variables to git-config(1) Jakub Narebski
2011-10-08 18:32 ` [PATCHv5 6/6] gitweb: Add gitweb manpages to 'gitweb' package in git.spec Jakub Narebski
2011-10-10 18:47 ` [PATCHv5/RFC 0/6] Moving gitweb documentation to manpages Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=201110112016.09620.jnareb@gmail.com \
    --to=jnareb@gmail.com \
    --cc=drew.northup@maine.edu \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jrnieder@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.