From: SF Markus Elfring <elfring@users.sourceforge.net>
To: Joe Perches <joe@perches.com>,
kernel-janitors@vger.kernel.org, linux-doc@vger.kernel.org
Cc: Jessica Yu <jeyu@kernel.org>,
Rusty Russell <rusty@rustcorp.com.au>,
Wolfram Sang <wsa@the-dreams.de>,
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 20:56:08 +0200 [thread overview]
Message-ID: <cb97c1e6-0218-6b79-fd72-9ceaae976d16@users.sourceforge.net> (raw)
In-Reply-To: <1508413536.6806.38.camel@perches.com>
>>> 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.
Will it be nice to represent corresponding details as a better
“restructured text”?
> 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.
I would appreciate if I could copy a widely accepted explanation.
> Maybe add something like
> "see (commit <foo> or <file>)" for additional details"
Are there any related extensions possible besides other background information?
Link: http://events.linuxfoundation.org/sites/events/files/slides/LCJ16-Refactor_Strings-WSang_0.pdf
Regards,
Markus
prev parent reply other threads:[~2017-10-19 18:56 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
2017-10-19 18:56 ` SF Markus Elfring [this message]
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=cb97c1e6-0218-6b79-fd72-9ceaae976d16@users.sourceforge.net \
--to=elfring@users.sourceforge.net \
--cc=jeyu@kernel.org \
--cc=joe@perches.com \
--cc=kernel-janitors@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rusty@rustcorp.com.au \
--cc=wsa@the-dreams.de \
/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