Re: [RFC] Update/kill Documentation/sysctl/* docs?

From: Andrew Morton
Date: Thu May 11 2006 - 02:39:48 EST


Diego Calleja <diegocg@xxxxxxxxx> wrote:
>
> In http://bugzilla.kernel.org/show_bug.cgi?id=6145 you asked to update
> the sysctl docs. I've updated them and added/deleted the neccesary
> stuff (except the ones that I don't know what on earth are they doing
> because they're not...documented).

OK..

> However it looks like there's
> duplication - Documentation/filesystems/proc.txt seems to document all
> that aswell (but in a single doc, which makes it a bit unreadable
> for such big document, IMO)

Yes, the duplication is silly and wasteful and error-inducing.

> What should be the best step? Kill Documentation/sysctl/ and keep
> filesystems/proc.txt updated and maybe split it in several files
> to make it more readable? Update it but maintain in sync with
> filesystems/proc.txt? delete proc.txt and keep sysctl/ updated...?

I'd have thought that keeping everything in Documentation/sysctl/*.txt and
killing proc.txt would be the best approach?

But I haven't looked into it much. You have - what approach are you
recommending?
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/