Re: [Xen-devel] [PATCH v7] xen: Allow a default compiled-in command line using Kconfig

[Zhongze Liu <blackskygg@xxxxxxxxx>]

2017-03-21 17:30 GMT+08:00 Dario Faggioli <dario.faggioli@xxxxxxxxxx>:
> On Tue, 2017-03-21 at 17:17 +0800, Zhongze Liu wrote:
> :
>> > On Tue, 2017-03-21 at 16:43 +0800, Zhongze Liu wrote:
>> > >
>> Added 2 new config entries in common/Kconfig:
>> > >     CMDLINE and CMDLINE_OVERRIDE
>> > > Modified common/kernel.c:cmdline_parse().
>> > >
>> > > The 2 new entries enable an embedded command line to be compiled
>> > > in the hypervisor. CMDLINE depends on EXPERT = "y", and
>> > > CMDLINE_OVERRIDE
>> > > depends on CMDLINE != "".
>> > >
>> >
>> > And those "1st and 2nd paragraphs" refers to, in this version, the
>> > text
>> > that goes from "Added 2 new..." to "...depends on CMDLINE != """,
>> > which, for what is worth, I agree does not add much and should be
>> > dropped.
>> >
>> I thought these two paragraphs help people reading this message
>> understand more clearly what has been touched and what has been
>> done.
>>
> Right. And in fact, coming up with good changelogs is definitely not
> the easiest part of preparing a patch. :-)
>
> It's, therefore, quite difficult to come up with rules that can be
> called truly general. In this specific case, all the information
> conveyed by those paragraphs is already there, e.g., by looking at the
> diffstat (during the review process) and at the code.
>
> And the purpose of the commit message is not to explain *what* the code
> does (or, let's say, not at this level of details), but other things,
> such as:
>  - why there were the need for the patch;
>  - why the code does what it does in the specific way it does it. :-)
>
> It's certainly not straightforward to draw a line, and even people that
>  are doing this for ages not always get it right at the first time, and
> there's always room for learning and improving... That's why we often
> mention things like this. :-D
>
>> Although, as you put it, this is really not a super big dea, I'll try
>> to make
>> my commit message more concise in my later patches.
>>
> It's not necessarily a matter of length. Much more so a matter of
> redundancy and of what kind of information is there.
>

Thanks for your kind words. Having thoroughly read your comment,
I think I now understand why these two paragraphs are redundant.
Thanks for teaching me about that. I'll surely try my best to learn
more
about how to write a good commit message. And I think the best way is
to observe what others do and try to develop a good "taste" of it.

Cheers.

Zhongze Liu.

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
https://lists.xen.org/xen-devel