Re: `with` as a list.

[Bastien <bzg@gnu.org>]

Mario Frasca <mario@anche.no> writes:

> I'm sure you do understand what I mean, and I guess you know what
> would be the correctly formatted version.  can you show me?  

Yes.  You mentioned earlier that you missed this section:
 https://orgmode.org/worg/org-contribute.html#commit-messages

Let me quote the text from this section:

A commit message should be constructed in the following way:

    Line 1 of the commit message should always be a short description
    of the overall change. Line 1 does not get a dot at the end and
    does not start with a star. Generally, it starts with the filename
    that has been changed, followed by a colon.

    Line 2 is an empty line.

    In line 3, the ChangeLog entry should start. A ChangeLog entry
    looks like this:

      * org-timer.el (org-timer-cancel-timer, org-timer-stop): Enhance
      message.
      (org-timer-set-timer): Use the number of minutes in the Effort
      property as the default timer value. Three prefix arguments will
      ignore the Effort value property.

The few lines above is what we called the "changelog".  It should be
the first part of the commit message -- after which you can add more
free-form context and explanations, if needed.

When you are on a function/variable that you updated in the modified
version of your code, you can create a changelog entry by hitting the
`C-x 4 a' keybinding.

This will open a new buffer, quote the function or variable, and let
you write a short sentence (starting with an uppercase letter and
ending with the ".", as a regular sentence.)

See these examples:

https://code.orgmode.org/bzg/org-mode/commit/b908367b03
https://code.orgmode.org/bzg/org-mode/commit/65fdf2be16
https://code.orgmode.org/bzg/org-mode/commit/f5997d5956

> next time I'll do better, but as of now, I obviously do not
> understand what you want, and why. 

I hope it is a bit more clear now.

> I was busy amending my other patches, and preparing a few more, but
> let's save time on both sides, and I'll give up for the time being.

You did the hardest part, which is to fix things, I hope you will be 
able to update the formatting of the commit messages.

As for the "why", this is because Org follows the same conventions
than Emacs when it comes to commit messages (partly because Org is
part of Emacs.)

Thanks in advance for when you'll feel motivated again!

-- 
 Bastien