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

From: Jonathan Corbet
Date: Mon Sep 19 2016 - 12:02:27 EST

On Mon, 19 Sep 2016 08:47:32 -0600
Shuah Khan <shuahkh@xxxxxxxxxxxxxxx> 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

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