From: Bastien <bzg@gnu.org>
To: John Hendy <jw.hendy@gmail.com>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: Clarification on ChangeLog documentation
Date: Mon, 17 Mar 2014 02:08:35 +0100 [thread overview]
Message-ID: <87bnx5ocmk.fsf@bzg.ath.cx> (raw)
In-Reply-To: <CA+M2ft-f91o5ke2i8en6ck-y91zsv8Bxfd+BcYTVzBNUxj7evA@mail.gmail.com> (John Hendy's message of "Sat, 15 Mar 2014 10:17:17 -0500")
Hi John,
John Hendy <jw.hendy@gmail.com> 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
prev parent reply other threads:[~2014-03-17 1:08 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-03-14 16:09 Clarification on ChangeLog documentation John Hendy
2014-03-15 6:28 ` Bastien
2014-03-15 15:17 ` John Hendy
2014-03-17 1:08 ` Bastien [this message]
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
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87bnx5ocmk.fsf@bzg.ath.cx \
--to=bzg@gnu.org \
--cc=emacs-orgmode@gnu.org \
--cc=jw.hendy@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.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).