linux-kernel - Re: [PATCH 1/8] samples: move accounting example code from Documentation

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <d535cd06-c661-3232-db2a-9334e04a6b0a@osg.samsung.com>
Date:   Tue, 20 Sep 2016 10:05:25 -0600
From:   Shuah Khan <shuahkh@....samsung.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     sudeep.dutt@...el.com, ashutosh.dixit@...el.com,
        tomas.winkler@...el.com, tglx@...utronix.de, wim@...ana.be,
        linux@...ck-us.net, elfring@...rs.sourceforge.net,
        nicolas.dichtel@...nd.com, davem@...emloft.net,
        gregkh@...uxfoundation.org, dasaratharaman.chandramouli@...el.com,
        maheshkhanwalkar@...il.com, mikedanese@...gle.com,
        ben@...adent.org.uk, ghackmann@...gle.com,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-pcmcia@...ts.infradead.org, linux-watchdog@...r.kernel.org,
        shuah Khan <shuahkh@....samsung.com>
Subject: Re: [PATCH 1/8] samples: move accounting example code from
 Documentation

On 09/19/2016 10:02 AM, Jonathan Corbet wrote:
> On Mon, 19 Sep 2016 08:47:32 -0600
> Shuah Khan <shuahkh@....samsung.com> wrote:
> 
>> Move accounting examples to samples and remove it from Documentation
>> Makefile. Create a new Makefile to build accounting. It can be built
>> from top level directory or from accounting directory:
> 
> So I like the basic idea of these patches; it's the direction we've been
> trying to push things for a little bit.  I have a couple of specific
> comments for this one that may well apply to the others as well.
> 
> 1) Is samples the right destination for these utilities?  Some of them
>    might well be better placed under tools/ instead.  I'm not sure we've
>    ever formally stated the purpose of those two subtrees; I see samples/
>    as demonstrations of how to use something, while tools/ are utilities
>    you might actually want to use for some purpose.  Something like
>    getdelays might well fall into the latter group.  But maybe others
>    disagree?

getdelays stumped me a bit. My first choice was tools and then I noticed
that the documentation says it is a tool and an example usage of taskstruct.
I am not set on tools or samples as location for this. I can move it to
tools instead.

> 
> 2) Tools like getdelays are referenced in the documents that have been
>    left behind; see accounting/delay-accounting.txt, for example.  Those
>    documents should be updated so that readers know where to find the
>    referenced programs, wherever they end up.  Converting them to Sphinx
>    while you're at it is an extra-credit exercise :)

Right. Documents need updates and also the 00-Index files. I agree with
you that converting to Sphinx makes sense. There will be some learning
curve on my part. I can take this one once the move happens and do the
Documentation and 00-Index file updates.

thanks,
-- Shuah