[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#976301: Fix invalid `changelog` format example



Hello,

On Tue 19 Jan 2021 at 04:19AM +01, Guillem Jover wrote:

> On Mon, 2021-01-18 at 18:25:55 -0700, Sean Whitton wrote:
>> On Thu 03 Dec 2020 at 05:08AM +03, Anatoli Babenia wrote:
>> > diff --git a/policy/ch-source.rst b/policy/ch-source.rst
>> > index edae8c1..1265c5e 100644
>> > --- a/policy/ch-source.rst
>> > +++ b/policy/ch-source.rst
>> > @@ -126,7 +126,7 @@ That format is a series of entries like this:
>> >       [blank line(s), included in output of dpkg-parsechangelog]
>> >       * even more change details
>> >       [optional blank line(s), stripped]
>> >     [----]{+[space]--+} maintainer name <email address>[two [-spaces]
>> > date-]{+spaces]date+}
>>
>> I do not believe that what is already there is invalid or unclear.
>>
>> Please explain your motivations.
>
> Oh, but it does look invalid. :) Notice that the trailing maintainer
> line starts at the same column as the header line, but the trailer must
> be indented by one space.

Oops, fixed on master, thank you.

> Also the «two spaces» are then followed by two explicit spaces, which
> seems confusing.

We have a choice of putting [space] throughout and replacing "[two
spaces]  " with just "[two spaces]", just doing the latter replacement,
or leaving it as it is.  Tbh I think the first option makes the whole
thing a bit noisy.  I think the second is more confusing than the third,
but I don't know if I'm alone in that.  Would be good to get some more
opinions.

-- 
Sean Whitton

Attachment: signature.asc
Description: PGP signature


Reply to: