mods for doxygen-0.49-991003

1 files changed, 52 insertions, 18 deletions

diff --git a/INSTALL b/INSTALL
index 2ba7798..9f4d753 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,4 +1,4 @@
-DOXYGEN Version 0.49-990901
+DOXYGEN Version 0.49-991003
 
 CONTENTS
 --------
@@ -8,14 +8,15 @@ CONTENTS
       * HTML related problems
       * LaTeX related problems
       * HP-UX / Digital UNIX problems
+      * gcc 2.7.2.x related problems
 
 INSTALLATION INSTRUCTIONS FOR UNIX:
 -----------------------------------
 
 1.  Unpack the archive, unless you already have:
    
-     gunzip doxygen-0.49-990901.src.tar.gz    # uncompress the archive
-     tar xf doxygen-0.49-990901.src.tar       # unpack it
+     gunzip doxygen-0.49-991003.src.tar.gz    # uncompress the archive
+     tar xf doxygen-0.49-991003.src.tar       # unpack it
 
 2.  Run the configure script:
  
@@ -26,6 +27,9 @@ INSTALLATION INSTRUCTIONS FOR UNIX:
     interpreter. It will report what it finds. Use configure --help 
     to see how to override or change the default or detected settings.
 
+    If you have downloaded the binary distribution, you can proceed 
+    with step 6 now.
+
 3.  Compile the program by running make:
 
      make
@@ -34,14 +38,14 @@ INSTALLATION INSTRUCTIONS FOR UNIX:
     doxytag, and doxysearch) should be available in the bin directory of the 
     distribution.
 
-5.  Generate the user manual (optional, will also be done in step 6).
+4.  Generate the user manual (optional, will also be done in step 6).
     
      make docs
 
-    to let doxygen generate the HTML and LaTeX documentation.
+    To let doxygen generate the HTML and LaTeX documentation.
     (you will need the stream editor `sed' for this)
 
-     make ps
+5.   make ps
 
     to generate a postscript version of the manual. 
     (you will need latex and dvips for this)
@@ -58,14 +62,17 @@ INSTALLATION INSTRUCTIONS FOR UNIX:
 
      make install
 
-    Binaries are install to the directory <prefix>/bin 
-    Documentation and examples to the directory <prefix>/share/doxygen
+    Binaries are installed in the directory <prefix>/bin 
+    Documentation and examples in the directory <prefix>/doc/doxygen
+
+    <prefix> defaults to /usr but can be changed with the --prefix
+    option of the configure script. 
 
 INSTALLATION INSTRUCTIONS FOR WINDOWS:
 --------------------------------------
 
 Currently, only Microsoft Visual C++ (version 5.0) is supported. 
-(For other platforms you may need to edit the perl script in wintools/make.pl
+(For other compilers you may need to edit the perl script in wintools/make.pl
 a bit). Let me know what you had to change if you got Doxygen working with 
 another windows compiler. 
 
@@ -80,9 +87,10 @@ You will need to install the windows/dos versions of following tools:
 - Qt-1.xx (Qt-2.xx should also work, but I didn't test it for Windows) 
   (Hint: only the tools section is required, so you can use the free 
    X-windows version as well!)
+  You can get it at http://www.troll.no
 - Microsoft Visual C++ (I only tested with version 5.0).
   Use the vcvars32.bat to set the environment variables 
-  (if not selected to do this automatically during installation).
+  (if you did not select to do this automatically during installation).
 - To generate LaTeX documentation or formulas in HTML you need the tools: 
   latex, dvips and gswin32 
   To get these working under Windows install the fpTeX distribution
@@ -96,15 +104,17 @@ You will need to install the windows/dos versions of following tools:
   `objects' and `bin' manually in the root of the distribution before 
   compiling.
 
-Make sure all tools are accessible from the command-line (add them to the
-PATH environment if needed).
+Open a dos box.
+Make sure all tools (i.e. nmake, latex, gswin32, dvips, sed, flex, bison, 
+cl, rm and perl), are accessible from the command-line (add them to the
+PATH environment variable if needed).
 
-Open a dos box, goto the doxygen root dir and type:
+goto the doxygen root dir and type:
 
 make.bat
 
 This should build the executables doxygen.exe, doxytag.exe, and doxysearch.exe
-(The compiler should not produce any warnings or errors).
+(The compiler should not produce any serious warnings or errors).
 
 To build the examples type:
 
@@ -125,8 +135,8 @@ The manual should now be here latex/doxygen_manual.ps
 KNOWN CONFIGURATION PROBLEMS
 
 QT RELATED PROBLEMS:
-- Qt-2.01 contains a bug that 
-
+- Qt-2.01 contains a bug that makes some special characters appear as 
+  question marks (?) in the HTML output.
 
 HTML RELATED PROBLEMS:
 - the indent continuously increases.
@@ -168,7 +178,31 @@ HP-UX / DIGITAL UNIX PROBLEMS:
     defined (__sparc) || defined (__sgi) || defined (__osf__)
     #include <alloca.h>
 
-  This seems to be a problem with bison, but I don't know how to fix it.
+  Alternatively, one could fix the problem at the bison side.
+  Here is patch for bison.simple (provided by Andre Johansen):
+ 
+------------------------------------------------------------------------------
+--- bison.simple~       Tue Nov 18 11:45:53 1997
++++ bison.simple        Mon Jan 26 15:10:26 1998
+@@ -27,7 +27,7 @@
+ #ifdef __GNUC__
+ #define alloca __builtin_alloca
+ #else /* not GNU C.  */
+-#if (!defined (__STDC__) && defined (sparc)) || defined (__sparc__) || defined (__sparc) || defined (__sgi)
++#if (!defined (__STDC__) && defined (sparc)) || defined (__sparc__) || defined (__sparc) || defined (__sgi) || defined (__alpha)
+ #include <alloca.h>
+ #else /* not sparc */
+ #if defined (MSDOS) && !defined (__TURBOC__)
+------------------------------------------------------------------------------
+
+GCC 2.7.2.X PROBLEMS
+
+Old versions of the GNU compiler have problems with constant strings
+containing characters with ascii codes >127. Therefore the compiler will
+fail to compile some of the translator_xx.h files. 
+A workaround, if you are planning to use the English translation only, 
+is to configure doxygen with the --english-only option.  
+
 -----------------------------------------------------------------------------
 
 That's it!
@@ -180,4 +214,4 @@ The latest version of doxygen can be obtained at
 
 Enjoy,
 
-Dimitri van Heesch (01 September 1999)
+Dimitri van Heesch (03 October 1999)