On Mon, May 25, 2009 at 11:16:19PM +0200, Andreas Henriksson wrote:
> Hello Josip!
>
> Thanks for filing the documentation bugs and updating some more with
> renewed information. Having the outstanding issues listed is a good
> first step for anyone who's motivated to have a go at fixing them
> instead of blindly/randomly looking for outdated manpages.
>
> The manpages is a well known weak area of iproute. It would be very very
> useful if someone was willing to take on this issue. I expect it to be a
> pretty big one, because not only is there a massive work to do getting
> the existing manpages up to date - it also needs to be an ongoing work
> keeping them up to date since upstream changes happen frequently adding
> new features and there's no established workflow that requires doc
> updates with code changes. On top of this the documentation system has
> fallen apart and there are some original sources that generate docs, but
> the generated docs has been manually updated and some parts are just
> manually written. A completely new grip on the entire situation would
> probably be best to get a new and maintainable documentation system in
> place, but that's just my very personal opinion..... Talking about
> personal stuff, I don't think I will personally be able to tackle this,
> since fixing code bugs is enough work for me already. Help would be
> greatly appreciated!
>
> So I'll finish off this mail with a classic comment:
>
> On m??n, 2009-05-25 at 22:17 +0200, Josip Rodin wrote:
> [...]
> > Just making these two consistent would be an improvement :)
> [...]
>
> Patches accepted!
>
> ;)
>
> (I'll offer to forward them upstream for anyone willing to contribute
> them.)
It would be best if the upstream package would establish a system where all
options are extracted automatically from the help screens (or vice versa),
that way the manual pages would really start to serve their purpose - being
reference manuals, at least by listing the entire functionality. Obviously
we'd still need someone to actually explain anything, but it would be a step
in the right direction. This would also be a coding task, unrelated to any
possible dislike of writing documentation :) Please relay these wishes to
the upstream coders.
--
2. That which causes joy or happiness.
--
To UNSUBSCRIBE, email to [email protected]
with a subject of "unsubscribe". Trouble? Contact [email protected]
