[libcw-cvs] [CVS] Module src

[Carlo W. <li...@us...>]

CVSROOT    : /cvsroot/libcw
Module     : src
Commit time: 2002-01-10 02:42:27 UTC

Modified files:
     libcwd/INSTALL libcwd/bfd.cc libcwd/debug.cc
     libcwd/documentation/doxygen.config
     libcwd/documentation/location.dox
     libcwd/documentation/reference.dox

Added files:
     libcwd/documentation/environment.dox

Log message:

Documentation update and fixes.

---------------------- diff included ----------------------
Index: src/libcwd/INSTALL
diff -u src/libcwd/INSTALL:1.23 src/libcwd/INSTALL:1.24
--- src/libcwd/INSTALL:1.23	Tue Jan  8 10:14:37 2002
+++ src/libcwd/INSTALL	Sat Feb  9 18:42:16 2002
@@ -27,7 +27,7 @@
 i) The GNU compiler, version 2.95.1 or higher.
 
     Location: gnu/gcc/
-    Current version: 3.0.2
+    Current version: 3.0.4
 
 Alternatively you can install only
 ia) gnu/gcc/gcc-core-<version>.tar.gz	and
@@ -55,7 +55,7 @@
 Don't delete those libraries if you have them though
 since existing binaries might need to link with them.
 
-libcwd-0.99.16 was tested with gcc-2.95.x, gcc-2.96-97 (RedHat)
+libcwd-0.99.16 was tested with gcc-2.95.x, gcc-2.96-98 (RedHat)
 and gcc-3.0.x.
 
 Packages needed to run the testsuite
@@ -125,10 +125,10 @@
 If it can't find one (it will only find one when there is a g++ or c++ in
 your PATH), then you can specify the right path during configuration.
 For example, I configure libcwd as follows to compile with the latest CVS
-version of g++, which I installed in /usr/local/bin/g++-cvs (and
+version of g++, which I installed in /usr/local/bin/g++-cvs-3.0 (and
 /usr/local/bin is in my PATH):
 
-CC="gcc-cvs" CXX="g++-cvs" ./configure
+CC="gcc-cvs-3.0" CXX="g++-cvs-3.0" ./configure
 
 -=iii=-
 
@@ -168,7 +168,7 @@
 make tar					// Create tar ball
 make rpm					// Create rpms
 make ChangeLog					// Generate ChangeLog from cvs database
-make CC="gcc-3.0.2" CXX="g++-3.0.2" reconfig	// Switch compilers keeping the same configuration
+make CC="gcc-3.0.4" CXX="g++-3.0.4" reconfig	// Switch compilers keeping the same configuration
 make full-check					// Iterate over all configurations and all compiler versions
 
 It is not garanteed that these work on another machine than mine however.
Index: src/libcwd/bfd.cc
diff -u src/libcwd/bfd.cc:1.100 src/libcwd/bfd.cc:1.101
--- src/libcwd/bfd.cc:1.100	Fri Feb  8 14:29:29 2002
+++ src/libcwd/bfd.cc	Sat Feb  9 18:42:16 2002
@@ -1,4 +1,4 @@
-// $Header: /cvsroot/l/li/libcw/src/libcwd/bfd.cc,v 1.100 2002/02/08 22:29:29 libcw Exp $
+// $Header: /cvsroot/l/li/libcw/src/libcwd/bfd.cc,v 1.101 2002/02/10 02:42:16 libcw Exp $
 //
 // Copyright (C) 2000 - 2001, by
 // 
@@ -1368,7 +1368,7 @@
     }
 
     /**
-     * \brief Move \p prototype to this location object;
+     * \brief Move \p prototype to this location object
      *
      * \p prototype must be \ref is_known "known" and the current object \ref is_known "unknown";
      * \p prototype is clear()-ed afterwards.
Index: src/libcwd/debug.cc
diff -u src/libcwd/debug.cc:1.64 src/libcwd/debug.cc:1.65
--- src/libcwd/debug.cc:1.64	Fri Feb  8 14:29:29 2002
+++ src/libcwd/debug.cc	Sat Feb  9 18:42:16 2002
@@ -1,4 +1,4 @@
-// $Header: /cvsroot/l/li/libcw/src/libcwd/debug.cc,v 1.64 2002/02/08 22:29:29 libcw Exp $
+// $Header: /cvsroot/l/li/libcw/src/libcwd/debug.cc,v 1.65 2002/02/10 02:42:16 libcw Exp $
 //
 // Copyright (C) 2000 - 2001, by
 // 
@@ -131,7 +131,7 @@
     /**
      * \brief The default %debug object.
      *
-     * The %debug object that is used by default by Dout and DoutFatal, the only %debug object used by libcwd itself.
+     * The %debug object that is used by default by \ref Dout and \ref DoutFatal, the only %debug object used by libcwd itself.
      * \sa \ref chapter_custom_do
      */
 
@@ -197,7 +197,7 @@
 	 *
 	 * This channel is <EM>%always</EM> on;
 	 * it can not be turned off.&nbsp;
-	 * It is not in the list of debug channels.&nbsp;
+	 * It is not in the list of \ref ForAllDebugChannels "debug channels".&nbsp;
 	 * When used with a label it will print as many '>'
 	 * characters as the size of the largest real channel.
 	 */
Index: src/libcwd/documentation/doxygen.config
diff -u src/libcwd/documentation/doxygen.config:1.2 src/libcwd/documentation/doxygen.config:1.3
--- src/libcwd/documentation/doxygen.config:1.2	Sat Dec 29 20:17:47 2001
+++ src/libcwd/documentation/doxygen.config	Sat Feb  9 18:42:16 2002
@@ -16,8 +16,8 @@
 REPEAT_BRIEF           = YES
 ALWAYS_DETAILED_SEC    = NO
 FULL_PATH_NAMES        = YES
-STRIP_FROM_PATH        = /home/carlo/c++/libcw_branch-threading/src/libcwd/include/ \
-                         /home/carlo/c++/libcw_branch-threading/src/libcwd/
+STRIP_FROM_PATH        = /home/carlo/c++/libcw/src/libcwd/include/ \
+                         /home/carlo/c++/libcw/src/libcwd/
 INTERNAL_DOCS          = NO
 STRIP_CODE_COMMENTS    = YES
 CASE_SENSE_NAMES       = YES
Index: src/libcwd/documentation/environment.dox
diff -u /dev/null src/libcwd/documentation/environment.dox:1.1
--- /dev/null	Sat Feb  9 18:42:27 2002
+++ src/libcwd/documentation/environment.dox	Sat Feb  9 18:42:16 2002
@@ -0,0 +1,18 @@
+/*!
+\defgroup chapter_environment Environment Variables
+\ingroup book_start
+*/
+/*!
+\page page_environment
+\ingroup chapter_environment
+
+<dl compact>
+<dt>LIBCWD_NO_STARTUP_MSGS<dd>Don't print anything before main().
+
+<dt>LIBCWD_ALWAYS_PRINT_LOADING<dd>Print messages about loading
+the shared libraries, even when this is done before libcw_do
+is turned on (except when LIBCWD_NO_STARTUP_MSGS is defined).
+</dl>
+
+*/
+
Index: src/libcwd/documentation/location.dox
diff -u src/libcwd/documentation/location.dox:1.2 src/libcwd/documentation/location.dox:1.3
--- src/libcwd/documentation/location.dox:1.2	Sat Dec 29 20:17:47 2001
+++ src/libcwd/documentation/location.dox	Sat Feb  9 18:42:17 2002
@@ -9,10 +9,10 @@
 \section section_The_BFD_library The BFD library
 
 Libcwd attempts to determine the source file and line number where memory is allocated.&nbsp;
-It does this by directly reading the .stabs section of the ELF32 object files.&nbsp;
-If you are using an Operating System that isn't ELF then you need to enable the use of libbfd for
+It does this by directly reading the .debug_line (DWARF2) or .stabs (STABS) section of the ELF32 object files.&nbsp;
+If you are using an Operating System that isn't ELF32 then you need to enable the use of GNU libbfd for
 this to work by configuring libcwd with \link enable_libcwd_libbfd --enable-libcwd-libbfd \endlink.&nbsp;
-If you don't have an ELF system and you don't have libbfd installed and are not able to install it
+If you don't have an ELF32 system and you don't have GNU libbfd installed and are not able to install it
 yourself (note: you also need libiberty and libdl) then you can disable it
 using \link enable_libcwd_location --disable-libcwd-location \endlink.&nbsp;
 There is a seperate page that deals with libcwd and \link group_locations location \endlink support.&nbsp;
Index: src/libcwd/documentation/reference.dox
diff -u src/libcwd/documentation/reference.dox:1.2 src/libcwd/documentation/reference.dox:1.3
--- src/libcwd/documentation/reference.dox:1.2	Sat Dec 29 20:17:47 2001
+++ src/libcwd/documentation/reference.dox	Sat Feb  9 18:42:17 2002
@@ -50,6 +50,7 @@
   <li>\ref chapter_custom_debug_h
   <li>\ref chapter_alloc_locations
   <li>\ref group_configuration
+  <li>\ref chapter_environment
 </ul>
 
 */
----------------------- End of diff -----------------------