Bug 280078 - man 3 hexdump does not state -lutil
Summary: man 3 hexdump does not state -lutil
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Jessica Clarke
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-07-01 19:59 UTC by David Gilbert
Modified: 2024-11-26 00:30 UTC (History)
1 user (show)

See Also:


Attachments
patch to fix this. (326 bytes, patch)
2024-07-01 19:59 UTC, David Gilbert
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description David Gilbert 2024-07-01 19:59:43 UTC
Created attachment 251821 [details]
patch to fix this.

The manpage for hexdump does not state that -lutil is the library.  Compare, say, the man pages for 2 open or 3 abs --- they specify -lc or libc even though that is standard.  In this case, it's more incidious because I required to search the libraries with nm to find the appropriate library to include.

Now I also count 43 library man pages that do not contain the keyword LIBRARY:

[2:63:363]dgilbert@vr:~/FreeBSD/src/lib> find . -name \*.3 -o -name \*.2 | xargs -n 1 grep -L LIBRARY
./libopenbsd/ohash_init.3
./libopenbsd/imsg_init.3
./libopenbsd/ohash_interval.3
./libtacplus/libtacplus.3
./libmp/libmp.3
./libexpat/libbsdxml.3
./libefivar/efivar.3
./msun/man/ieee.3
./msun/man/cpow.3
./libradius/libradius.3
./libc/db/man/dbm.3
./libc/db/man/hash.3
./libc/db/man/btree.3
./libc/db/man/dbopen.3
./libc/db/man/mpool.3
./libc/db/man/recno.3
./libc/gen/setproctitle.3
./libc/gen/dirname.3
./libc/gen/ftw.3
./libc/gen/basename.3
./libc/gen/readpassphrase.3
./libc/net/inet6_rthdr_space.3
./libc/net/if_indextoname.3
./libc/net/getifmaddrs.3
./libc/net/getifaddrs.3
./libc/net/sourcefilter.3
./libc/net/getnameinfo.3
./libc/net/inet6_option_space.3
./libc/net/gai_strerror.3
./libc/net/inet6_rth_space.3
./libc/net/rcmdsh.3
./libc/net/getaddrinfo.3
./libc/rpc/rpc_secure.3
./libc/string/timingsafe_bcmp.3
./libc/stdlib/strtonum.3
./libc/stdlib/tsearch.3
./libc/posix1e/mac_prepare.3
./libstdbuf/libstdbuf.3
./libpathconv/abs2rel.3
./libpathconv/rel2abs.3
./libipsec/ipsec_strerror.3
./libcompat/4.3
./libssp/__builtin_object_size.3
[2:64:364]dgilbert@vr:~/FreeBSD/src/lib> find . -name \*.3 -o -name \*.2 | xargs -n 1 grep -L LIBRARY | wc
      43      43    1045
Comment 1 commit-hook freebsd_committer freebsd_triage 2024-11-21 20:24:12 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=169e23d41f8ff16244f4fb04924fdc9828325dce

commit 169e23d41f8ff16244f4fb04924fdc9828325dce
Author:     David Gilbert <dave@daveg.ca>
AuthorDate: 2024-11-21 20:23:16 +0000
Commit:     Jessica Clarke <jrtc27@FreeBSD.org>
CommitDate: 2024-11-21 20:23:16 +0000

    hexdump.3: Add missing LIBRARY section

    All the other libutil section 3 manpages document this, and although
    it's heavily implied by the libutil.h header in the synopsis, we should
    still be explicit and consistent.

    PR:             280078
    Reviewed by:    jrtc27
    MFC after:      1 week

 lib/libutil/hexdump.3 | 2 ++
 1 file changed, 2 insertions(+)