netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Ben Hutchings <bhutchings@solarflare.com>
To: Stephen Hemminger <shemminger@vyatta.com>
Cc: <netdev@vger.kernel.org>
Subject: Re: [RFC] iproute2: split up ip man page?
Date: Wed, 7 Dec 2011 21:46:38 +0000	[thread overview]
Message-ID: <1323294398.2728.38.camel@bwh-desktop> (raw)
In-Reply-To: <20111207131514.6815f813@nehalam.linuxnetplumber.net>

On Wed, 2011-12-07 at 13:15 -0800, Stephen Hemminger wrote:
> The current ip man page is both incomplete and so big that
> the actual functions get lost easily.
> 
> I propose splitting the the pages for the subfunction
> into sub pages. The man command appears
> to be smart enough to handle:
>   man tc htb

Or, for another familiar example, 'man git diff'.

Oddly enough, man(1) only describes this under the '--no-subpages'
option which turns off the behaviour.

> and pickup the manpage for /usr/share/man/man1/tc-htb.8.gz
> Why not do the same thing for ip command?
> 
> The base ip page would just be a place holder that covered the
> generic arguments.

Sounds like a very sensible change.

Ben.

-- 
Ben Hutchings, Staff Engineer, Solarflare
Not speaking for my employer; that's the marketing department's job.
They asked us to note that Solarflare product names are trademarked.

  reply	other threads:[~2011-12-07 21:46 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-12-07 21:15 [RFC] iproute2: split up ip man page? Stephen Hemminger
2011-12-07 21:46 ` Ben Hutchings [this message]
2011-12-08  9:15 ` Petr Šabata
2011-12-22 18:37 ` Stephen Hemminger
2011-12-23  0:10   ` Hagen Paul Pfeifer
2011-12-23  0:29     ` Stephen Hemminger
2011-12-23 11:57       ` Hagen Paul Pfeifer

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=1323294398.2728.38.camel@bwh-desktop \
    --to=bhutchings@solarflare.com \
    --cc=netdev@vger.kernel.org \
    --cc=shemminger@vyatta.com \
    /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).