[med-svn] [Git][med-team/easel][master] 5 commits: Fix build of the reference guide

Andreas Tille (@tille) gitlab at salsa.debian.org
Wed Nov 11 19:23:44 GMT 2026



Andreas Tille pushed to branch master at Debian Med / easel


Commits:
ac76250e by Andreas Tille at 2026-11-11T20:13:36+01:00
Fix build of the reference guide

Upstream 0.49 removed esl_vectorops.tex and esl_getopts.tex (converted to
.md) but main.tex still \input them. It also stopped tagging the msaweight
and dirichlet cexcerpt snippets, and dirichlet_mixdchlet now lives in
esl_mixdchlet.h, which was not in MODULES.

Skip bibtex (no .bib files are shipped). Run all pdflatex passes in
nonstopmode: the doc comments contain Markdown fences and unescaped
]/\_/#, so pdflatex reports errors and exits nonzero but still writes the
PDF. Fail only when no PDF was produced, which still catches a missing
\input.

- - - - -
fdfb1439 by Andreas Tille at 2026-11-11T20:17:08+01:00
Build libeasel as a shared library

New libeasel0 package with the runtime library (SONAME libeasel.so.0) and
libeasel-dev with the linker symlink, headers and a pkg-config file. The
library is linked from libeasel.a with --whole-archive so every module is
exported; --enable-pic gives the objects -fPIC.

Build the shared library before dh_auto_build so the miniapps link against
it instead of the static archive, and export LD_LIBRARY_PATH so they also
run against it during make check.

- - - - -
31c9eee4 by Andreas Tille at 2026-11-11T20:17:16+01:00
Fix easel-doc contents for 0.49

Upstream renamed 00README to README.md.

- - - - -
80978172 by Andreas Tille at 2026-11-11T20:17:16+01:00
easel-apps: install the man pages from debian/tmp

Upstream's make install puts the pages in /usr/share/man/man1 itself, so
dh_installman never sees them; claim them via easel-apps.install and drop
the stale easel-apps.manpages that pointed at miniapps/*.1. Also depend on
mpi-default-dev in libeasel-dev: the shared library links MPI and the
public esl_mpi.h includes <mpi.h>.

- - - - -
f8dd90c4 by Andreas Tille at 2026-11-11T20:17:16+01:00
Strip done items from TODO

- - - - -


11 changed files:

- debian/TODO
- debian/clean
- debian/control
- debian/easel-apps.install
- − debian/easel-apps.manpages
- debian/easel-doc.docs
- + debian/easel.pc.in
- debian/libeasel-dev.install
- + debian/libeasel0.install
- debian/patches/docs.patch
- debian/rules


Changes:

=====================================
debian/TODO
=====================================
@@ -1,4 +1 @@
-adapt patches to new version
-libeasel with a shared library
-build the apps linking against the shared library
 migrate hmmer, infernal packages to use this package


=====================================
debian/clean
=====================================
@@ -1 +1,2 @@
 miniapps/*.1
+libeasel.so*


=====================================
debian/control
=====================================
@@ -17,10 +17,31 @@ Vcs-Browser: https://salsa.debian.org/med-team/easel
 Vcs-Git: https://salsa.debian.org/med-team/easel.git
 Homepage: https://github.com/EddyRivasLab/easel
 
+Package: libeasel0
+Architecture: any
+Section: libs
+Multi-Arch: same
+Depends:
+ ${shlibs:Depends},
+ ${misc:Depends},
+Description: library of C functions for biological sequence analysis (runtime library)
+ Easel is an ANSI C code library for computational analysis of
+ biological sequences using probabilistic models. Easel is used by
+ HMMER, the profile hidden Markov model software that underlies the
+ Pfam protein families database, and by Infernal, the profile
+ stochastic context-free grammar software that underlies the Rfam RNA
+ family database. Easel aims to make similar applications more robust
+ and easier to develop, by providing a set of reusable, documented, and
+ well-tested functions.
+ .
+ This package contains the shared Easel library.
+
 Package: libeasel-dev
 Architecture: any
 Section: libdevel
 Depends:
+ libeasel0 (= ${binary:Version}),
+ mpi-default-dev,
  ${misc:Depends},
 Description: library of C functions for biological sequence analysis
  Easel is an ANSI C code library for computational analysis of


=====================================
debian/easel-apps.install
=====================================
@@ -1 +1,2 @@
 usr/bin/*
+usr/share/man/man1


=====================================
debian/easel-apps.manpages deleted
=====================================
@@ -1 +0,0 @@
-miniapps/*.1


=====================================
debian/easel-doc.docs
=====================================
@@ -1,2 +1,2 @@
 documentation/current.pdf
-00README
+README.md


=====================================
debian/easel.pc.in
=====================================
@@ -0,0 +1,11 @@
+prefix=/usr
+exec_prefix=${prefix}
+libdir=@LIBDIR@
+includedir=${prefix}/include
+
+Name: easel
+Description: C library for biological sequence analysis
+Version: @VERSION@
+Libs: -L${libdir} -leasel
+Libs.private: -lm -lpthread
+Cflags: -I${includedir}/easel


=====================================
debian/libeasel-dev.install
=====================================
@@ -1,2 +1,3 @@
-usr/lib/*
-usr/include/*
+usr/lib/*/libeasel.so
+usr/lib/*/pkgconfig/easel.pc
+usr/include/easel


=====================================
debian/libeasel0.install
=====================================
@@ -0,0 +1 @@
+usr/lib/*/libeasel.so.0*


=====================================
debian/patches/docs.patch
=====================================
@@ -1,14 +1,102 @@
 Author: Michael R. Crusoe <michael.crusoe at gmail.com>
-Description: try to build the docs as best as we can
+Description: build the docs: skip bibtex (upstream ships no .bib files),
+ restore the msaweight and dirichlet examples (upstream no longer tags the
+ corresponding cexcerpt snippets), and add esl_mixdchlet to the modules
+ whose headers are excerpted
 Forwarded: https://github.com/EddyRivasLab/easel/issues/21
+Last-Update: 2026-11-11
+Assisted-By: aim2balance/a2b-code
+
 --- a/documentation/Makefile.in
 +++ b/documentation/Makefile.in
-@@ -112,7 +112,7 @@ current.pdf: symlinks.stamp autodoc.stam
+@@ -55,6 +55,7 @@
+ 	  esl_hyperexp\
+ 	  esl_keyhash\
+ 	  esl_minimizer\
++	  esl_mixdchlet\
+ 	  esl_mpi\
+ 	  esl_msa\
+ 	  esl_msacluster\
+@@ -111,10 +112,15 @@
+ 	  command -v $$prog >/dev/null 2>&1 || { echo >&2 "The $$prog program is required to build the Userguide, but it's not installed. Aborting."; exit 1; } \
  	done
  	@echo "     LATEX current.pdf  (see latex.log for output)"
- 	@pdflatex -interaction=nonstopmode main  > latex.log 2>&1
+-	@pdflatex -interaction=nonstopmode main  > latex.log 2>&1
 -	@bibtex   main                          >> latex.log 2>&1
-+	#@bibtex   main                          >> latex.log 2>&1
- 	@pdflatex main                          >> latex.log 2>&1
- 	@pdflatex main                          >> latex.log 2>&1
+-	@pdflatex main                          >> latex.log 2>&1
+-	@pdflatex main                          >> latex.log 2>&1
++	# upstream doc comments aren't clean LaTeX, so pdflatex reports errors
++	# and exits nonzero even though it produces the PDF; run all passes in
++	# nonstopmode, don't run bibtex (no .bib files), and only fail if no
++	# PDF came out (e.g. an unreadable \input).
++	- at pdflatex -interaction=nonstopmode main > latex.log 2>&1
++	#@bibtex   main                         >> latex.log 2>&1
++	- at pdflatex -interaction=nonstopmode main >> latex.log 2>&1
++	- at pdflatex -interaction=nonstopmode main >> latex.log 2>&1
++	@test -f main.pdf
  	@mv main.pdf current.pdf
+ 
+ # symlinks.stamp: if we're in a build tree, symlink the tex files.
+
+--- a/documentation/main.tex
++++ b/documentation/main.tex
+@@ -260,7 +260,7 @@
+ \ifthenelse{\boolean{completedraft}}{
+    \newpage
+    \section{\eslmodincmd{vectorops}: Vector operations}
+-   \input{esl_vectorops}
++%   \input{esl_vectorops}
+    \subsection{Functions in the vectorops module}
+    \input{autotext/esl_vectorops_functions}
+ }{}
+@@ -463,7 +463,7 @@
+ \ifthenelse{\boolean{completedraft}}{
+ \newpage
+ \section{\eslmodincmd{getopts}: command line parsing}
+-\input{esl_getopts}
++%\input{esl_getopts}
+ \subsection{Functions in the getopts module}
+ \input{autotext/esl_getopts_functions}
+ }{}
+
+--- a/esl_dirichlet.tex
++++ b/esl_dirichlet.tex
+@@ -37,13 +37,13 @@
+ 
+ \subsection{Example of using the dirichlet API}
+ 
+-An example that reads a mixture Dirichlet prior from a file, samples a
+-probability vector from it, samples a count vector from the
+-probability vector, then infers which mixture component generated the
+-data and uses mean posterior estimation to reestimate the probability
+-vector from the counts:
++An example is the \prog{esl-mixdchlet} miniapp, which fits, scores,
++samples, and generates synthetic count data with mixture Dirichlet
++priors:
+ 
+-\input{cexcerpts/dirichlet_example}
++\begin{cchunk}
++esl-mixdchlet <fit|score|gen|sample> [<args>...]
++\end{cchunk}
+ 
+ \subsection{Accessing information in the ESL\_MIXDCHLET object}
+ 
+
+--- a/esl_msaweight.tex
++++ b/esl_msaweight.tex
+@@ -35,11 +35,12 @@
+ An example of reading in a multiple alignment and calculating weights
+ for its sequences using the GSC algorithm:
+ 
+-\input{cexcerpts/msaweight_example}
++\begin{cchunk}
++esl-weight -g <msa file>
++\end{cchunk}
+ 
+ The new weights are stored internally in the \ccode{ESL\_MSA} object,
+-and (as the example shows) can be accessed in its array
+-\ccode{msa->wgt[0..nseq-1]}.
++and can be accessed in its array \ccode{msa->wgt[0..nseq-1]}.
+ 
+ \subsection{Pros and cons of different algorithms}
+ 


=====================================
debian/rules
=====================================
@@ -10,6 +10,13 @@ include /usr/share/dpkg/buildflags.mk
 
 include /usr/share/dpkg/default.mk
 
+EASEL_VERSION   = 0.49.0
+EASEL_SOVERSION = 0
+MULTIARCH      := $(shell dpkg-architecture -qDEB_HOST_MULTIARCH)
+
+# the miniapps link and run against the shared library built in this tree
+export LD_LIBRARY_PATH=$(CURDIR)
+
 %:
 	dh $@
 
@@ -18,12 +25,31 @@ override_dh_auto_configure:
 	ls miniapps/*.man | xargs sed -i 's=@RELEASEDATE@=@EASEL_DATE@=g'
 	ls miniapps/*.man | xargs sed -i 's=@PACKAGE@=@PACKAGE_NAME@=g'
 	ls miniapps/*.man | xargs sed -i 's=@RELEASE@=@EASEL_VERSION@=g'
-	dh_auto_configure -- --enable-mpi CC=mpicc # --with-gsl
+	dh_auto_configure -- --enable-mpi --enable-pic CC=mpicc # --with-gsl
 	ls miniapps/*.man | xargs sed -i 's=\.PP=\.pp=g'
 
 override_dh_auto_build:
 	chmod a+x devkit/cexcerpt
+	$(MAKE) libeasel.a
+	# build libeasel.so first, so that dh_auto_build links the miniapps
+	# against it (ld prefers the shared library in -L.. over libeasel.a)
+	mpicc $(CPPFLAGS) $(CFLAGS) $(LDFLAGS) -shared \
+		-Wl,-soname,libeasel.so.$(EASEL_SOVERSION) \
+		-o libeasel.so.$(EASEL_VERSION) \
+		-Wl,--whole-archive libeasel.a -Wl,--no-whole-archive -lm -lpthread
+	ln -sf libeasel.so.$(EASEL_VERSION) libeasel.so.$(EASEL_SOVERSION)
+	ln -sf libeasel.so.$(EASEL_SOVERSION) libeasel.so
 	dh_auto_build
-	cd documentation
-	make pdf
+	$(MAKE) -C documentation pdf || { grep -n -A5 '^!' documentation/latex.log; exit 1; }
 	chmod a-x devkit/cexcerpt
+
+override_dh_auto_install:
+	dh_auto_install
+	install -d debian/tmp/usr/lib/$(MULTIARCH)/pkgconfig debian/tmp/usr/include/easel
+	install -m644 libeasel.so.$(EASEL_VERSION) debian/tmp/usr/lib/$(MULTIARCH)/
+	ln -sf libeasel.so.$(EASEL_VERSION) debian/tmp/usr/lib/$(MULTIARCH)/libeasel.so.$(EASEL_SOVERSION)
+	ln -sf libeasel.so.$(EASEL_SOVERSION) debian/tmp/usr/lib/$(MULTIARCH)/libeasel.so
+	install -m644 *.h debian/tmp/usr/include/easel/
+	sed -e 's/@VERSION@/$(EASEL_VERSION)/' \
+	    -e 's|@LIBDIR@|/usr/lib/$(MULTIARCH)|' \
+	    debian/easel.pc.in > debian/tmp/usr/lib/$(MULTIARCH)/pkgconfig/easel.pc



View it on GitLab: https://salsa.debian.org/med-team/easel/-/compare/8d7e94ebb7b167b8537129dca53633cc061f2dd1...f8dd90c414d078659d9a56cdaa198e71a45b5e5c

-- 
View it on GitLab: https://salsa.debian.org/med-team/easel/-/compare/8d7e94ebb7b167b8537129dca53633cc061f2dd1...f8dd90c414d078659d9a56cdaa198e71a45b5e5c
You're receiving this email because of your account on salsa.debian.org. Manage all notifications: https://salsa.debian.org/-/profile/notifications | Help: https://salsa.debian.org/help


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/debian-med-commit/attachments/20261111/a84b6ad3/attachment-0001.htm>


More information about the debian-med-commit mailing list