On 19-Apr-18 3:45 PM, Burakov, Anatoly wrote:
On 19-Apr-18 3:09 PM, Arnon Warshavsky wrote:
Thanks Anatoly. Will fix that in v5.
Is it preferred to keep all version notes in the cover letter alone?
Generally, cover letter should give general outline (i.e. "fixed 32 bit
compile"), while notes for individual patches should be more specific
about the changes between versions (but not too specific, i.e. don't do
"change variable X on line 100 to be Y").
So, whatever you think gets your point across best. Not all changes
deserve to be called out in the cover letter.
Just to be clear:
With my initial reply, i did not mean "patch notes should be in the
cover letter". What i meant was that you have put your version changes
"e.g. v4 - changed this to that" into the commit message.
What you should have done is put your patch notes after the commit
message, like this:
replace panic calls with log and retrun value.
Signed-off-by: Arnon Warshavsky <ar...@qwilt.com>
---
v4
static size calculation function changed to return success/fail code
in addition to filling the size result.
lib/librte_eal/linuxapp/eal/eal_hugepage_info.c | 32
++++++++++++++++---------
1 file changed, 21 insertions(+), 11 deletions(-)
Note that the v4 comments are after the "---" - this is where the commit
message ends as far as git concerned, so you can put your notes there.
--
Thanks,
Anatoly