[Genabel-commits] r764 - pkg/ProbABEL/doc

[noreply at r-forge.r-project.org]

Author: lckarssen
Date: 2011-08-24 11:26:42 +0200 (Wed, 24 Aug 2011)
New Revision: 764

Modified:
   pkg/ProbABEL/doc/CHANGES.LOG
Log:
Updated instructions in ProbABEL's CHANGES.LOG file

Modified: pkg/ProbABEL/doc/CHANGES.LOG
===================================================================
--- pkg/ProbABEL/doc/CHANGES.LOG	2011-08-23 20:12:09 UTC (rev 763)
+++ pkg/ProbABEL/doc/CHANGES.LOG	2011-08-24 09:26:42 UTC (rev 764)
@@ -24,25 +24,50 @@
   using autotools.
 
 
-* ProbABEL uses autoconf and automake now (thanks to Lennart). Now the 
-compilation process is like this: first, from the ProbABEL directory, 
-generate documentation by
+* ProbABEL uses autoconf and automake now (thanks to Lennart). To
+  install the package from source run
 
-cd doc
+./configure
 make
-make clean_doc
-cd ..
+make install
 
-Then, run
+  This will install the binaries (palinear etc.) in /usr/local/bin/,
+  the documentation in /usr/local/share/doc/, the probabel_config.cfg
+  file in /usr/local/etc/, and the examples in
+  /usr/local/share/probabel/. The ./configure script tests for the
+  presence of the pdflatex program. If it is not present the PDF
+  version of the documentation will not be built.
 
-./configure
-make
-make install 
+  NOTE: make install will OVERWRITE any file with the same name if it
+  already exists. Also the probabel_config.cfg file in
+  /usr/local/etc, even if the user modified it with his/her own
+  settings. This is one reason why using the package manager for your
+  distribution (apt for Debian, yum for RHEL, CentOS, etc., pkgtools
+  for Slackware) is recommended. Package managers do note that a file
+  has user-made changes and ask what to do (or make a backup).
 
-To see options, run
+  To see options, run
 
 ./configure --help
 
+  The most notable option is
+./configure --prefix=/some/subdirectory
+  to install ProbABEL in that subdirectory. Instead of using
+  /usr/local/ as install root, it installs in /some/subdirectory.
+
+  To generate a .tar.gz package for distribution run:
+./configure
+make dist
+
+  To test if all your changes to the source files will be packaged
+  into the tar.gz file correctly run
+./configure
+make distcheck
+
+  To clean up all files generated by ./configure and make, run
+make distclean
+
+
 In the ProbABEL autotools integration branch:
 - Removed the old Makefile
 - Added configure.ac that servers as input for auto(re)conf