tdb2: update documentation
[ccan] / ccan / tdb2 / _info
index 66d3cb8bacf139100e5ef2b40b37ca094fa22161..53dd1ce2d53baacf39e8764c97a5d0bf95ec6ff4 100644 (file)
  *     #include <err.h>
  *     #include <stdio.h>
  *     
- *     static void usage(void)
+ *     static void usage(const char *argv0)
  *     {
  *             errx(1, "Usage: %s fetch <dbfile> <key>\n"
- *                  "OR %s store <dbfile> <key> <data>");
+ *                  "OR %s store <dbfile> <key> <data>", argv0, argv0);
  *     }
  *     
  *     int main(int argc, char *argv[])
  *             TDB_DATA key, value;
  *     
  *             if (argc < 4)
- *                     usage();
+ *                     usage(argv[0]);
  *     
- *             tdb = tdb_open(argv[2], 1024, TDB_DEFAULT, O_CREAT|O_RDWR,
- *                             0600);
+ *             tdb = tdb_open(argv[2], TDB_DEFAULT, O_CREAT|O_RDWR,0600, NULL);
  *             if (!tdb)
  *                     err(1, "Opening %s", argv[2]);
  *     
@@ -38,7 +37,7 @@
  *     
  *             if (streq(argv[1], "fetch")) {
  *                     if (argc != 4)
- *                             usage();
+ *                             usage(argv[0]);
  *                     value = tdb_fetch(tdb, key);
  *                     if (!value.dptr)
  *                             errx(1, "fetch %s: %s",
  *                     free(value.dptr);
  *             } else if (streq(argv[1], "store")) {
  *                     if (argc != 5)
- *                             usage();
+ *                             usage(argv[0]);
  *                     value.dptr = (void *)argv[4];
  *                     value.dsize = strlen(argv[4]);
  *                     if (tdb_store(tdb, key, value, 0) != 0)
  *                             errx(1, "store %s: %s",
  *                                  argv[3], tdb_errorstr(tdb));
  *             } else
- *                     usage();
+ *                     usage(argv[0]);
  *     
  *             return 0;
  *     }
  *
  * Author: Rusty Russell
  *
- * Licence: LGPLv3 (or later)
+ * License: LGPLv3 (or later)
  *
- * Fails:
- *     valgrind-tests // hash needs --partial-loads-ok=yes.
+ * Ccanlint:
+ *     // hash fails because it accesses data in 4 byte quantities for speed.
+ *     valgrind-tests --partial-loads-ok=yes
  */
 int main(int argc, char *argv[])
 {
@@ -79,6 +79,7 @@ int main(int argc, char *argv[])
                printf("ccan/asearch\n");
                printf("ccan/compiler\n");
                printf("ccan/build_assert\n");
+               printf("ccan/ilog\n");
                printf("ccan/tally\n");
                return 0;
        }