Final updates before package 1.1.0 release

8 files changed, 65 insertions, 101 deletions

diff --git a/CREDITS b/CREDITS
index e3dfa96..3b89993 100644
--- a/CREDITS
+++ b/CREDITS
@@ -20,3 +20,10 @@ have made contributions:
 		- Supplied patch to fix class_device functions
 	o Brian King <brking@us.ibm.com>
 		- Supplied patch to fix a memory leak in sysfs_dir.c
+	o Martin Schlemmer <azarah@gentoo.org>
+		- Supplied patch to prevent checks for installed 
+			headers, while building.
+	o Lev Makhlis <mlev@despammed.com>
+		- Supplied patch to make library C++ compatible.
+	o Dr. Hannes Reinecke <hare@suse.de>
+		- Supplied patch to fix SEGV in dlist.c
diff --git a/ChangeLog b/ChangeLog
index 7420c4d..9d176b9 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,4 +1,8 @@
 
+03/31/2004 - Ananth Mavinakayanahalli <ananth@in.ibm.com>
+		* More updates to docs/libsysfs.txt
+		* Updated NEWS and CREDITS files
+
 03/19/2004 - Dr. Hannes Reinecke <hare@suse.de>
 		* Fixed SEGV in dlist.c
 
diff --git a/NEWS b/NEWS
index 61b03dc..59bb5f8 100644
--- a/NEWS
+++ b/NEWS
@@ -1,6 +1,12 @@
 Version History:
 ---------------
 
+ 1.1.0 - Released March 31, 2004
+	* Added changes for C++ compatibility (Thanks to Lev Makhlis)
+	* Patched configure.ac not to check for installed headers
+	* Fixed SEGV in dlist.c (Thanks to Dr. Hannes Reinecke)
+	* Added security audits in library.
+
  1.0.0 - Released February 24, 2004
 	* Libsysfs now ships with a comprehensive testsuite.
 	* List elements are now maintained in sorted order.
diff --git a/README b/README
index 3e8212f..229d969 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 
-	System Utilities Package - Includes Libsysfs(v. 0.2.0)
+	System Utilities Package - Includes Libsysfs(v. 1.1.0)
 	======================================================
 
 Contents
diff --git a/TODO b/TODO
index 82cf700..c5f40da 100644
--- a/TODO
+++ b/TODO
@@ -6,3 +6,6 @@ Commands:
 ---------
 - Add topology tree view.
 
+Documentation:
+--------------
+- Update/improve documentation.
diff --git a/config.h.in b/config.h.in
index 6c53d1a..561af39 100644
--- a/config.h.in
+++ b/config.h.in
@@ -22,9 +22,6 @@
 /* Define to 1 if you have the `isascii' function. */
 #undef HAVE_ISASCII
 
-/* Define to 1 if you have the `sysfs' library (-lsysfs). */
-#undef HAVE_LIBSYSFS
-
 /* Define to 1 if `lstat' has the bug that it succeeds when given the
    zero-length file name argument. */
 #undef HAVE_LSTAT_EMPTY_STRING_BUG
diff --git a/configure b/configure
index 6953005..57f8f1b 100755
--- a/configure
+++ b/configure
@@ -1,6 +1,6 @@
 #! /bin/sh
 # Guess values for system-dependent variables and create Makefiles.
-# Generated by GNU Autoconf 2.53 for sysfsutils 1.0.0.
+# Generated by GNU Autoconf 2.53 for sysfsutils 1.1.0.
 #
 # Report bugs to <linux-diag-devel@lists.sourceforge.net>.
 #
@@ -415,8 +415,8 @@ SHELL=${CONFIG_SHELL-/bin/sh}
 # Identity of this package.
 PACKAGE_NAME='sysfsutils'
 PACKAGE_TARNAME='sysfsutils'
-PACKAGE_VERSION='1.0.0'
-PACKAGE_STRING='sysfsutils 1.0.0'
+PACKAGE_VERSION='1.1.0'
+PACKAGE_STRING='sysfsutils 1.1.0'
 PACKAGE_BUGREPORT='linux-diag-devel@lists.sourceforge.net'
 
 ac_unique_file="config.h.in"
@@ -921,7 +921,7 @@ if test "$ac_init_help" = "long"; then
   # Omit some internal or obsolete options to make the list less imposing.
   # This message is too long to be a string in the A/UX 3.1 sh.
   cat <<_ACEOF
-\`configure' configures sysfsutils 1.0.0 to adapt to many kinds of systems.
+\`configure' configures sysfsutils 1.1.0 to adapt to many kinds of systems.
 
 Usage: $0 [OPTION]... [VAR=VALUE]...
 
@@ -987,7 +987,7 @@ fi
 
 if test -n "$ac_init_help"; then
   case $ac_init_help in
-     short | recursive ) echo "Configuration of sysfsutils 1.0.0:";;
+     short | recursive ) echo "Configuration of sysfsutils 1.1.0:";;
    esac
   cat <<\_ACEOF
 
@@ -1082,7 +1082,7 @@ fi
 test -n "$ac_init_help" && exit 0
 if $ac_init_version; then
   cat <<\_ACEOF
-sysfsutils configure 1.0.0
+sysfsutils configure 1.1.0
 generated by GNU Autoconf 2.53
 
 Copyright 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002
@@ -1097,7 +1097,7 @@ cat >&5 <<_ACEOF
 This file contains any messages produced by compilers while
 running configure, to aid debugging if configure makes a mistake.
 
-It was created by sysfsutils $as_me 1.0.0, which was
+It was created by sysfsutils $as_me 1.1.0, which was
 generated by GNU Autoconf 2.53.  Invocation command line was
 
   $ $0 $@
@@ -1629,7 +1629,7 @@ fi
 
 # Define the identity of the package.
  PACKAGE=sysfsutils
- VERSION=1.0.0
+ VERSION=1.1.0
 
 
 cat >>confdefs.h <<_ACEOF
@@ -8203,74 +8203,6 @@ fi
 done
 
 
-# Checks for libraries.
-# FIXME: Replace `main' with a function in `-lsysfs':
-
-echo "$as_me:$LINENO: checking for sysfs_read_directory in -lsysfs" >&5
-echo $ECHO_N "checking for sysfs_read_directory in -lsysfs... $ECHO_C" >&6
-if test "${ac_cv_lib_sysfs_sysfs_read_directory+set}" = set; then
-  echo $ECHO_N "(cached) $ECHO_C" >&6
-else
-  ac_check_lib_save_LIBS=$LIBS
-LIBS="-lsysfs  $LIBS"
-cat >conftest.$ac_ext <<_ACEOF
-#line $LINENO "configure"
-#include "confdefs.h"
-
-/* Override any gcc2 internal prototype to avoid an error.  */
-#ifdef __cplusplus
-extern "C"
-#endif
-/* We use char because int might match the return type of a gcc2
-   builtin and then its argument prototype would still apply.  */
-char sysfs_read_directory ();
-#ifdef F77_DUMMY_MAIN
-#  ifdef __cplusplus
-     extern "C"
-#  endif
-   int F77_DUMMY_MAIN() { return 1; }
-#endif
-int
-main ()
-{
-sysfs_read_directory ();
-  ;
-  return 0;
-}
-_ACEOF
-rm -f conftest.$ac_objext conftest$ac_exeext
-if { (eval echo "$as_me:$LINENO: \"$ac_link\"") >&5
-  (eval $ac_link) 2>&5
-  ac_status=$?
-  echo "$as_me:$LINENO: \$? = $ac_status" >&5
-  (exit $ac_status); } &&
-         { ac_try='test -s conftest$ac_exeext'
-  { (eval echo "$as_me:$LINENO: \"$ac_try\"") >&5
-  (eval $ac_try) 2>&5
-  ac_status=$?
-  echo "$as_me:$LINENO: \$? = $ac_status" >&5
-  (exit $ac_status); }; }; then
-  ac_cv_lib_sysfs_sysfs_read_directory=yes
-else
-  echo "$as_me: failed program was:" >&5
-cat conftest.$ac_ext >&5
-ac_cv_lib_sysfs_sysfs_read_directory=no
-fi
-rm -f conftest.$ac_objext conftest$ac_exeext conftest.$ac_ext
-LIBS=$ac_check_lib_save_LIBS
-fi
-echo "$as_me:$LINENO: result: $ac_cv_lib_sysfs_sysfs_read_directory" >&5
-echo "${ECHO_T}$ac_cv_lib_sysfs_sysfs_read_directory" >&6
-if test $ac_cv_lib_sysfs_sysfs_read_directory = yes; then
-  cat >>confdefs.h <<_ACEOF
-#define HAVE_LIBSYSFS 1
-_ACEOF
-
-  LIBS="-lsysfs $LIBS"
-
-fi
-
-
 # Checks for header files.
 
 
@@ -9918,7 +9850,7 @@ _ASBOX
 } >&5
 cat >&5 <<_CSEOF
 
-This file was extended by sysfsutils $as_me 1.0.0, which was
+This file was extended by sysfsutils $as_me 1.1.0, which was
 generated by GNU Autoconf 2.53.  Invocation command line was
 
   CONFIG_FILES    = $CONFIG_FILES
@@ -9980,7 +9912,7 @@ _ACEOF
 
 cat >>$CONFIG_STATUS <<_ACEOF
 ac_cs_version="\\
-sysfsutils config.status 1.0.0
+sysfsutils config.status 1.1.0
 configured by $0, generated by GNU Autoconf 2.53,
   with options \\"`echo "$ac_configure_args" | sed 's/[\\""\`\$]/\\\\&/g'`\\"
 
diff --git a/docs/libsysfs.txt b/docs/libsysfs.txt
index 7427794..4d9b653 100644
--- a/docs/libsysfs.txt
+++ b/docs/libsysfs.txt
@@ -3,7 +3,7 @@
 	=========================================
 
 Version: 1.1.0 
-March 15, 2004
+March 31, 2004
 
 Contents
 --------
@@ -22,15 +22,16 @@ Contents
    5.5 Device Data Structure
    5.6 Driver Data Structure
 6. Functions
-   6.1 Utility Functions
-   6.2 Filesystem Functions
-       6.2.1 Attribute Functions
-       6.2.2 Directory Link Functions
-       6.2.3 Directory Functions
-   6.3 Bus Functions
-   6.4 Class Functions
-   6.5 Device Functions
-   6.6 Driver Functions
+   6.1 Calling Conventions in Libsysfs
+   6.2 Utility Functions
+   6.3 Filesystem Functions
+       6.3.1 Attribute Functions
+       6.3.2 Directory Link Functions
+       6.3.3 Directory Functions
+   6.4 Bus Functions
+   6.5 Class Functions
+   6.6 Device Functions
+   6.7 Driver Functions
 7. Navigating a dlist
 8. Usage
 9. Testsuite
@@ -388,7 +389,21 @@ using "open" and "close". Open returns a structure and close is used
 to clean that structure up.
 
 
-6.1 Utility Functions
+6.1 Calling Conventions in Libsysfs
+-----------------------------------
+
+Libsysfs uses a simple API calling convention. APIs are classified to be 
+one of "open", "get", "close" types. The convention is as follows:
+
+	a. All "open" APIs have a corresponding "close" API.
+	b. References obtained using "get" calls should not be closed
+		explicitly.
+	c. All "opened" references have to be closed with a call to
+		their corresponding "close" call. This takes care of
+		freeing structure references obtained with "get" calls.
+
+
+6.2 Utility Functions
 ---------------------
 
 The library will provide a few utility functions for working with sysfs.
@@ -529,7 +544,7 @@ Prototype:	int sysfs_path_is_link(const char *path)
 -------------------------------------------------------------------------------
 
 
-6.2 Filesystem Functions
+6.3 Filesystem Functions
 ------------------------
 
 Libsysfs provides a set of functions to open, read, and close directories
@@ -537,7 +552,7 @@ and attributes/files in sysfs. These functions mirror their filesystem
 function counterparts. 
 
 
-6.2.1 Attribute Functions
+6.3.1 Attribute Functions
 -------------------------
 
 Along with the usual open, read, and close functions, libsysfs provides
@@ -711,7 +726,7 @@ Prototype:	struct sysfs_attribute *sysfs_get_directory_attribute
 -------------------------------------------------------------------------------
 		
 
-6.2.2 Link Functions
+6.3.2 Link Functions
 --------------------
 
 Sysfs contains many symbolic links, like bus links to bus devices. Libsysfs
@@ -829,7 +844,7 @@ Prototype:	int sysfs_refresh_dir_links(struct sysfs_directory *sysdir)
 -------------------------------------------------------------------------------
 
 
-6.2.3 Directory Functions
+6.3.3 Directory Functions
 -------------------------
 
 Sysfs directories can represent every directory under sysfs. The structures
@@ -960,7 +975,7 @@ Prototype:	int sysfs_refresh_dir_subdirs(struct sysfs_directory *sysdir)
 -------------------------------------------------------------------------------
 
 
-6.3 Bus Functions
+6.4 Bus Functions
 -----------------
 
 The library provides a functions for viewing buses represented in sysfs. 
@@ -1131,7 +1146,7 @@ Prototype:	int sysfs_find_driver_bus(const char *driver,
 -------------------------------------------------------------------------------
 
 
-6.4 Class Functions
+6.5 Class Functions
 -------------------
 
 Libsysfs provides functions to open sysfs classes and their class devices.
@@ -1385,7 +1400,7 @@ Prototype:	struct sysfs_attribute *sysfs_write_classdev_attr
 -------------------------------------------------------------------------------
 
 
-6.5 Device Functions
+6.6 Device Functions
 --------------------
 
 Devices represent everything in sysfs under /sys/devices, which is a
@@ -1614,7 +1629,7 @@ Prototype:	struct sysfs_attribute *sysfs_open_device_attr
 -------------------------------------------------------------------------------
 
 
-6.6 Driver Functions
+6.7 Driver Functions
 --------------------
 
 Drivers are represented in sysfs under the /sys/bus/xxx/drivers (xxx being