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

Mon Jun 11 09:45:13 CEST 2012

Author: lckarssen
Date: 2012-06-11 09:45:12 +0200 (Mon, 11 Jun 2012)
New Revision: 915

Modified:
   pkg/ProbABEL/doc/CHANGES.LOG
   pkg/ProbABEL/doc/INSTALL
   pkg/ProbABEL/doc/packaging.txt
Log:
Minor updates to ProbABEL documentation with respect to installing and packaging.

Modified: pkg/ProbABEL/doc/CHANGES.LOG
===================================================================

--- pkg/ProbABEL/doc/CHANGES.LOG	2012-06-10 20:43:24 UTC (rev 914)
+++ pkg/ProbABEL/doc/CHANGES.LOG	2012-06-11 07:45:12 UTC (rev 915)
@@ -28,6 +28,7 @@
 - The PDF of the LaTeX documentation is now only generated if the
   pdflatex binary can be found. So now we also build the documentation
   using autotools.
+- On 32bit Linux systems ProbABEL can now also use large (>4GB) input files.
 
 
 * ProbABEL uses autoconf and automake now (thanks to Lennart).
@@ -45,45 +46,13 @@
 
   This will install the binaries (palinear etc.) in /usr/local/bin/,
   the documentation in /usr/local/share/doc/probabel/, the
-  probabel_config.cfg file in /usr/local/etc/, and the examples in
+  probabel_config.cfg.example file in /usr/local/etc/, and the examples in
   /usr/local/share/ProbABEL/examples/. 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.
 
-  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).
+  For more information see the file doc/INSTALL.
 
-  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.
-
-  The second important option is
-./configure --enable-pacoxph
-  this enables the building of the pacoxph binary.
-
-  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

Modified: pkg/ProbABEL/doc/INSTALL
===================================================================
--- pkg/ProbABEL/doc/INSTALL	2012-06-10 20:43:24 UTC (rev 914)
+++ pkg/ProbABEL/doc/INSTALL	2012-06-11 07:45:12 UTC (rev 915)
@@ -12,6 +12,7 @@
   following commands:
 ./configure
 make
+make check
 make install
 
   This will install the binaries (palinear etc.) in /usr/local/bin/,
@@ -22,12 +23,9 @@
   PDF version of the documentation will not be built.
 
   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).
+  already exists. By default the name of the probabel.pl config file is
+  probabel_config.cfg.example. For probabel.pl to work please rename
+  this file to probabel_config.cfg.
 
   To see options, run
 
@@ -39,6 +37,11 @@
   to install ProbABEL in that subdirectory. Instead of using
   /usr/local/ as install root directory, it installs in /some/subdirectory.
 
+  The pacoxph binary will not be built by default because it is too
+  buggy at present. If you want to build and install it anyway use the
+  --enable function of ./configure:
+./configure --enable-pacoxph
+
   To generate a .tar.gz package for distribution run:
 ./configure
 make dist
@@ -56,6 +59,9 @@
 
   will uninstall the files previously installed by 'make install'.
 
+* Making packages for Linux distributions
+  Instructions for creating a package for your favourite Linux
+  distribution can be found in doc/packaging.txt
 
 * Cross-compiling for Windows on Linux
 

Modified: pkg/ProbABEL/doc/packaging.txt
===================================================================
--- pkg/ProbABEL/doc/packaging.txt	2012-06-10 20:43:24 UTC (rev 914)
+++ pkg/ProbABEL/doc/packaging.txt	2012-06-11 07:45:12 UTC (rev 915)
@@ -16,15 +16,15 @@
    If there are no errors, a tar.gz file of the source should be
    created. Let's create the package.
     mkdir /tmp/PA-deb
-    cp ProbABEL-0.2.0-beta.tar.gz /tmp/PA-deb
+    cp ProbABEL-0.2.0.tar.gz /tmp/PA-deb
     cd /tmp/PA-deb
    Debian packages must have lowercase letters, so we'll have to rename
    the directory after untar-ing it.
-    tar -xzf ProbABEL-0.2.0-beta.tar.gz
-    mv ProbABEL-0.2.0-beta probabel-0.2-0-beta
-    cd probabel-0.2.0-beta
+    tar -xzf ProbABEL-0.2.0.tar.gz
+    mv ProbABEL-0.2.0 probabel-0.2-0
+    cd probabel-0.2.0
     dh_make --single --email youremail at example.com \
-     --file ../ProbABEL-0.2.0-beta.tar.gz --copyright gpl2 \
+     --file ../ProbABEL-0.2.0.tar.gz --copyright gpl2 \
      --packagename probabel
 
    Hit the enter key to confirm the settings. Several files need to be
@@ -35,12 +35,12 @@
    - debian/README.Debian
    dh_make also creates several example scripts in the debian/
    directory. We don't need them, so they can be delete:
-    rm debian/*.ex
-   Now the package can be built:
+    rm debian/*.ex debian/*.EX
+   Now the package can be built (NOTE that dpkg-buildpackage replaces our default CXXFLAGS with "-g -O2"):
     dpkg-buildpackage -rfakeroot -us -uc
-   This creates a ~.deb~ file in the parent directory. As a
+   This creates an unsigned ~.deb~ file in the parent directory. As a
    final touch you can check you package for errors with
-    lintian ../probabel_0.2.0-beta-1_amd64.deb
+    lintian ../probabel_0.2.0-1_amd64.deb
    Several warnings will show up (e.g. binaries without man-pages),
    but we ignore these for now. If you are interested in a more
    detailed explanation of the warnings, add the -i option to the
@@ -48,3 +48,10 @@
    These last two commands can be run in one go using debuild (which
    is part of the devscripts package):
     debuild -i -us -uc -b
+** Uploading to an Ubuntu PPA (Personal Package Archive)
+   Building a package for upload to a PPA is almost the same as shown above:
+    debuild -i -S -kYOURKEYID
+   where YOURKEYID is the ID of the gpg key you use for signing your
+   package (this key should be known by launchpad).
+   To upload the package created above to the GenABEL PPA simply type:
+    dput ppa:l.c.karssen/genabel-ppa ../probabel_0.2.0-1_source.changes

