From 9cc3d3332489090cbbe0292d4ec03016e7e95241 Mon Sep 17 00:00:00 2001 From: Juan RP Date: Mon, 24 Feb 2014 11:21:54 +0100 Subject: [PATCH] doc/manual.txt: add a section about development packages. --- doc/manual.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/manual.txt b/doc/manual.txt index 207f6db342..81e31a3850 100644 --- a/doc/manual.txt +++ b/doc/manual.txt @@ -100,6 +100,23 @@ All subpackages need an additional symlink to the `main` pkg, i.e: Otherwise dependencies requiring those packages won't find its `template` file. +Development packages +~~~~~~~~~~~~~~~~~~~~ +A development package, commonly generated as a subpackage, shall only contain +files required for development, that is, headers, static libraries, shared +library symlinks, pkg-config files, API documentation or any other script +that is only useful when developping for the target software. + +A development package should depend on packages that are required to link +against the provided shared libraries, i.e if `libfoo` provides the +`libfoo.so.2` shared library and the linking needs `-lbar`, the package +providing the `libbar` shared library should be added as a dependency; +and most likely it shall depend on its development package. + +If a development package provides a `pkg-config` file, you should verify +what dependencies the package needs for dynamic or static linking, and add +the appropiate `development` packages as dependencies. + Package build phases -------------------- Building a package consist of the following phases: