From: schwarze@mdocml.bsd.lv
To: source@mdocml.bsd.lv
Subject: mdocml: Update the whatis.db database format.
Date: Sun, 25 Dec 2011 16:00:23 -0500 (EST) [thread overview]
Message-ID: <201112252100.pBPL0Npr010682@krisdoz.my.domain> (raw)
Log Message:
-----------
Update the whatis.db database format.
While here, reference apropos(1) from the description,
inspired by the makewhatis(8) manual.
Modified Files:
--------------
mdocml:
mandocdb.8
Revision Data
-------------
Index: mandocdb.8
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mandocdb.8,v
retrieving revision 1.16
retrieving revision 1.17
diff -Lmandocdb.8 -Lmandocdb.8 -u -p -r1.16 -r1.17
--- mandocdb.8
+++ mandocdb.8
@@ -46,7 +46,13 @@ manuals and indexes them in a
.Sx Keyword Database
and
.Sx Index Database
-for fast retrieval.
+for fast retrieval by
+.Xr apropos 1 ,
+.Xr whatis 1 ,
+and
+.Xr man 1 Ns 's
+.Fl k
+option.
.Pp
By default,
.Nm
@@ -159,10 +165,11 @@ The keyword database,
is a
.Xr btree 3
database of NUL-terminated keywords (record length is non-zero string
-length plus one) mapping to a 12-byte binary field consisting of the
-64-bit keyword type and 32-bit source
+length plus one) mapping to a 16-byte binary field consisting of the
+64-bit keyword type and the 64-bit
.Sx Index Database
record number, both in network-byte order.
+.Pp
The type bit-mask consists of the following
values mapping into
.Xr mdoc 7
@@ -208,9 +215,6 @@ macro identifiers:
.It Li 0x0000001000000000ULL Ta \&Vt
.It Li 0x0000002000000000ULL Ta \&Xr
.El
-.Pp
-The last four bytes are a host-ordered record number within the
-.Sx Index Database .
.Sh IMPLEMENTATION NOTES
The time to construct a new database pair grows linearly with the
number of keywords in the input files.
@@ -252,7 +256,7 @@ error accessing input files.
Such errors cause
.Nm
to exit at once, possibly in the middle of parsing or formatting a file.
-The output databases are corrupt and should be removed .
+The output databases are corrupt and should be removed.
.El
.Sh DIAGNOSTICS
If the following errors occur, the
--
To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv
reply other threads:[~2011-12-25 21:00 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=201112252100.pBPL0Npr010682@krisdoz.my.domain \
--to=schwarze@mdocml.bsd.lv \
--cc=source@mdocml.bsd.lv \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).