Date: Thu, 3 Oct 2002 11:33:27 +0200 (CEST) From: Jens Schweikhardt <schweikh@schweikhardt.net> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/43622: Undocumented modules (missing man pages) Message-ID: <200210030933.g939XR5P044026@hal9000.schweikhardt.net>
next in thread | raw e-mail | index | archive | help
>Number: 43622
>Category: docs
>Synopsis: Undocumented modules (missing man pages)
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Thu Oct 03 02:40:03 PDT 2002
>Closed-Date:
>Last-Modified:
>Originator: Jens Schweikhardt
>Release: FreeBSD 5.0-CURRENT i386
>Organization:
Digital Details
>Environment:
System: FreeBSD hal9000.schweikhardt.net 5.0-CURRENT FreeBSD 5.0-CURRENT #0: Thu Sep 26 22:25:21 CEST 2002 toor@hal9000.schweikhardt.net:/usr/obj/src/current/sys/HAL9000 i386
>Description:
There are man pages only for 95 of 255 kernel modules in /boot/kernel.
For consistency, any module name should also have an associated man page
with info about its associated kernel option, etc.
The interface (if_*) modules for example are mostly there and only need
an additional link to their driver man page. Same goes for some of the
snd_* modules.
>How-To-Repeat:
#!/bin/sh
cd /boot/kernel
modules=`ls *.ko | sed -e 's/\.ko//'`
man -w ${modules} > /dev/null
On 5-current this prints:
No manual entry for 3dfx
No manual entry for aac_linux
No manual entry for aio
No manual entry for aout
No manual entry for apm_saver
No manual entry for arcnet
No manual entry for atspeaker
No manual entry for bktr_mem
No manual entry for blank_saver
No manual entry for cbb
No manual entry for cd9660
No manual entry for ciss
No manual entry for coda
No manual entry for daemon_saver
No manual entry for digi
No manual entry for digi_CX
No manual entry for digi_CX_PCI
No manual entry for digi_EPCX
No manual entry for digi_EPCX_PCI
No manual entry for digi_Xe
No manual entry for digi_Xem
No manual entry for digi_Xr
No manual entry for dragon_saver
No manual entry for fade_saver
No manual entry for fire_saver
No manual entry for firewire
No manual entry for fpu
No manual entry for gnufpu
No manual entry for green_saver
No manual entry for hea_pci
No manual entry for hfa
No manual entry for hfa_pci
No manual entry for ibcs2_coff
No manual entry for if_an
No manual entry for if_ar
No manual entry for if_aue
No manual entry for if_bge
No manual entry for if_cm
No manual entry for if_cue
No manual entry for if_dc
No manual entry for if_de
No manual entry for if_disc
No manual entry for if_ed
No manual entry for if_ef
No manual entry for if_el
No manual entry for if_em
No manual entry for if_ep
No manual entry for if_faith
No manual entry for if_fe
No manual entry for if_fxp
No manual entry for if_gif
No manual entry for if_gre
No manual entry for if_gx
No manual entry for if_kue
No manual entry for if_lge
No manual entry for if_lnc
No manual entry for if_nge
No manual entry for if_oltr
No manual entry for if_pcn
No manual entry for if_ppp
No manual entry for if_ray
No manual entry for if_rl
No manual entry for if_sbni
No manual entry for if_sf
No manual entry for if_sis
No manual entry for if_sk
No manual entry for if_sl
No manual entry for if_sn
No manual entry for if_sr
No manual entry for if_ste
No manual entry for if_stf
No manual entry for if_tap
No manual entry for if_ti
No manual entry for if_tl
No manual entry for if_tun
No manual entry for if_tx
No manual entry for if_txp
No manual entry for if_vlan
No manual entry for if_vr
No manual entry for if_vx
No manual entry for if_wb
No manual entry for if_wi
No manual entry for if_xe
No manual entry for if_xl
No manual entry for iir
No manual entry for ip_mroute
No manual entry for libiconv
No manual entry for libmchain
No manual entry for logo_saver
No manual entry for lomac_plm
No manual entry for mac_biba
No manual entry for mac_bsdextended
No manual entry for mac_ifoff
No manual entry for mac_mls
No manual entry for mac_none
No manual entry for mac_seeotheruids
No manual entry for mac_test
No manual entry for miibus
No manual entry for msdosfs
No manual entry for ncv
No manual entry for nfsclient
No manual entry for nfsserver
No manual entry for ng_eiface
No manual entry for ng_gif_demux
No manual entry for ng_split
No manual entry for ng_sync_ar
No manual entry for ng_sync_sr
No manual entry for nsp
No manual entry for ntfs
No manual entry for nullfs
No manual entry for pecoff
No manual entry for portalfs
No manual entry for pps
No manual entry for radeon
No manual entry for rain_saver
No manual entry for s3
No manual entry for sbp
No manual entry for scsi_low
No manual entry for sem
No manual entry for smbfs
No manual entry for snake_saver
No manual entry for snd_ad1816
No manual entry for snd_als4000
No manual entry for snd_cmi
No manual entry for snd_cs4281
No manual entry for snd_csa
No manual entry for snd_driver
No manual entry for snd_ds1
No manual entry for snd_emu10k1
No manual entry for snd_es137x
No manual entry for snd_ess
No manual entry for snd_fm801
No manual entry for snd_ich
No manual entry for snd_maestro
No manual entry for snd_maestro3
No manual entry for snd_mss
No manual entry for snd_neomagic
No manual entry for snd_pcm
No manual entry for snd_sb16
No manual entry for snd_sb8
No manual entry for snd_sbc
No manual entry for snd_solo
No manual entry for snd_t4dwave
No manual entry for snd_uaudio
No manual entry for snd_via8233
No manual entry for snd_via82c686
No manual entry for snd_vibes
No manual entry for splash_bmp
No manual entry for splash_pcx
No manual entry for star_saver
No manual entry for stg
No manual entry for syscall_gate
No manual entry for sysvmsg
No manual entry for sysvsem
No manual entry for sysvshm
No manual entry for udf
No manual entry for ufm
No manual entry for umapfs
No manual entry for unionfs
No manual entry for warp_saver
>Fix:
Write the docs or link to the respective device driver man page.
Regards,
Jens
--
Jens Schweikhardt http://www.schweikhardt.net/
SIGSIG -- signature too long (core dumped)
>Release-Note:
>Audit-Trail:
>Unformatted:
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200210030933.g939XR5P044026>