Problems in hgrc.5

[Nikolaj Sjujskij]

Den 2013-06-19 17:45:40 skrev Jordi Gutiérrez Hermoso <jordigh at octave.org>:

> Sup, Eric.
>
> On 18 June 2013 01:13,  <esr at thyrsus.com> wrote:
>> Problems with hgrc.5:
>>
>> Renaming SYNOPSIS because either (a) third-party viewers and
>> translators will try to interpret it as a command synopsis and become
>> confused, or (b) it actually needs to be named "SYNOPSIS" with no
>> modifier for function protoypes to be properly recognized.
>>
>> --- hgrc.5-unpatched    2012-07-28 09:23:15.949459835 -0400
>> +++ hgrc.5      2012-07-28 09:23:31.317459443 -0400
>> @@ -30,7 +30,7 @@
>>  .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
>>  .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
>>  ..
>> -.SH SYNOPSIS
>> +.SH DESCRIPTION
>>  .sp
>>  The Mercurial system uses a set of configuration files to control
>>  aspects of its behavior.
>
> The problem is that this manpage has a SYNOPSIS but no DESCRIPTION at
> all. Is this truly a problem?
  Well, if this section isn't really a SYNOPSIS, why not rename it to  
DESCRIPTION?