From: Joe Perches <joe@perches.com>
To: SF Markus Elfring <elfring@users.sourceforge.net>,
kernel-janitors@vger.kernel.org, linux-doc@vger.kernel.org
Cc: Jessica Yu <jeyu@kernel.org>,
Rusty Russell <rusty@rustcorp.com.au>,
LKML <linux-kernel@vger.kernel.org>
Subject: Re: kernel/module: Delete an error message for a failed memory allocation in add_module_usage()
Date: Thu, 19 Oct 2017 04:45:36 -0700 [thread overview]
Message-ID: <1508413536.6806.38.camel@perches.com> (raw)
In-Reply-To: <1dee801c-37b5-4d72-b33f-ebdc135b4f25@users.sourceforge.net>
On Thu, 2017-10-19 at 13:35 +0200, SF Markus Elfring wrote:
> > > > > Omit an extra message for a memory allocation failure in this function.
> > > > >
> > > > > This issue was detected by using the Coccinelle software.
[]
> > > Do you see any need that I should extend subsequent commit messages
> > > for this software transformation pattern?
> >
> > Add a description of _why_ this is being done.
> >
> > Something like:
> >
> > "because there is a dump_stack() done on allocation failures
> > without __GFP_JNOWARN"
>
> How do you think about to convert such a description into a special format
> for further reference documentation?
I think it's a bad idea if it's a "special" format.
Always write _why_ some code is being changed.
People could read the commit descriptions and would not need
to take extra time to lookup external references.
Maybe add something like
"see (commit <foo> or <file>)" for additional details"
next prev parent reply other threads:[~2017-10-19 11:45 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-06 15:12 [PATCH] kernel/module: Delete an error message for a failed memory allocation in add_module_usage() SF Markus Elfring
2017-10-19 9:29 ` Jessica Yu
2017-10-19 10:30 ` Dan Carpenter
2017-10-19 11:02 ` Jessica Yu
2017-10-19 11:12 ` SF Markus Elfring
2017-10-19 10:42 ` SF Markus Elfring
2017-10-19 11:08 ` Jessica Yu
2017-10-19 11:18 ` SF Markus Elfring
2017-10-19 11:29 ` Joe Perches
2017-10-19 11:35 ` SF Markus Elfring
2017-10-19 11:45 ` Joe Perches [this message]
2017-10-19 18:56 ` SF Markus Elfring
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1508413536.6806.38.camel@perches.com \
--to=joe@perches.com \
--cc=elfring@users.sourceforge.net \
--cc=jeyu@kernel.org \
--cc=kernel-janitors@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rusty@rustcorp.com.au \
/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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox