Hi,

If you've used the SQLite C library, you're familiar with where their
docs live:

https://www.sqlite.org/c3ref/intro.html

If you're on OpenBSD, you started with "apropos -s3 sqlite3", were
shocked that there's nothing there, then moved on to Google with a
wounding confusion in your heart.

The reason is that SQLite's docs are generated at build time from a Tcl
script[1] that parses the sqlite.h header file and spits out HTML.  See
for yourself: the documentation blocks start with "CAPI3REF".  So why
not mdoc(7).

https://github.com/kristapsdz/sqlite2mdoc

I've talked to the SQLite folks about this[2] and floated mails by those
who'd last touched the SQLite downstream, but figure folks here would be
just as interested in the meanwhile.  (I'd modify the Tcl script, but
it's not my repertoire.)

I've been using the output for a while (into /usr/local/man/man3) and it
does all the things w/r/t apropos etc.  The mdoc(7) can be cleaned up a
bit (stray `Pp's here and there), but all in all, I can finally do
"apropos sqlite_ok".  (I note remaining nits in CAVEATS.)

Thoughts?

Best,

Kristaps

P.S., is anybody familiar with how to "watch files" in Fossil as one
can, say, do with GitHub?

[1] http://comments.gmane.org/gmane.comp.db.sqlite.general/100784
[2] https://www.sqlite.org/cgi/docsrc/finfo?name=pages/capi3ref.in

Attachment: signature.asc
Description: OpenPGP digital signature

Reply via email to