lists.openwall.net   lists  /  announce  owl-users  owl-dev  john-users  john-dev  passwdqc-users  yescrypt  popa3d-users  /  oss-security  kernel-hardening  musl  sabotage  tlsify  passwords  /  crypt-dev  xvendor  /  Bugtraq  Full-Disclosure  linux-kernel  linux-netdev  linux-ext4  linux-hardening  linux-cve-announce  PHC 
Open Source and information security mailing list archives
 
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-ID: <cb97c1e6-0218-6b79-fd72-9ceaae976d16@users.sourceforge.net>
Date:   Thu, 19 Oct 2017 20:56:08 +0200
From:   SF Markus Elfring <elfring@...rs.sourceforge.net>
To:     Joe Perches <joe@...ches.com>, kernel-janitors@...r.kernel.org,
        linux-doc@...r.kernel.org
Cc:     Jessica Yu <jeyu@...nel.org>,
        Rusty Russell <rusty@...tcorp.com.au>,
        Wolfram Sang <wsa@...-dreams.de>,
        LKML <linux-kernel@...r.kernel.org>
Subject: Re: kernel/module: Delete an error message for a failed memory
 allocation in add_module_usage()

>>> 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

Powered by blists - more mailing lists

Powered by Openwall GNU/*/Linux Powered by OpenVZ