progress report – what has been addressed

Last updated: 15JAN2024

Objective

To address the manual page anomalies identified in FreeBSD 14.0

Scope

Focus on resolving manual page anomalies, in base install FreeBSD 14, such as:

1. Dead links
2. Typographical errors in links

Focus of this initiative stems from this bug: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=108980

Progress Report – By Category

The below items have been addressed, as defined by References #2 and are considered ready for submission to the FreeBSD project.c

commented out references

Total fixed items:15 of 15

[# DONE] des(1)  des_setparity.3.gz des_crypt.3.gz cbc_crypt.3.gz ecb_crypt.3.gz
[# DONE] ethermib(4)  ifmib.4.gz
[# DONE] format(8)  intro.8.gz disktab.5.gz
[# DONE] fslsata(4)  scsi.4.gz scbus.4.gz cam.4.gz CAM.4.gz SCSI.4.gz
[# DONE] htprr(4)  scsi.4.gz scbus.4.gz cam.4.gz CAM.4.gz SCSI.4.gz
[# DONE] ipc(2)  semget.2.gz
[# DONE] mecia(4)  pccard.4.gz
[# DONE] mmcnull(4)  scsi.4.gz scbus.4.gz cam.4.gz CAM.4.gz SCSI.4.gz
[# DONE] monitor(3)  gprof.1.gz
[# DONE] ns(4)  lo.4.gz loop.4.gz if_disc.4.gz disc.4.gz
[# DONE] osc(4)  scsi.4.gz scbus.4.gz cam.4.gz CAM.4.gz SCSI.4.gz
[# DONE] pcpu(9)  vimage.9.gz vnet.9.gz
[# DONE] ps3cdrom(4)  scsi.4.gz scbus.4.gz cam.4.gz CAM.4.gz SCSI.4.gz
[# DONE] tcic(4)  pccard.4.gz
[# DONE] ugensa(4)  ucom.4.gz

old links – historical reference

Total fixed items: 21 of 21

+ DONE] dumpdir(8)  rrestore.8.gz restore.8.gz
[+ DONE] jedec_ts(4)  jedec_dimm.4.gz
[+ DONE] mkpasswd(8)  pwd_mkdb.8.gz
[+ DONE] ncr(4)  sym.4.gz
[+ DONE] newtzset(3)  tzfile.5.gz
[+ DONE] numa_getaffinity(2)  numa.4.gz
[+ DONE] numa_setaffinity(2)  numa.4.gz
[+ DONE] numactl(1)  numa.4.gz
[+ DONE] pc(1)  gprof.1.gz stab.5.gz
[+ DONE] perl(1)  makewhatis.8.gz
[+ DONE] pkg_add(1)  pkg.7.gz if_upgt.4.gz upgt.4.gz
[+ DONE] pkg_create(1)  pkg.7.gz
[+ DONE] pkg_info(1)  pkg.7.gz
[+ DONE] scsi(3)  camcontrol.8.gz csio_build_visit.3.gz buff_decode_visit.3.gz cam_cdbparse.3.gz buff_encode_visit.3.gz csio_encode.3.gz csio_encode_visit.3.gz csio_build.3.gz csio_decode.3.gz csio_decode_visit.3.gz buff_decode.3.gz
[+ DONE] scsi(8)  camcontrol.8.gz
[+ DONE] spl(9)  locking.9.gz
[+ DONE] st(4)  mt.1.gz
[+ DONE] svc.conf(5)  nsswitch.conf.5.gz nsdispatch.3.gz
[+ DONE] sysinstall(8)  sade.8.gz
[+ DONE] umt(4)  hms.4.gz

misaligned category -> 1

Total itmes fixed: 3 of 3

[1 DONE] bsnmpd(8)  snmp_hostres.3.gz
[1 DONE] gprof(8)  src-env.conf.5.gz src.conf.5.gz
[1 DONE] ld-elf.so.1(8)  sigfastblock.2.gz

misaligned category -> 2

Total items fixed: 2 of 6

[2 DONE] modfind(3) SYSCALL_MODULE.9.gz
[2 DONE] modstat(3) SYSCALL_MODULE.9.gz

misaligned category -> 8

Total items fixed: 10 of 17

[8 DONE] boot(9) vfs_unmountall.9.gz
[8 DONE] fdformat(1) fdwrite.1.gz newfs.8.gz
[8 DONE] geom(2) disk.4.gz
[8 DONE] init(1) ptrace.2.gz
[8 DONE] iostat(1) zpool.8.gz zpool-iostat.8.gz
[8 DONE] mixer(3) beep.1.gz
[8 DONE] mount(1) lindebugfs.5.gz
[8 DONE] newsyslog(1) daemon.8.gz
[8 DONE] zdb(1) ztest.1.gz
[8 DONE] zfs(1) ztest.1.gz gvirstor.8.gz

typographical errors

Total items fixed: 2 of 2

[t DONE] boot0(8) gpart.8.gz
[t DONE] ntp\-keygen(1) ntp.conf.5.gz

case-sensitivity updates

Total items fixed: 8 of 8[c DONE] ELF(3) elf.3.gz
[c DONE] NUMA(4) ifconfig.8.gz mlx5en.4.gz mce.4.gz
[c DONE] Newfs(8) dumpfs.8.gz
[c DONE] Sendmail(8) vacation.1.gz
[c DONE] Sysctl(8) ads1014.4.gz ads111x.4.gz ads1015.4.gz ads1113.4.gz ads1013.4.gz ads1115.4.gz ads1114.4.gz
[c DONE] UEFI(8) sc.4.gz syscons.4.gz
[c DONE] ZFS(8) gvinum.8.gz
[c DONE] mii(4) miibus.4.gz

operating system specific – transition to .eo .sy .ec

Total items fixed: 1 of 20
[o DONE] getxattr(2)  zfsprops.7.gz

no issues – false positive

Total items fixed: 2 of 2

[g DONE] foobar(1)  mdoc.7.gz
[g DONE] ksh(1)  make.conf.5.gz

hardware specific – transition to .eo .sy .ec

Total items fixed: 2 of 2

[h DONE] snd_ai2s(4)  pcm.4.gz sound.4.gz snd.4.gz
[h DONE] snd_davbus(4)  pcm.4.gz sound.4.gz snd.4.gz

References

1. FreeBSD Documentation Project Primer (Chapter 11) – guiding principal for how manual pages should be constructed
2. Category of Manual Page Anomalies – blog post that has categorized the list of anomalies in FreeBSD 14.0