Project

General

Profile

Actions

Bug #13888

closed

Some #include statements in the manual refer to nonexistent files

Added by Peter Tribble about 1 month ago. Updated about 1 month ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
manpage - manual pages
Start date:
Due date:
% Done:

100%

Estimated time:
Difficulty:
Bite-size
Tags:
Gerrit CR:

Description

Some of the manual pages have #include statements referring to files that do not exist. We should fix that. Some are simple typos, some need changing.

This is from a simple trawl through, then adding /usr/include on the front of the names we find and seeing if the file exists in the proto area.

/usr/include//sys/steam.h
./man7m/connld.7m:\fB#include </sys/steam.h>\fR
FIX I'm not sure we need the include at all - see ptem.7m, eg
/usr/include/sys/inode.h
./man4/ufsdump.4:\fB#include <sys/inode.h>\fR
FIX Doesn't need that include, or the one of sys/types.h tbh
/usr/include/tsol.h
./man3lib/libtsol.3lib:#include <tsol.h>
FIX should be <tsol/label.h>
/usr/include/sys/hid.h
./man7d/hid.7d:\fB#include <sys/hid.h>\fR
FIX should be #include <sys/usb/clients/hid/hid.h>
/usr/include/socket.h
./man7d/sdp.7d:#include <socket.h>
FIX should be sys/socket.h
/usr/include/pfmt..h
./man3c/setlabel.3c:#include <pfmt..h>
FIX should be pfmt.h
/usr/include/sys/ndifma.h
./man9f/ddi_fm_acc_err_clear.9f:#include <sys/ndifma.h>
FIX should be sys/ndifm.h
/usr/include/sys/u8_textprep
./man3c/uconv_u16tou32.3c
FIX example 3, should be u8_textprep.h

Actions #1

Updated by Peter Tribble about 1 month ago

On further examination, ddi_fm_acc_err_clear.9f should #include ddifm.h as that's where the functions are actually defined, not ndifm.h.

Actions #2

Updated by Electric Monk about 1 month ago

  • Gerrit CR set to 1556
Actions #3

Updated by Peter Tribble about 1 month ago

Tested by manually viewing using the man(1) utility.

Actions #4

Updated by Electric Monk about 1 month ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100

git commit e9a9d42d6b4da41cc01b726a4d919abc09841750

commit  e9a9d42d6b4da41cc01b726a4d919abc09841750
Author: Peter Tribble <peter.tribble@gmail.com>
Date:   2021-06-22T18:26:46.000Z

    13888 Some #include statements in the manual refer to nonexistent files
    Reviewed by: Richard Lowe <richlowe@richlowe.net>
    Reviewed by: Andy Fiddaman <andy@omnios.org>
    Approved by: Dan McDonald <danmcd@joyent.com>

Actions

Also available in: Atom PDF