From: Phil Sutter <phil@nwl.cc>
To: Cong Wang <cwang@twopensource.com>
Cc: netdev <netdev@vger.kernel.org>, David Miller <davem@davemloft.net>
Subject: Re: [net-next PATCH] net: sched: document attach_default_qdiscs
Date: Tue, 15 Sep 2015 00:42:08 +0200 [thread overview]
Message-ID: <20150914224208.GJ30501@orbit.nwl.cc> (raw)
In-Reply-To: <CAHA+R7PATvda=EPof5mHY_CNH1OnkVnRytJPbJgZHtTkgMB9LA@mail.gmail.com>
On Mon, Sep 14, 2015 at 03:07:42PM -0700, Cong Wang wrote:
> On Mon, Sep 14, 2015 at 8:31 AM, Phil Sutter <phil@nwl.cc> wrote:
> > The process of selecting an interface's default qdisc is not really
> > intuitive, at least because there are three different cases to consider.
>
> It is a static function, not an API, so I don't think it is the right
> place to document.
So static functions should never be documented? I'm playing devil's
advocate, but still:
> Maybe update default_qdisc description in Documentation/sysctl/net.txt?
I don't think this is the right place for source code documentation. The
intended audience are users, and I wouldn't expect a developer to search
in there. On the other hand, that description would indeed benefit from
a review: Apart from omitting noqueue, it neither mentions leaf qdiscs.
I'll fix this.
Thanks, Phil
next prev parent reply other threads:[~2015-09-14 22:42 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-09-14 15:31 [net-next PATCH] net: sched: document attach_default_qdiscs Phil Sutter
2015-09-14 22:07 ` Cong Wang
2015-09-14 22:42 ` Phil Sutter [this message]
2015-09-14 22:49 ` Cong Wang
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=20150914224208.GJ30501@orbit.nwl.cc \
--to=phil@nwl.cc \
--cc=cwang@twopensource.com \
--cc=davem@davemloft.net \
--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).