lkml.org 
[lkml]   [2006]   [Jun]   [7]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: Updated sysctl documentation take #2
    On Wed, 7 Jun 2006 20:53:16 +0200 Diego Calleja wrote:

    > Since people didn't like the "many small files" approach, I've moved
    > it to directories containing index.txt files:
    >
    > Documentation/sysctl/vm/index.txt
    > Documentation/sysctl/net/core/index.txt
    > Documentation/sysctl/net/unix/index.txt
    > Documentation/sysctl/net/ipv4/index.txt
    > Documentation/sysctl/net/ipv4/conf/index.txt
    > Documentation/sysctl/net/ipv4/route/index.txt
    > Documentation/sysctl/net/ipv4/neigh/index.txt
    >
    > and so on.
    >
    > As previously, this moves all sysctl documentation (including
    > XFS and network) to Documentation/sysctl/*. The patch is
    > against linus tree and weights more than 200K in size
    > and is place at: http://www.terra.es/personal/diegocg/sysctl-docs

    ~> diffstat -p1 -w 70 sysctl-docs
    Documentation/filesystems/proc.txt | 1210 ----------------
    Documentation/filesystems/xfs.txt | 84 -
    Documentation/networking/00-INDEX | 2
    Documentation/networking/Configurable | 2
    Documentation/networking/decnet.txt | 4
    Documentation/networking/ip-sysctl.txt | 899 -----------
    Documentation/networking/xfrm_sync.txt | 11
    Documentation/sysctl/README | 121 -
    Documentation/sysctl/abi.txt | 54
    Documentation/sysctl/abi/index.txt | 49
    Documentation/sysctl/dev/README | 2
    Documentation/sysctl/fs.txt | 150 -
    Documentation/sysctl/fs/index.txt | 240 +++
    Documentation/sysctl/fs/xfs/index.txt | 170 ++
    Documentation/sysctl/kernel.txt | 344 ----
    Documentation/sysctl/kernel/index.txt | 628 ++++++++
    Documentation/sysctl/net/README | 8
    Documentation/sysctl/net/appletalk/index.txt | 38
    Documentation/sysctl/net/bridge/index.txt | 44
    Documentation/sysctl/net/core/index.txt | 115 +
    Documentation/sysctl/net/ipv4/conf/index.txt | 270 +++
    Documentation/sysctl/net/ipv4/index.txt | 739 +++++++++
    Documentation/sysctl/net/ipv4/neigh/index.txt | 138 +
    Documentation/sysctl/net/ipv4/route/index.txt | 143 +
    Documentation/sysctl/net/ipv6/conf/index.txt | 256 +++
    Documentation/sysctl/net/ipv6/icmp/index.txt | 15
    Documentation/sysctl/net/ipv6/index.txt | 65
    Documentation/sysctl/net/ipv6/neigh/index.txt | 134 +
    Documentation/sysctl/net/ipv6/route/index.txt | 78 +
    Documentation/sysctl/net/unix/index.txt | 15
    Documentation/sysctl/sunrpc.txt | 20
    Documentation/sysctl/sunrpc/index.txt | 64
    Documentation/sysctl/vm.txt | 180 --
    Documentation/sysctl/vm/index.txt | 334 ++++
    Documentation/sysrq.txt | 20
    35 files changed, 3611 insertions(+), 3035 deletions(-)
    I don't know how long it takes to review such a large patch, but
    I'll continue to do so. For now:

    README:

    1. +Documentation for /proc/sys/, aka. sysctl

    a.k.a. or just "aka". Not "aka.". or spell it out, or omit it,
    maybe like:

    Documentation for /proc/sys/ (sysctl)

    2. Limit lines to max. of 80 characters, but around 70-72 is better
    IMO. That allows someone to make minor corrections without having
    to fudge the lines around.

    3. +This means there're several parameters
    use "there are"

    4. +are: enabling or disabling forwading in a certain network interface
    forwarding

    5. +is also used to export some stadistic information, ej: some
    statistic or statistics or statistical
    ej: ?? use e.g.: (preferred) or eg:

    6. +can be read but can _not_ be written.
    _cannot_

    7. +own program to read them aswell)
    as well)

    8. +to change '/' by '.' and ignore the '/proc/sys' part of the path, ie
    s/by/to/
    s/ie/i.e./

    9. +means that any tweak that you do will be lost the next time you restart your
    * collapse 2 spaces to 1

    10. +_VERY_ DANGEROUS and can ruin the performance performance,
    drop one "performance"

    11. +As a quick 'ls /proc/sys' will show, the directory consists of several subdirs.
    +Each subdir is mainly about one part of the kernel, so you can do configuration

    Spell out "subdirectories" and "subdirectory".

    12. +fs/ specific filesystems filehandle, inode, dentry and quota tuning

    insert ":" after "filesystems"


    OK, that's all for the README file. I'll look at the rest of it
    sometime this week. I don't think that it's quite ready to be merged.

    ---
    ~Randy
    -
    To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
    the body of a message to majordomo@vger.kernel.org
    More majordomo info at http://vger.kernel.org/majordomo-info.html
    Please read the FAQ at http://www.tux.org/lkml/

    \
     
     \ /
      Last update: 2006-06-07 22:06    [W:0.024 / U:62.108 seconds]
    ©2003-2016 Jasper Spaans. hosted at Digital OceanAdvertise on this site