Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 17 Jun 2015 12:28:33 -0700
From:      hiren panchasara <hiren@strugglingcoder.info>
To:        Bryan Drewery <bdrewery@FreeBSD.org>
Cc:        Steve Kargl <sgk@troutmask.apl.washington.edu>, Craig Rodrigues <rodrigc@FreeBSD.org>, Marcel Moolenaar <marcel@xcllnt.net>, Marcel Moolenaar <marcel@freebsd.org>, "src-committers@freebsd.org" <src-committers@freebsd.org>, "svn-src-all@freebsd.org" <svn-src-all@freebsd.org>, "svn-src-head@freebsd.org" <svn-src-head@freebsd.org>
Subject:   Re: svn commit: r284198 - head/bin/ls
Message-ID:  <20150617192833.GD53336@strugglingcoder.info>
In-Reply-To: <557F021C.1000509@FreeBSD.org>
References:  <20150613024916.GA98218@troutmask.apl.washington.edu> <1434208622.1415.57.camel@freebsd.org> <C88CB169-12FE-4692-92AA-5C7D41BB61DF@FreeBSD.org> <557C661F.8080104@freebsd.org> <860017ED-D754-450C-865D-2D81A30C2212@xcllnt.net> <CAG=rPVd93Q18aYnSGSf_QH4C08RCq5wsdKQSNYTgWQ2huTbUHQ@mail.gmail.com> <20150614002640.GA2746@troutmask.apl.washington.edu> <CAG=rPVfrM9SnqRU-g=L6Y39GM2yEd%2Bt6=UFhggauu0s3HJvpYw@mail.gmail.com> <20150614012924.GA2965@troutmask.apl.washington.edu> <557F021C.1000509@FreeBSD.org>

next in thread | previous in thread | raw e-mail | index | archive | help

--Xm/fll+QQv+hsKip
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On 06/15/15 at 12:49P, Bryan Drewery wrote:
> On 6/13/15 9:29 PM, Steve Kargl wrote:
> > On Sat, Jun 13, 2015 at 05:40:59PM -0700, Craig Rodrigues wrote:
> >> On Sat, Jun 13, 2015 at 5:26 PM, Steve Kargl <
> >> sgk@troutmask.apl.washington.edu> wrote:
> >>>
> >>> Given the horrid state of the manpages, which I showed
> >>> in March, one can only wonder about the internals of
> >>> the libxo itself.
> >>>
> >>
> >> Are you talking about this comment you made?
> >> https://lists.freebsd.org/pipermail/freebsd-current/2015-March/054899.=
html
> >>
> >> I can't make heads or tails of what you wrote, other than you seemed v=
ery
> >> angry.
> >>
> >=20
> > I wasn't very angry.  I'm simply pointing out that the libxo
> > manpages, which should document what libxo is/does, are=20
> > horrible documentation.  If the quality of the manpages=20
> > matches the quality of library, and the brokeness that
> > we have been witnesses bears this out, should be questioned.
> >=20
> > % cd src/contrib/libxo/libxo
> > % grep Nd *.3 | grep formatted
> > xo_attr.3:.Nd emit formatted output based on format string and arguments
> > xo_create.3:.Nd emit formatted output based on format string and argume=
nts
> > xo_emit.3:.Nd emit formatted output based on format string and arguments
> > xo_finish.3:.Nd emit formatted output based on format string and argume=
nts
> > xo_flush.3:.Nd emit formatted output based on format string and argumen=
ts
> > xo_open_list.3:.Nd emit formatted output based on format string and arg=
uments
> > xo_set_allocator.3:.Nd emit formatted output based on format string and=
 arguments
> > xo_set_flags.3:.Nd emit formatted output based on format string and arg=
uments
> > xo_set_info.3:.Nd emit formatted output based on format string and argu=
ments
> > xo_set_style.3:.Nd emit formatted output based on format string and arg=
uments
> > xo_set_writer.3:.Nd emit formatted output based on format string and ar=
guments
> >=20
> > Do you really believe that the Nd entries for these manpages are
> > correct?
> >=20
>=20
> I also found that from simple 'man ls' (etc) there is no real mention of
> what --libxo even is or how it works. Following the manpage
> cross-references leads me to have to go to a webpage to see what params
> --libxo even takes. The --libxo flag needs much more documentation in
> these manpages.

Sorry if I've missed it but has any of the libxo proponents signed up to
fix the documentation part?

Cheers,
Hiren

--Xm/fll+QQv+hsKip
Content-Type: application/pgp-signature

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.22 (FreeBSD)

iQF8BAEBCgBmBQJVgcphXxSAAAAAAC4AKGlzc3Vlci1mcHJAbm90YXRpb25zLm9w
ZW5wZ3AuZmlmdGhob3JzZW1hbi5uZXRBNEUyMEZBMUQ4Nzg4RjNGMTdFNjZGMDI4
QjkyNTBFMTU2M0VERkU1AAoJEIuSUOFWPt/lasgH+wUOUpXpAl3fQ+aVsCblnRKv
O2fjyIhDhwbn3QF3yaOdsLYoPV+Ce6VwQVoQzyToCv0q/6eMaXK3QTx8YMwKrOYr
V55kSfACBtxkAxgcvBavT/kBKwDjbdJyWdjmxFHSJB0xIPSdsG4nb8EwZ9J7uetW
IkE56ntZWW8gRSF+i54lGkKv8YfCi/l5oxatrmcTMQ1RVE+eJQG3rbk7R54Y4QqY
iyDaVeXYyQse0ylnoIYa0yGiMwWtEX4MD30QzSjCXYzCCFLRl+MHY/5ysncvVJBQ
YLoAescQPVyAjhXYeWspNqRGxMWvcLBu0IGAZ/WNv0UytQ6lGjqQFc1VzFkUxyM=
=D9Lq
-----END PGP SIGNATURE-----

--Xm/fll+QQv+hsKip--



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20150617192833.GD53336>