Doxygen fiddles.

CVS patchset: 3528
CVS date: 2000/01/19 22:51:39

8 files changed, 95 insertions, 61 deletions

diff --git a/.cvsignore b/.cvsignore
index 55e4109c6..815dc4fc0 100644
--- a/.cvsignore
+++ b/.cvsignore
@@ -5,10 +5,10 @@
 Doxyfile
 Makefile
 Makefile.in
+config.cache
+config.guess
 config.h
 config.h.in
-config.guess
-config.cache
 config.log
 config.status
 config.sub
@@ -27,4 +27,4 @@ rpmconvert
 rpmrc
 stamp-h
 stamp-h.in
-*.tar.gz
+rpm-*.tar.gz
diff --git a/Doxyfile.in b/Doxyfile.in
index 7bdf53e20..1287bdedd 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -184,7 +184,9 @@ INPUT                = \
 	./oldrpmdb.c \
 	./rpm.c \
 	./rpm2cpio.c \
+	./system.h \
 	./build/build.c \
+	./build/buildio.h \
 	./build/expression.c \
 	./build/files.c \
 	./build/misc.c \
@@ -203,55 +205,75 @@ INPUT                = \
 	./build/parseSpec.c \
 	./build/reqprov.c \
 	./build/rpmbuild.h \
+	./build/rpmspec.h \
 	./build/spec.c \
 	./lib/cpio.c \
+	./lib/cpio.h \
 	./lib/dbindex.c \
+	./lib/dbindex.h \
 	./lib/depends.c \
+	./lib/depends.h \
 	./lib/falloc.c \
+	./lib/falloc.h \
 	./lib/formats.c \
 	./lib/fprint.c \
+	./lib/fprint.h \
 	./lib/fs.c \
 	./lib/hash.c \
+	./lib/hash.h \
 	./lib/header.c \
+	./lib/header.h \
 	./lib/install.c \
+	./lib/install.h \
 	./lib/lookup.c \
+	./lib/lookup.h \
 	./lib/macro.c \
-	./lib/misc.h \
 	./lib/md5.c \
+	./lib/md5.h \
 	./lib/md5sum.c \
 	./lib/messages.c \
 	./lib/misc.c \
+	./lib/misc.h \
 	./lib/oldheader.c \
+	./lib/oldheader.h \
+	./lib/oldrpmdb.h \
 	./lib/package.c \
 	./lib/problems.c \
 	./lib/query.c \
 	./lib/rebuilddb.c \
 	./lib/rpmchecksig.c \
 	./lib/rpmdb.c \
+	./lib/rpmdb.h \
 	./lib/rpmerr.c \
 	./lib/rpminstall.c \
 	./lib/rpmio.c \
 	./lib/rpmio.h \
 	./lib/rpmlead.c \
+	./lib/rpmlead.h \
 	./lib/rpmlib.h \
+	./lib/rpmmacro.h \
 	./lib/rpmmalloc.c \
+	./lib/rpm_malloc.h \
 	./lib/rpmrc.c \
+	./lib/rpmurl.h \
 	./lib/signature.c \
+	./lib/signature.h \
 	./lib/stringbuf.c \
 	./lib/stringbuf.h \
 	./lib/stubs.c \
 	./lib/tagName.c \
 	./lib/tagtable.c \
-	./lib/test.c \
 	./lib/transaction.c \
-	./lib/tufdio.c \
 	./lib/uninstall.c \
 	./lib/url.c \
 	./lib/verify.c \
 	./popt/findme.c \
+	./popt/findme.h \
 	./popt/popt.c \
+	./popt/popt.h \
 	./popt/poptconfig.c \
 	./popt/popthelp.c \
+	./popt/poptint.h \
 	./popt/poptparse.c \
 	./tools/dump.c \
 	./tools/dumpdb.c \
@@ -267,17 +289,6 @@ INPUT                = \
 	./tools/rpmsignature.c \
 	./tools/str-list.c
 
-#	./system.h \
-#	./build/buildio.h \
-#	./build/rpmspec.h \
-#	./lib/dbindex.h \
-#	./lib/header.h \
-#	./lib/rpmmacro.h \
-#	./lib/rpmurl.h \
-#	./popt/findme.h \
-#	./popt/poptint.h \
-#	./popt/popt.h \
-
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
 # and *.h) to filter out the source-files in the directories. If left 
diff --git a/acconfig.h b/acconfig.h
index 082a17fc0..50d5cdc5a 100644
--- a/acconfig.h
+++ b/acconfig.h
@@ -132,6 +132,9 @@
 /* define if experimental support rpm-4.0 packages is desired */
 #undef ENABLE_V4_PACKAGES
 
+/* Absolute path to rpm top_sourcedir. */
+#undef TOP_SOURCEDIR
+
 ^L
 /* Leave that blank line there!!  Autoheader needs it.
    If you're adding to this file, keep in mind:
diff --git a/build/rpmspec.h b/build/rpmspec.h
index 2155d7973..bc8b7e0cb 100644
--- a/build/rpmspec.h
+++ b/build/rpmspec.h
@@ -72,8 +72,9 @@ struct speclines {
     int sl_nlines;
 };
 
+/*! The structure used to store values parsed from a spec file. */
 struct SpecStruct {
-    /*@only@*/ const char *specFile;
+    /*@only@*/ const char *specFile;	/*!< Name of the spec file. */
     /*@only@*/ const char *sourceRpmName;
 
     /*@owned@*/ struct speclines *sl;
@@ -116,14 +117,15 @@ struct SpecStruct {
     /*@dependent@*/ struct MacroContext *macros;
 
     /*@only@*/ const char *rootURL;
-    /*@only@*/ StringBuf prep;
-    /*@only@*/ StringBuf build;
-    /*@only@*/ StringBuf install;
-    /*@only@*/ StringBuf clean;
+    /*@only@*/ StringBuf prep;		/*!< %prep scriptlet. */
+    /*@only@*/ StringBuf build;		/*!< %build scriptlet. */
+    /*@only@*/ StringBuf install;	/*!< %install scriptlet. */
+    /*@only@*/ StringBuf clean;		/*!< %clean scriptlet. */
 
-    /*@owned@*/ struct PackageStruct *packages;
+    /*@owned@*/ struct PackageStruct *packages;	/*!< Package list. */
 };
 
+/*! The structure used to store values for a package. */
 struct PackageStruct {
     /*@refcounted@*/ Header header;
 
@@ -135,11 +137,11 @@ struct PackageStruct {
     int autoReq;
     int autoProv;
 
-    char *preInFile;
-    char *postInFile;
-    char *preUnFile;
-    char *postUnFile;
-    char *verifyFile;
+    char *preInFile;		/*!< %pre scriptlet. */
+    char *postInFile;		/*!< %post scriptlet. */
+    char *preUnFile;		/*!< %preun scriptlet. */
+    char *postUnFile;		/*!< %postun scriptlet. */
+    char *verifyFile;		/*!< %verifyscript scriptlet. */
 
     /*@only@*/ StringBuf specialDoc;
 
diff --git a/lib/cpio.h b/lib/cpio.h
index db9979a47..99dfd6429 100644
--- a/lib/cpio.h
+++ b/lib/cpio.h
@@ -6,8 +6,20 @@
 
 #include <rpmio.h>
 
+/** \file lib/cpio.h
+ *  Structures used to handle cpio payloads within rpm packages.
+ *
+ *  Warning: Don't think that rpm's cpio implementation behaves just like
+ *  standard cpio.
+ *  The implementation is pretty close, but it has some behaviors which are
+ *  more to RPM's liking. I tried to document the differing behavior in cpio.c,
+ *  but I may have missed some.
+ *
+ */
+
 /* Note the CPIO_CHECK_ERRNO bit is set only if errno is valid. These have to
    be positive numbers or this setting the high bit stuff is a bad idea. */
+
 #define CPIOERR_CHECK_ERRNO	0x00008000
 
 #define CPIOERR_BAD_MAGIC	(2			)
@@ -33,32 +45,31 @@
 #define CPIOERR_MISSING_HARDLINK (22			)
 #define CPIOERR_INTERNAL	(23			)
 
-
-/* Don't think this behaves just like standard cpio. It's pretty close, but
-   it has some behaviors which are more to RPM's liking. I tried to document
-   them in cpio.c, but I may have missed some. */
-
 #define CPIO_MAP_PATH		(1 << 0)
 #define CPIO_MAP_MODE		(1 << 1)
 #define CPIO_MAP_UID		(1 << 2)
 #define CPIO_MAP_GID		(1 << 3)
 #define CPIO_FOLLOW_SYMLINKS	(1 << 4)  /* only for building */
 
+/*! The structure used to define a cpio payload file. */
 struct cpioFileMapping {
-    /*@owned@*/ const char * archivePath;
-    /*@owned@*/ const char * fsPath;
-    mode_t finalMode;
-    uid_t finalUid;
-    gid_t finalGid;
+    /*@owned@*/ const char * archivePath; /*!< Path to store in cpio archive. */
+    /*@owned@*/ const char * fsPath;	/*!< Location of payload file. */
+    mode_t finalMode;		/*!< Mode of payload file (from header). */
+    uid_t finalUid;		/*!< Uid of payload file (from header). */
+    gid_t finalGid;		/*!< Gid of payload file (from header). */
     int mapFlags;
 };
 
-/* on cpio building, only "file" is filled in */
+/** The structure passed as first argument during a cpio progress callback.
+ *
+ * Note: When building the cpio payload, only "file" is filled in.
+ */
 struct cpioCallbackInfo {
-    /*@dependent@*/ const char * file;
-    long fileSize;			/* total file size */
-    long fileComplete;			/* amount of file unpacked */
-    long bytesProcessed;		/* bytes in archive read */
+    /*@dependent@*/ const char * file;	/*!< File name being installed. */
+    long fileSize;			/*!< Total file size. */
+    long fileComplete;			/*!< Amount of file unpacked. */
+    long bytesProcessed;		/*!< No. bytes in archive read. */
 };
 
 #ifdef __cplusplus
diff --git a/lib/rpmmacro.h b/lib/rpmmacro.h
index 2ae5b739d..e9c05777f 100644
--- a/lib/rpmmacro.h
+++ b/lib/rpmmacro.h
@@ -1,19 +1,21 @@
 #ifndef _H_MACRO_
 #define	_H_MACRO_
 
+/*! The structure used to store a macro. */
 typedef /*@abstract@*/ struct MacroEntry {
-	struct MacroEntry *prev;
-	const char *name;	/* Macro name */
-	const char *opts;	/* Macro parameters (ala getopt) */
-	const char *body;	/* Macro body */
-	int	used;		/* No. of expansions */
-	int	level;
+	struct MacroEntry *prev;/*!< Macro entry stack. */
+	const char *name;	/*!< Macro name. */
+	const char *opts;	/*!< Macro parameters (a la getopt) */
+	const char *body;	/*!< Macro body. */
+	int	used;		/*!< No. of expansions. */
+	int	level;		/*!< Scoping level. */
 } MacroEntry;
 
+/*! The structure used to store the set of macros in a context. */
 typedef /*@abstract@*/ struct MacroContext {
-	MacroEntry **	macroTable;
-	int		macrosAllocated;
-	int		firstFree;
+	MacroEntry **	macroTable;	/*!< Macro entry table for context. */
+	int		macrosAllocated;/*!< No. of allocated macros. */
+	int		firstFree;	/*!< No. of macros. */
 } MacroContext;
 
 /*
diff --git a/python/Makefile.in b/python/Makefile.in
index c50f31084..12f9aef88 100644
--- a/python/Makefile.in
+++ b/python/Makefile.in
@@ -120,6 +120,7 @@ RPMCANONOS = @RPMCANONOS@
 RPMCANONVENDOR = @RPMCANONVENDOR@
 RPMCONFIGDIR = @RPMCONFIGDIR@
 SYSCONFIGDIR = @SYSCONFIGDIR@
+TOP_SOURCEDIR = @TOP_SOURCEDIR@
 U = @U@
 USE_INCLUDED_LIBINTL = @USE_INCLUDED_LIBINTL@
 USE_NLS = @USE_NLS@
@@ -132,9 +133,11 @@ __CP = @__CP@
 __CPIO = @__CPIO@
 __ID = @__ID@
 __INSTALL = @__INSTALL@
+__LD = @__LD@
 __MAKE = @__MAKE@
 __MKDIR = @__MKDIR@
 __MV = @__MV@
+__NM = @__NM@
 __OBJCOPY = @__OBJCOPY@
 __OBJDUMP = @__OBJDUMP@
 __PATCH = @__PATCH@
diff --git a/rpmio/rpmmacro.h b/rpmio/rpmmacro.h
index 2ae5b739d..e9c05777f 100644
--- a/rpmio/rpmmacro.h
+++ b/rpmio/rpmmacro.h
@@ -1,19 +1,21 @@
 #ifndef _H_MACRO_
 #define	_H_MACRO_
 
+/*! The structure used to store a macro. */
 typedef /*@abstract@*/ struct MacroEntry {
-	struct MacroEntry *prev;
-	const char *name;	/* Macro name */
-	const char *opts;	/* Macro parameters (ala getopt) */
-	const char *body;	/* Macro body */
-	int	used;		/* No. of expansions */
-	int	level;
+	struct MacroEntry *prev;/*!< Macro entry stack. */
+	const char *name;	/*!< Macro name. */
+	const char *opts;	/*!< Macro parameters (a la getopt) */
+	const char *body;	/*!< Macro body. */
+	int	used;		/*!< No. of expansions. */
+	int	level;		/*!< Scoping level. */
 } MacroEntry;
 
+/*! The structure used to store the set of macros in a context. */
 typedef /*@abstract@*/ struct MacroContext {
-	MacroEntry **	macroTable;
-	int		macrosAllocated;
-	int		firstFree;
+	MacroEntry **	macroTable;	/*!< Macro entry table for context. */
+	int		macrosAllocated;/*!< No. of allocated macros. */
+	int		firstFree;	/*!< No. of macros. */
 } MacroContext;
 
 /*