Re: [Qemu-devel] [PATCH v2] QemuOpt: add unit tests

[Laszlo Ersek]

On 03/21/14 15:56, Leandro Dorileo wrote:
> Hi Eric,
> 
> On Fri, Mar 21, 2014 at 08:37:40AM -0600, Eric Blake wrote:
>> On 03/17/2014 05:10 PM, Leandro Dorileo wrote:
>>> Cover basic aspects and API usage for QemuOpt. The current implementation
>>> covers the API's planned to be changed by Chunyan Liu in his 
>>> QEMUOptionParameter
>>> replacement/cleanup job.
>>>
>>> Other APIs should be covered in future improvements.
>>>
>>> Signed-off-by: Leandro Dorileo <address@hidden>
>>
>> Right here is where you should stick a --- marker.
>>
>>>
>>> Changes:
>>>   v2:
>>>      + fixed comments;
>>>      + make use of g_assert_cmpstr();
>>>      + use error_abort instead of a local_err for qemu_opts_absorb_qdict();
>>>      + asserts on QemuOptsList (empty and list name);
>>>      + added test_qemu_opt_unset();
>>>      + asserts on qemu_opt_*_set() return;
>>>      + added test_qemu_opts_reset();
>>>      + added test_qemu_opts_set();
>>> ---
>>
>> It's okay to have a duplicate one; but the main point is that the v2
>> changelog is useful to reviewers but not to the git log; and anything
>> after the --- marker gets omitted by 'git am' when a maintainer accepts
>> your patch into their pull request.
> 
> I would say that I even know about the --- marker, but have misplaced it... :(

Off-topic: I suggest to include a reference to git-notes(1) in our patch
submission guidelines.
- git-notes(1) lets you manage such v(n)->v(n+1) changelogs inside git,
- the notes are pushable,
- they are carried across rebases,
- they are *not* part of the commit messages (consequently, they are not
part of the commit hashes either),
- they are (can be) correctly displayed by git-log, git-show, gitk, and
git-format-patch (notably, in the last case, under the --- separator)

When you start using git-notes, you don't understand how you could exist
without it.

Git-notes(1) takes some minimal configuration before use; the web offers
easily searchable, good advice.

Thanks,
Laszlo