[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [O] Clarification on ChangeLog documentation
From: |
Bastien |
Subject: |
Re: [O] Clarification on ChangeLog documentation |
Date: |
Mon, 17 Mar 2014 02:08:35 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/24.3.50 (gnu/linux) |
Hi John,
John Hendy <address@hidden> writes:
> In the example provided, the first asterisk lists a file and two
> changed nodes. Why is the third just parentheses with no file.
> Assumption: it's also in org-timer.el, but the description of the
> change just wouldn't have matched the other two.
This is the standard way a Changelog file looks like.
Try adding chanlog entries with C-x 4 a.
>> #+begin_quote:
>> The problem here was that a wrong keyword was given in the
>> customization type. This let to a string-match against a list value.
>> #+end_quote
>>
>> I couldn't tell if this paragraph was supposed to be a continuation of
>> the second "header" above, or if it was it's own standalone summary of
>> the gist of both changes.
>
> Taking this to be general elaboration about /both/ changes; i.e. a
> summary of the motivation of the changes in general.
Yes, exactly.
>> #+begin_quote
>> Modified from a patch proposal by Johan Friis.
>> #+end_quote
>>
>> Can I reference mailing list threads, or is this not advised?
You are encouraged to reference mailing list threads and/or
previous commits refs, for sure.
>> Or
>> should I be mentioning the person who responded on the mailing list
>> for the clarification which led to the documentation modification?
Up to you. There are no real conventions in this part: add what you
think is useful for groking the how and why of the commit.
> Still not sure about this.
>
>> #+begin_quote
>> TINYCHANGE
>> #+end_quote
>>
>> Is the FSF requirement necessary only if one commit > x lines, or is
>> it cumulative?
>
> Also not sure about this, but I've seen enough FSF forms asked for
> that I assume I'll be asked if I hit whatever the limit is.
The limit is a cumulative change of 20 non-repetitive change
lines.
Best,
--
Bastien