From: Ingo Schwarze <schwarze@usta.de>
To: tech@mdocml.bsd.lv
Subject: keep the traditional database name
Date: Sun, 25 Dec 2011 16:49:11 +0100 [thread overview]
Message-ID: <20111225154911.GC26176@iris.usta.de> (raw)
Hi,
we are coming close to enabling mandocdb(8) and the new apropos(1)
in OpenBSD, so now is a good time to switch back to the traditional
names. (When Theo asked why we want to invent a new name,
i couldn't come up with any good reason. File formats get changed
all the time without inventing new nomenclature.)
OK?
Ingo
Index: apropos.1
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/apropos.1,v
retrieving revision 1.14
diff -u -p -r1.14 apropos.1
--- apropos.1 24 Dec 2011 22:37:16 -0000 1.14
+++ apropos.1 25 Dec 2011 15:27:26 -0000
@@ -258,11 +258,11 @@ If none of these conditions are met, it
.El
.Sh FILES
.Bl -tag -width "/etc/man.conf" -compact
-.It Pa mandoc.db
+.It Pa whatis.db
name of the
.Xr mandocdb 8
keyword database
-.It Pa mandoc.index
+.It Pa whatis.index
name of the
.Xr mandocdb 8
filename database
Index: mandocdb.8
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mandocdb.8,v
retrieving revision 1.15
diff -u -p -r1.15 mandocdb.8
--- mandocdb.8 25 Dec 2011 13:08:12 -0000 1.15
+++ mandocdb.8 25 Dec 2011 15:27:26 -0000
@@ -119,7 +119,7 @@ is printed to stderr, omitted from the i
with the next input file.
.Ss Index Database
The index database,
-.Pa mandoc.index ,
+.Pa whatis.index ,
is a
.Xr recno 3
database with record values consisting of
@@ -155,7 +155,7 @@ Each of the above is NUL-terminated.
If the record value is zero-length, it is unassigned.
.Ss Keyword Database
The keyword database,
-.Pa mandoc.db ,
+.Pa whatis.db ,
is a
.Xr btree 3
database of NUL-terminated keywords (record length is non-zero string
@@ -221,12 +221,12 @@ or
respectively, grows as a multiple of the index length and input size.
.Sh FILES
.Bl -tag -width Ds
-.It Pa mandoc.db
+.It Pa whatis.db
A
.Xr btree 3
keyword database mapping keywords to a type and file reference in
-.Pa mandoc.index .
-.It Pa mandoc.index
+.Pa whatis.index .
+.It Pa whatis.index
A
.Xr recno 3
database of indexed file-names.
Index: mandocdb.c
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mandocdb.c,v
retrieving revision 1.39
diff -u -p -r1.39 mandocdb.c
--- mandocdb.c 25 Dec 2011 14:58:39 -0000 1.39
+++ mandocdb.c 25 Dec 2011 15:27:27 -0000
@@ -1538,7 +1538,7 @@ ofile_argbuild(int argc, char *argv[], s
* Recursively build up a list of files to parse.
* We use this instead of ftw() and so on because I don't want global
* variables hanging around.
- * This ignores the mandoc.db and mandoc.index files, but assumes that
+ * This ignores the whatis.db and whatis.index files, but assumes that
* everything else is a manual.
* Pass in a pointer to a NULL structure for the first invocation.
*/
Index: mandocdb.h
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mandocdb.h,v
retrieving revision 1.4
diff -u -p -r1.4 mandocdb.h
--- mandocdb.h 25 Dec 2011 14:58:39 -0000 1.4
+++ mandocdb.h 25 Dec 2011 15:27:27 -0000
@@ -17,8 +17,8 @@
#ifndef MANDOCDB_H
#define MANDOCDB_H
-#define MANDOC_DB "mandoc.db"
-#define MANDOC_IDX "mandoc.index"
+#define MANDOC_DB "whatis.db"
+#define MANDOC_IDX "whatis.index"
#define TYPE_An 0x0000000000000001ULL
#define TYPE_Ar 0x0000000000000002ULL
Index: whatis.1
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/whatis.1,v
retrieving revision 1.5
diff -u -p -r1.5 whatis.1
--- whatis.1 24 Dec 2011 22:37:16 -0000 1.5
+++ whatis.1 25 Dec 2011 15:27:27 -0000
@@ -130,11 +130,11 @@ If none of these conditions are met, it
.El
.Sh FILES
.Bl -tag -width "/etc/man.conf" -compact
-.It Pa mandoc.db
+.It Pa whatis.db
name of the
.Xr mandocdb 8
keyword database
-.It Pa mandoc.index
+.It Pa whatis.index
name of the
.Xr mandocdb 8
filename database
--
To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv
next reply other threads:[~2011-12-25 15:49 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-12-25 15:49 Ingo Schwarze [this message]
2011-12-25 16:29 ` Kristaps Dzonsons
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=20111225154911.GC26176@iris.usta.de \
--to=schwarze@usta.de \
--cc=tech@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).