[Debian-astro-commits] [iraf] 01/03: Update README.Debian; create TODO list

[Ole Streicher]

This is an automated email from the git hooks/post-receive script.

olebole pushed a commit to branch master
in repository iraf.

commit 5a85a8462461b0a4d08d12dc714bb90f53f63199
Author: Ole Streicher <olebole at debian.org>
Date:   Thu Nov 23 10:54:10 2017 +0100

    Update README.Debian; create TODO list
---
 debian/README.Debian | 56 ++++++++++++++++++++++++++--------------------------
 debian/TODO          | 35 ++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+), 28 deletions(-)

diff --git a/debian/README.Debian b/debian/README.Debian
index 3699acd..260cd88 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -1,39 +1,39 @@
-Important deviations from the original package:
+This package is not directly based on the original IRAF tarball, but
+on a fork created by Ole Streicher. Deviations from the original code
+are not Debian specific and include bugfixes, removal of non-free
+code, and code cleanup. All changes are proposed as pull requests on
+the IRAF github repository https://github.com/iraf/iraf-v216
 
-* The programs cl, ecl, generic, rpp, xpp, and xyacc had to be renamed to
-  iraf-cl, iraf-generic, iraf-rpp, iraf-xpp, and iraf-yacc to avoid
-  conflicts with other binaries. Aliases can be used to bring the original 
-  names back, f.e. in the .bashrc
-
-    alias cl=iraf-cl
-    alias ecl=raf-ecl
-    alias generic=iraf-generic
-    alias rpp=iraf-rpp
-    alias xpp=iraf-xpp
-    alias xyacc=iraf-xyacc
-
-  or in the .cshrc
-
-    alias cl iraf-cl
-    alias ecl raf-ecl
-    alias generic iraf-generic
-    alias rpp iraf-rpp
-    alias xpp iraf-xpp
-    alias xyacc iraf-xyacc
+Debian specific adoptions made in the Debian package include:
 
 * The directory structur is changed according to the FHS and the
   freedesktop.org recommendations:
 
     /usr/share/iraf/                 - IRAF root dir ($iraf)
-    /usr/lib/iraf/                   - Architecture dependent files ($iraf_b)
-    /usr/include/iraf.h              - Include file
+    /usr/lib/<arch>/iraf/            - Binaries and libs ($ibin, $hbin)
     ${HOME}/.cache/iraf/             - Cache directory ($cachedir)
     ${HOME}/.share/local/iraf/imdir/ - Images directory ($imdir)
 
-* There is still no development package. Some development files are in
-  iraf and iraf-common; however they are not complete.
+* Since many IRAF development commands conflict with commands from
+  other packages, they are not in /usr/bin/, but in
+  /usr/lib/iraf/bin. You may prepend this directory to the PATH
+  environment variable if you need to use them directly. This may be
+  done by sourcing /usr/share/iraf/unix/hlib/setup.sh. Include the
+  following lines in your ~/.bashrc to make this permanent:
+
+      if [ -e /usr/share/iraf/unix/hlib/setup.sh ] ; then
+          source /usr/share/iraf/unix/hlib/setup.sh
+      fi
+
+* The user commands are installed in /usr/bin/, but cl/ecl had to be
+  renamed to "irafcl". If your source setup.sh as described above, cl
+  and ecl aliases are created as well.
+
+     irafcl                  - starts IRAF ecl in the current window
+     mkiraf                  - setup the IRAF environment for a user
+     sgidispatch	     - execute named sgi translator
 
-* The vo subpackage is currently not build since its dependencies (Aladin,
-  topcal, samp, voclient) are not in Debian.
+* Different from the original binary distributions, the source code is
+  not included in the binary packages.
 
- -- Ole Streicher <debian at liska.ath.cx>  Mon, 03 Jun 2013 16:15:00 +0200
+-- Ole Streicher <olebole at debian.org>
diff --git a/debian/TODO b/debian/TODO
new file mode 100644
index 0000000..44e27d3
--- /dev/null
+++ b/debian/TODO
@@ -0,0 +1,35 @@
+
+* implement directory structure as described in README
+
+    $ibin:  $iraf/bin.$arch/      --> /usr/lib/$archtriplet/iraf/
+    $hbin:  $iraf/unix/bin.$arch/ --> /usr/lib/$archtriplet/iraf/unix/
+    $nbin:  $iraf/noao/bin.$arch/ --> /usr/lib/$archtriplet/iraf/noao/
+
+* symlink all relevant binaries to /usr/lib/iraf/bin/
+
+    iraf-dev                - xc, xyacc, rpp, generic, mkpkg, xpp
+    not (maintenance only)  - rmfiles, mkmlist, rtar, rmbin, wtar
+
+* Prepend /usr/lib/iraf/bin to PATH in irafuser.sh and in all
+  developer commands (so that if one starts, it finds the others).
+   
+* Symlink the user commands to /usr/bin
+
+    iraf-common             - irafcl, mkiraf, sgidispatch
+
+* Add aliases "cl", "ecl" to iraf-cl in setup.sh. Fix "iraf" alias to
+  work with xterm as well.
+   
+* Run unit tests on build and as CI
+
+* Update manpages. Also keep the manpages for IRAF internal commands
+
+* Allow parallel installation of 32-bit binary packages, and let them
+  work nicely together (f.e. for STSCI tables)
+
+* Make user package work without /usr/include/iraf.h
+
+* Strip more unnecessary files (development examples and such) from
+  /usr/share/iraf 
+
+* Check portability: little endian will probably work.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-astro/packages/iraf.git