From 370ad33210ad7bdf5ec608c412b0525164cb76b4 Mon Sep 17 00:00:00 2001 From: Sears Russell Date: Tue, 6 Jul 2004 20:59:36 +0000 Subject: [PATCH] Fixed groupings for LLADD API docs. --- lladd/common.h | 8 ++++---- lladd/logger/logEntry.h | 9 +++++++-- lladd/operations/alloc.h | 18 ++++++++++++++++++ lladd/operations/increment.h | 2 ++ lladd/operations/lladdhash.h | 2 ++ lladd/page.h | 2 +- lladd/transactional.h | 8 +++++++- src/lladd/blobManager.h | 8 +++++++- 8 files changed, 48 insertions(+), 9 deletions(-) diff --git a/lladd/common.h b/lladd/common.h index 05783d6..ccec8bb 100644 --- a/lladd/common.h +++ b/lladd/common.h @@ -44,6 +44,8 @@ terms specified in this license. * * A standard header file, adopted from Autobook. * + * http://sources.redhat.com/autobook/ + * * The idea behind this file is twofold. First, we want to keep as * much of the #ifdef portability nonsense in here as possible. * Second, we allow users to #include headers that in turn #include @@ -51,10 +53,8 @@ terms specified in this license. * the right thing' and build, even though they do not #include the * config.h file that all of the LLADD stuff uses. * - * @todo: Need to make sure everyone actually includes this thing, and - * also includes constants.h - * - * @ingroup LLADD_CORE + * @todo Need to make sure every .c file actually includes this thing, and + * also includes constants.h, and that no .h files include config.h * * $Id$ */ diff --git a/lladd/logger/logEntry.h b/lladd/logger/logEntry.h index b5c3318..e547aaf 100644 --- a/lladd/logger/logEntry.h +++ b/lladd/logger/logEntry.h @@ -55,8 +55,13 @@ BEGIN_C_DECLS @todo Was getting some memory over-runs from the fact that I didn't know the exact length of a raw log entry. This seems to be fixed - now. (Need to run through electric fence / determine the 'right - way' to do this...) + now. + + @todo Is there a better way to deal with sizeof() and log entries? + + @ingroup LLADD_CORE + + $Id$ */ typedef struct { diff --git a/lladd/operations/alloc.h b/lladd/operations/alloc.h index 369c0bc..10f20c9 100644 --- a/lladd/operations/alloc.h +++ b/lladd/operations/alloc.h @@ -3,9 +3,27 @@ #ifndef __ALLOC_H #define __ALLOC_H +/** + @file + + @ingroup OPERATIONS + + $Id$ +*/ + Operation getAlloc(); Operation getDealloc(); + +/** + Allocate a record. + + @param The transaction responsible for the allocation @param The + size of the new record to be allocated. (Talloc may allocate a + blob if the record will not easily fit on a page.) +*/ recordid Talloc(int xid, long size); + +/** @todo Currently, we just leak store space on dealloc. */ void Tdealloc(int xid, recordid rid); #endif diff --git a/lladd/operations/increment.h b/lladd/operations/increment.h index 7611531..735e3ed 100644 --- a/lladd/operations/increment.h +++ b/lladd/operations/increment.h @@ -50,6 +50,8 @@ terms specified in this license. * * @see decrement.h * + * @ingroup OPERATIONS + * * $Id$ */ diff --git a/lladd/operations/lladdhash.h b/lladd/operations/lladdhash.h index 9f12400..e6ea3cd 100644 --- a/lladd/operations/lladdhash.h +++ b/lladd/operations/lladdhash.h @@ -20,6 +20,8 @@ result in poor performance when the bucket size is large, and transactions are short. + @ingroup OPERATIONS + $Id$ */ diff --git a/lladd/page.h b/lladd/page.h index 8471a5e..69d53d9 100644 --- a/lladd/page.h +++ b/lladd/page.h @@ -43,7 +43,7 @@ terms specified in this license. /** * @file * - * interface for dealing with pages + * interface for dealing with slotted pages * * @ingroup LLADD_CORE * $Id$ diff --git a/lladd/transactional.h b/lladd/transactional.h index 965c6e2..d9379af 100644 --- a/lladd/transactional.h +++ b/lladd/transactional.h @@ -45,7 +45,13 @@ terms specified in this license. * * The minimal subset of LLADD necessary to implement transactional consistency. * - * This module includes the standard API (excluding operations), the logger, the buffer mananger, and recovery code. + * This module includes the standard API (excluding operations), the + * logger, the buffer mananger, and recovery code. + * + * In theory, the other .h files that are installed in /usr/include + * aren't needed for application developers. + * + * @todo Move as much of the stuff in lladd/ to src/lladd/ as possible. * */ /** diff --git a/src/lladd/blobManager.h b/src/lladd/blobManager.h index 06b5665..1afe393 100644 --- a/src/lladd/blobManager.h +++ b/src/lladd/blobManager.h @@ -7,8 +7,14 @@ BEGIN_C_DECLS /** @file - blobManager - Provides blob handling + blobManager - Provides blob handling. + Plan for modularity: Exactly one blob manager per storeFile. + Alternatively, we could use the bufferManager's record length + field to allow for more than one blob manager per buffer + manager. (Right now, this field is set to a special value for + blobs; thie could be extended for other types of records.) + Blob manager interacts with page manger via page manager's public api.