public inbox for netdev@vger.kernel.org 
 help / color / mirror / Atom feed
From: Stephen Hemminger <shemminger@vyatta•com>
To: Stephen Hemminger <shemminger@vyatta•com>
Cc: netdev@vger•kernel.org
Subject: Re: [RFC] iproute2: split up ip man page?
Date: Thu, 22 Dec 2011 10:37:23 -0800	[thread overview]
Message-ID: <20111222103723.59a035df@nehalam.linuxnetplumber.net> (raw)
In-Reply-To: <20111207131514.6815f813@nehalam.linuxnetplumber.net>

On Wed, 7 Dec 2011 13:15:14 -0800
Stephen Hemminger <shemminger@vyatta•com> 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
> 
> 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.
> 
> 
> --
> To unsubscribe from this list: send the line "unsubscribe netdev" in
> the body of a message to majordomo@vger•kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

Ok, the ip man page is now broken up. I tried to fix some of the
incorrect grammar and usage as well. The pages still need editing for
readability.

Added a few examples as well.

Please download from the git repository and send me any comments
or changes.

   git://git.kernel.org/pub/scm/linux/kernel/git/shemminger/iproute2.git

  parent reply	other threads:[~2011-12-22 18:37 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
2011-12-08  9:15 ` Petr Šabata
2011-12-22 18:37 ` Stephen Hemminger [this message]
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=20111222103723.59a035df@nehalam.linuxnetplumber.net \
    --to=shemminger@vyatta$(echo .)com \
    --cc=netdev@vger$(echo .)kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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