Commit 8768a9c1 authored by felix s's avatar felix s

README update

- fix sentence structure
- capitalize some words
- add a reference to release scheme explanation
parent 7d332cf9
......@@ -4,37 +4,39 @@ With the arrival of the shared library, the gnucap package has been split into
several packages.
The the new gnucap package replace the former package in terms of
functionality. /usr/bin/gnucap has become a thin executable, which
functionality. The program /usr/bin/gnucap has become a tiny executable that
- no longer statically links the default plugins, but they are
loaded by default (see below) and with
- most functionality transferred to libgnucap.
- plugin choices can be overridden in /etc/gnucap.rc.
- Plugin choices can be overridden in /etc/gnucap.rc.
The library is libgnucap.so.0. it is expected not to change in relevant ways,
but if it does, will move to libgnucap.so.1. This will not break programs
linked against libgnucap.so.0, but it may affect the creation of new plugins
for these programs.
gnucap-default-plugins0 contains the default plugins. these are installed into
/usr/lib/<multiarch>/gnucap0/. The "0" indicates the relation to libgnucap0.
This is the library, these plugins have been tested with. In the past, plugins
have been forward compatible. libgnucap provides a plugin loader, it loads from
the path specified in the environment variable GNUCAP_PLUGPATH (colon
separated, first wins, like PATH, PYTHONPATH etc.).
The package gnucap-default-plugins0 contains the default plugins. These are
installed to /usr/lib/<multiarch>/gnucap0/. The "0" indicates the relation to
libgnucap0. This is the library, these plugins have been tested with. In the
past, plugins have been forward compatible. The library libgnucap provides a
command for loading plugins. It loads from the path specified in the
environment variable GNUCAP_PLUGPATH (colon separated, first wins, like PATH,
PYTHONPATH etc.).
/usr/bin/gnucap sets the GNUCAP_PLUGPATH environment to
/usr/lib/<multiarch>/gnucap0, if empty. This is where further packages are
expected to install plugins to. Other programs are expected to query
"gnucap-conf --pkglibdir" at configure time, hardwire that in a similar way,
and set the environment accordingly. gnucap-conf is provided by the
gnucap-common package.
The program /usr/bin/gnucap sets the GNUCAP_PLUGPATH environment to
/usr/lib/<multiarch>/gnucap0, if its empty or unset. This is where further
packages are expected to install plugins to. Other programs are expected to
query "gnucap-conf --pkglibdir" at configure time, hardwire that in a similar
way, and set the environment accordingly, when making use of the load command
in libgnucap. gnucap-conf is provided by the gnucap-common package.
gnucap-common contains some architecture independent files, headers, and
/usr/bin/gnucap-conf. This package determines the place where additional plugins
should be installed to, `gnucap-conf --pkglibdir`. This makes sense, because
plugins are compiled against the headers from this very package.
The gnucap-common package contains some architecture independent files,
headers, and /usr/bin/gnucap-conf. This package determines the place where
additional plugins should be installed to, `gnucap-conf --pkglibdir`. This
makes sense, because plugins are compiled against the headers from this very
package.
The libgnucap-dev package ships the development library symlink, necessary to
build/link programs similar to /usr/bin/gnucap.
build/link programs with the functionality of /usr/bin/gnucap.
-- Felix Salfelder <felix@salfelder.org>, April 2018
this package repo has three branches.
This package repo has three branches.
- master the packageing branch
- upstream the "master" branch in the upstream repo [1]
- pristine-tar storing tarballs..
a ddmmyyyy tag in the upstream repository is to be considered a release.
A ddmmyyyy tag in the upstream repository is to be considered a release [2].
"""
Then it sits in unstable [now "develop"] a few weeks waiting for complaints,
and other merges that may follow in short time. Then, if it's good, it goes to
"master" and gets a date tag. So this can be "considered stable" and is the
version most people should use.
"""
the source tarball can be checked out with
The source tarball can be checked out with
$ pristine-tar checkout ../gnucap_0.36~20171003.orig.tar.gz
create a new tarball from git with
Create a new tarball from git with
$ ./debian/rules get-orig-source
build the package with
Build the package with
$ dpkg-buildpackage -rfakeroot
(other tools might work as well.)
[1] git://git.sv.gnu.org/gnucap.git
[2] https://www.mail-archive.com/gnucap-devel@gnu.org/msg01153.html
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment