netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Hannes Frederic Sowa <hannes@stressinduktion.org>
To: netdev@vger.kernel.org
Subject: critic on documentation of the network stack
Date: Fri, 24 Jan 2014 04:23:24 +0100	[thread overview]
Message-ID: <20140124032324.GO7269@order.stressinduktion.org> (raw)

Hello!

After net-next is closed I wanted to put the following link here:

  <http://linux.slashdot.org/comments.pl?sid=4356053&cid=45184693>

I don't want to start a flamefest or come too close to someone but I
fear some of the critic is reasonable.  Maybe we can do better (I have
to admit, I also hate writing documentation, e.g. have not yet send the
IP_PMTUDISC_INTERFACE man-page patches).

I try to start with some constructive discussion:

There are some great features in the network stack that some people miss
because of lack documentation. One possible solution is documentation
directly in the kernel, but mostly this is just written as a reference
and the real wonderful stuff is only achieved by putting lots of those
features correclty together.

Maybe this is the second or third time this was proposed but I'll try
again: Would it make sense to just start slow and setup a wiki where we
just throw in the various snippets we use for testing while developing
patches, maybe with a bit of background information? This may well attract
interested people outside of netdev@ which could start helping cleaning
up the wiki or add more useful documentation on their own. We could
check from time to time what could be fed back into Documentation/? The
reason why I would definitely help to improve the wiki is because I
am sure I can learn from other setups and testing methodologies, too,
and definitely still have not yet seen everything what is possible with
the linux network stack.

Thanks && Hopes for a constructive dicussion,

  Hannes

             reply	other threads:[~2014-01-24  3:23 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-01-24  3:23 Hannes Frederic Sowa [this message]
2014-01-24 23:44 ` critic on documentation of the network stack Richard Weinberger
2014-01-24 23:58 ` Stephen Hemminger
2014-01-26  3:18   ` Florian Fainelli
2014-01-26 10:35     ` Richard Weinberger
2014-01-26 21:33 ` Arkadiusz Miskiewicz
2014-01-27  0:38 ` Ben Hutchings

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=20140124032324.GO7269@order.stressinduktion.org \
    --to=hannes@stressinduktion.org \
    --cc=netdev@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;
as well as URLs for NNTP newsgroup(s).