From: "Peter Teoh" <htmldeveloper@gmail.com>
To: LKML <linux-kernel@vger.kernel.org>
Subject: Documentation about sysfs/procfs entries (resent due to errors)
Date: Tue, 12 Feb 2008 15:31:24 +0800 [thread overview]
Message-ID: <804dabb00802112331l60492cb4i66781a9f09d5f6c6@mail.gmail.com> (raw)
I was looking for documentation on the kstack_depth_to_print under
/proc/sys/kernel, and I found it in Documentation/sysctl.txt (written
by Rik).
How about /proc/sys/net? or all other directories under /sys or /proc fs?
Wouldn't it be useful to have a centralized store located in
Documentation - properly structured, just a one-liner or two - on the
reasons and explanations for each of these /proc or /sys parameters?
And something to look for further details?
Something of the following:
|-- netfilter
| |-- nf_conntrack_buckets:your explanation here
| |-- nf_conntrack_checksum:your explanation here...
| |-- nf_conntrack_count
| |-- nf_conntrack_expect_max
| |-- nf_conntrack_generic_timeout
| |-- nf_conntrack_icmp_timeout
| |-- nf_conntrack_log_invalid
| |-- nf_conntrack_max
| |-- nf_conntrack_tcp_be_liberal
| |-- nf_conntrack_tcp_loose
| |-- nf_conntrack_tcp_max_retrans
| |-- nf_conntrack_tcp_timeout_close
| |-- nf_conntrack_tcp_timeout_close_wait
| |-- nf_conntrack_tcp_timeout_established
| |-- nf_conntrack_tcp_timeout_fin_wait
| |-- nf_conntrack_tcp_timeout_last_ack
| |-- nf_conntrack_tcp_timeout_max_retrans
| |-- nf_conntrack_tcp_timeout_syn_recv
| |-- nf_conntrack_tcp_timeout_syn_sent
| |-- nf_conntrack_tcp_timeout_time_wait
| |-- nf_conntrack_udp_timeout
| `-- nf_conntrack_udp_timeout_stream
|-- nf_conntrack_max
|-- token-ring
| `-- rif_timeout
`-- unix
`-- max_dgram_qlen
Alternatively, we can write a script to extract out the partial
explanations/details from existing source code, based on some coding
convention/style structure, and further hand-modification from there.
(given the dynamic nature of the kernel code, this may be preferred?)
reply other threads:[~2008-02-12 7:31 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=804dabb00802112331l60492cb4i66781a9f09d5f6c6@mail.gmail.com \
--to=htmldeveloper@gmail.com \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®