bsd.kmod.mk and manual pages.

[Simon L. Nielsen]

On 2003.08.26 19:47:34 +0200, Pawel Jakub Dawidek wrote:
> On Tue, Aug 26, 2003 at 06:02:02PM +0200, Simon L. Nielsen wrote:
> +> Normally in FreeBSD all the kernel manual pages are located under
> +> src/share/man/man?/ .  I assume the reason you want to include the
> +> manual page with the module, is because it's a 3rd party module which
> +> are not being distriubted as part of FreeBSD?
> 
> Yes, but in base system are also modules that screams for this
> functionality:)
> Here is the list of Makefiles for modules that use variable 'NOMAN':
[CUT]

Well, I have a feeling that it's not that lack of build intrastructure
that keeps peple from writing manual pages for those devices.  In any
case that shouldn't stop people :-).

> And those use 'MAN4' variable:
> 
> 	/sys/modules/netgraph/bluetooth/bluetooth/Makefile
> 	/sys/modules/netgraph/bluetooth/bt3c/Makefile
> 	/sys/modules/netgraph/bluetooth/h4/Makefile
> 	/sys/modules/netgraph/bluetooth/hci/Makefile
> 	/sys/modules/netgraph/bluetooth/l2cap/Makefile
> 	/sys/modules/netgraph/bluetooth/socket/Makefile
> 	/sys/modules/netgraph/bluetooth/ubt/Makefile
> 	/sys/modules/netgraph/bluetooth/ubtbcmfw/Makefile

Hmm... Bluetooth was developed outside the FreeBSD tree, so it might
just be there because the author didn't now how to handle the manual
pages...  I just did a quick check and I couldn't find the actual files
for the manual pages anywhere.

I think an important reason that the manual pages aren't in the sys/
part of the tree, is that they need to be build by the buildworld stage,
not buildkernel.  If the manual pages were located under sys/ it would
give problems determining when to build/install them.

Not that any of this helps you :-).  You could look into how some of the
third party kernel modules that are in ports are handled.

-- 
Simon L. Nielsen
FreeBSD Documentation Team
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20030827/ff32c986/attachment.sig>