.\" English manual page for dh_ada_library .\" .\" Copyright (C) 2012-2015 Nicolas Boulenguez .\" .\" This program is free software: you can redistribute it and/or .\" modify it under the terms of the GNU General Public License as .\" published by the Free Software Foundation, either version 3 of the .\" License, or (at your option) any later version. .\" This program is distributed in the hope that it will be useful, but .\" WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU .\" General Public License for more details. .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see . .\" .TH DH_ADA_LIBRARY 1 "2015-10-19" .\"---------------------------------------------------------------------- .SH NAME dh_ada_library \- help packaging Ada libraries for Debian .\"---------------------------------------------------------------------- .SH SYNOPSIS .B dh_ada_library .RI [\| "debhelper options" \|] .RI [\|[\| variable=value " .\|.\|.\|] " project.gpr \|] " .\|.\|." .\"---------------------------------------------------------------------- .SH DESCRIPTION .B dh_ada_library is a debhelper program that handles some common tasks in packaging libraries written in the Ada programming language. .PP Each .I project.gpr argument designates a GNAT project file building a shared library provided by the source package. .\" Since using environment variables in such projects is common practice, a list of variable assignments may be provided before each project. .PP \fBdh_ada_library\fR reads each project file and extracts the following information from it: library name, imported projects, source directories, library directory, object directory (containing ALI files) and linker options (both \fILeading_Library_Options\fR and \fILibrary_Options\fR). .\" Then it parses .I debian/control to check that three package names exist conforming to the Coexistence Not Allowed naming scheme described in the \fBDebian Policy for Ada\fR and extracts the ALI files version (\fIaliversion\fR)) and the shared library version (\fIsoversion\fR). .\" Then, \fBdh_ada_library\fR processes each of the three packages as follows: .\"---------------------------------------------------------------------- .SS Runtime library package \fBdh_ada_library\fR installs the shared library (mode 644) into the package then, if \fIdebian/control\fR mentions a \-dbg package, runs package then runs .B dh_strip with options storing its debugging information into the \-dbg package. .PP If the shared library declares its stack executable, \fBdh_ada_library\fR generates a lintian override for the runtime library package about GNAT using trampolines for exception handling. .\" .B dh_lintian is run first so that it will not overwrite the override file later. .\"---------------------------------------------------------------------- .SS Debugging symbols (\-dbg) package The file \fI/usr/share/doc/dh-ada-policy/README.Debian\fR describes how to provide the same service with less efforts. .PP If \fIdebian/control\fR ments a \-dbg package, the .IR ada:Depends , .IR ada:Recommends , .I ada:Suggests substitution variables receive values reflecting that the \-dbg package depends on the library package, recommends the \-dev package and suggests the .I gnat package. .PP Versions <= 5.3 used to replace the documentation directory with a symbolic link to the one in the runtime library package, but usage has shown that linking directories caused upgrade problems. .\" If a binary package built with such a version has been released, the source package should add maintainer scripts as described in https://wiki.debian.org/MissingCopyrightFile. .\"---------------------------------------------------------------------- .SS Development package (\-dev) First, \fBdh_ada_library\fR installs the usual development symbolic link (*.so\-> *.so.\fIsoversion\fR), ALI files (mode 444) and sources (mode 644) into the \-dev package. .\" Languages other than Ada listed in the project file are taken into account, whether they have been previously dealt with by \fIgprbuild\fR, or ignored by \fIgnatmake\fR and compiled separately. .\" Then it looks for a file named .IR lib LIBRARY_NAME .a (the static library) in the current directory or its subdirectories and installs this file (mode 644) into the \-dev package. .PP A second project file, intended for use by programs linking against the library, is generated and installed into the \-dev package. .\" The \fILinker\fR package of the new project inherits any .B \-l or .B \-L linker options from \fILeading_Library_Options\fR and \fILibrary_Options\fR attributes of the build project file. .PP Each renaming exception is transmitted to the generated project. .PP \fBdh_ada_library\fR runs .B dh_strip before installing the static library so that the latter keeps its debugging information. .PP The .I ada:Depends substitution variable receives a value reflecting that the package depends on .IR gnat , .I gnat\-X.Y and the library package. .\" For each imported library project recognized, either as already processed or installed on the build system by .BR dpkg\-query , a dependency is added into \fIada:Depends\fR and the generated project is added the corresponding \fIwith\fR line. In the case of an already processed project within the same source package, the dependency mandates an exact \fIbinary:Version\fR, ensuring that all static libraries are compiled with compatible options. .\"---------------------------------------------------------------------- .SH REMARKS This program does not belong to the debhelper suite. .\" To activate it, please run the .B dh sequencer with the .I \-\-with\ ada\-library option. .PP The .I Library_Version project attribute is purposedly ignored. .\" Instead, the soname is guessed from the library package name. .\" For projects needing an external variable definition to set this attribute, any arbitrary value may be given. .\" This will often allow the maintainer to use a simple .I debian/ada_libraries file instead of a debhelper override or an environment variable exportation. .PP Both libraries and ALI files are installed into .IR /usr/lib/ DEB_HOST_MULTIARCH, the project and sources into .IR /usr/share/ada/adainclude . .\" This implies that the \-dev package cannot be declared .I Multi-Arch: same as the content of the project (and maybe of generated sources) will vary across architectures. .\"---------------------------------------------------------------------- .SH FILES .TP .I debian/ada_libraries Projects and variables, in addition to those in the command line if called directly from \fIdebian/rules\fR. .\" Line breaks are considered as normal spaces. .\" This may change in the future and it is recommended to put exactly one affectation or project on each line. .\" Any line starting with a dash will be ignored. .\"---------------------------------------------------------------------- .SH OPTIONS Common debhelper command line options and environment variables are recognized. .\"---------------------------------------------------------------------- .SH EXAMPLES dh_ada_library 'DIRS=src gen SOVERSION=ignored foo.gpr \-\-verbose \-\-no\-act .\"---------------------------------------------------------------------- .SH SEE ALSO .BR debhelper (7), .BR dh_installdocs (1), .BR dh_lintian (1), .BR dh_strip (1), .BR deb\-substvars (5), the .B Debian Policy for Ada available at http://people.debian.org/~lbrenta/debian\-ada\-policy.html. .\"---------------------------------------------------------------------- .SH AUTHOR .B dh_ada_library and this manpage were written by Nicolas Boulenguez for the Debian project (and may be used by others).