diff options
author | wrowe <wrowe@13f79535-47bb-0310-9956-ffa450edef68> | 2008-11-21 06:20:53 +0000 |
---|---|---|
committer | wrowe <wrowe@13f79535-47bb-0310-9956-ffa450edef68> | 2008-11-21 06:20:53 +0000 |
commit | 59de1c77fd12a802d736292fa58cba72e2219db4 (patch) | |
tree | 51386d0b8b84a335d62a45f8569649728cec122a | |
parent | 373bad052a400457d0b199f0c06bfda00e750913 (diff) | |
download | libapr-util-59de1c77fd12a802d736292fa58cba72e2219db4.tar.gz |
Clean up dbm documentation and prepare for the next phase
git-svn-id: http://svn.apache.org/repos/asf/apr/apr-util/trunk@719502 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r-- | include/apr_dbm.h | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/include/apr_dbm.h b/include/apr_dbm.h index 9f6e8b47..ad1b4f39 100644 --- a/include/apr_dbm.h +++ b/include/apr_dbm.h @@ -63,10 +63,10 @@ typedef struct * @param dbm The newly opened database * @param type The type of the DBM (not all may be available at run time) * <pre> - * GDBM for GDBM files - * SDBM for SDBM files - * DB for berkeley DB files - * NDBM for NDBM files + * db for Berkeley DB files + * gdbm for GDBM files + * ndbm for NDBM files + * sdbm for SDBM files (always available) * default for the default DBM type * </pre> * @param name The dbm file name to open @@ -81,6 +81,9 @@ typedef struct * @param cntxt The pool to use when creating the dbm * @remark The dbm name may not be a true file name, as many dbm packages * append suffixes for seperate data and index files. + * @bug In apr-util 0.9 and 1.x, the type arg was case insensitive. This + * was highly inefficient, and as of 2.x the dbm name must be provided in + * the correct case (lower case for all bundled providers) */ APU_DECLARE(apr_status_t) apr_dbm_open_ex(apr_dbm_t **dbm, const char* type, @@ -184,7 +187,7 @@ APU_DECLARE(char *) apr_dbm_geterror(apr_dbm_t *dbm, int *errcode, * actual file/path names which would be (created and) used. At most, two * files may be used; used2 may be NULL if only one file is used. * @param pool The pool for allocating used1 and used2. - * @param type The type of DBM you require info on + * @param type The type of DBM you require info on @see apr_dbm_open_ex * @param pathname The path name to generate used-names from. * @param used1 The first pathname used by the apr_dbm implementation. * @param used2 The second pathname used by apr_dbm. If only one file is |