> The _README is a more verbose tutorial covering building the driver > and various use-cases and special considerations, leaving syntax > reference docs to the _table(5) document.
Should I create the html version in proto directory? or the text version in the README_FILES directory? or both? Regards Hamid Maadani June 27, 2022 6:12 PM, "Viktor Dukhovni" <postfix-us...@dukhovni.org> wrote: > On Tue, Jun 28, 2022 at 01:03:43AM +0000, Hamid Maadani wrote: > >> - Are all the table features documented in mongodb_table(5)? >> >> They are. > > The _table(5) doc concisely covers all table syntax features. > >> - Is there a MONGODB_README that covers building the driver and >> tutorial prose with usage examples, best-practices, and so on? >> >> There was one, but Wietse asked for a mongodb_table so he can generate the >> MONGODB_README off of >> that in response to my very first email. I removed the README I created, but >> I can put that back in >> if need be. This is what I used to build the module: >> make makefiles pie=yes shared=yes dynamicmaps=yes 'CCARGS=-DHAS_MONGODB >> -I/usr/include/libmongoc-1.0 -I/usr/include/libbson-1.0' >> 'AUXLIBS_MONGODB=-lmongoc-1.0 -lbson-1.0' >> obviously requires mongo-c-driver and mongo-c-driver-dev packages. > > The _README is a more verbose tutorial covering building the driver > and various use-cases and special considerations, leaving syntax > reference docs to the _table(5) document. > >> - Have you tested the key features? >> >> I have built and tested the module on Alpine-3.16 inside a container, >> using a MongoDB Atlas cluster for the backend database. Tried to cover >> as many scenarios as I could, but as always, single-person testing has >> limited reliability. Would be best if we had others test this as well. > > Thanks. I think the major hurdles have been mostly cleared. I would > encourage you to draft an initial _README that is similar in spirit > to those for PostgreSQL and/or LDAP. > > After that, Wietse and I will have to find some time for code review. > This may take a bit of time, but should ideally happen in time for > 3.8.0, and so naturally would need to be complete a few snapshots > earlier. > > -- > Viktor.
