Date: Mon, 15 Jun 2015 12:49:32 -0400 From: Bryan Drewery <bdrewery@FreeBSD.org> To: Steve Kargl <sgk@troutmask.apl.washington.edu>, Craig Rodrigues <rodrigc@FreeBSD.org> Cc: 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: <557F021C.1000509@FreeBSD.org> In-Reply-To: <20150614012924.GA2965@troutmask.apl.washington.edu> References: <201506100127.t5A1RdX6051959@svn.freebsd.org> <20150612204309.11dd3391@kan> <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>
next in thread | previous in thread | raw e-mail | index | archive | help
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 very >> angry. >> > > I wasn't very angry. I'm simply pointing out that the libxo > manpages, which should document what libxo is/does, are > horrible documentation. If the quality of the manpages > matches the quality of library, and the brokeness that > we have been witnesses bears this out, should be questioned. > > % 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 arguments > 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 arguments > xo_flush.3:.Nd emit formatted output based on format string and arguments > xo_open_list.3:.Nd emit formatted output based on format string and arguments > 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 arguments > xo_set_info.3:.Nd emit formatted output based on format string and arguments > xo_set_style.3:.Nd emit formatted output based on format string and arguments > xo_set_writer.3:.Nd emit formatted output based on format string and arguments > > Do you really believe that the Nd entries for these manpages are > correct? > 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. -- Regards, Bryan Drewery
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?557F021C.1000509>