* mdocml: Make sure makewhatis.1 is documenting the correct bit-fields.
@ 2011-06-21 13:09 kristaps
0 siblings, 0 replies; only message in thread
From: kristaps @ 2011-06-21 13:09 UTC (permalink / raw)
To: source
Log Message:
-----------
Make sure makewhatis.1 is documenting the correct bit-fields.
Modified Files:
--------------
mdocml:
makewhatis.1
Revision Data
-------------
Index: makewhatis.1
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/makewhatis.1,v
retrieving revision 1.3
retrieving revision 1.4
diff -Lmakewhatis.1 -Lmakewhatis.1 -u -p -r1.3 -r1.4
--- makewhatis.1
+++ makewhatis.1
@@ -87,32 +87,29 @@ length plus one) mapping to a 8-byte bin
keyword type and source
.Sx Index Database
record number.
-The type, an unsigned 32-bit integer in host order, is one of the
-following:
+The type, a 32-bit bit-mask in host order, consists of the following
+fields:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Li 0x01
The name of a manual page as given in the NAME section.
.It Li 0x02
A function prototype name as given in the SYNOPSIS section.
-.It Li 0x03
-A utility name as given in the SYNOPSIS section.
.It Li 0x04
+A utility name as given in the SYNOPSIS section.
+.It Li 0x08
An include file as given in the SYNOPSIS section.
-.It Li 0x05
+.It Li 0x10
A variable name as given in the SYNOPSIS section.
-.It Li 0x06
+.It Li 0x20
A standard as given in the STANDARDS section.
-.It Li 0x07
+.It Li 0x40
An author as given in the AUTHORS section.
-.It Li 0x08
+.It Li 0x80
A configuration as given in the SYNOPSIS section.
.El
.Pp
-If a value is encountered outside of this range, the database is
-corrupt.
-.Pp
-The latter four bytes are a host-ordered record number within the
+The last four bytes are a host-ordered record number within the
.Sx Index Database .
.Pp
The
--
To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2011-06-21 13:09 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2011-06-21 13:09 mdocml: Make sure makewhatis.1 is documenting the correct bit-fields kristaps
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).