[kernel] r6459 - people/jurij

[Jurij Smakov]

Author: jurij-guest
Date: Thu Apr 20 03:58:46 2006
New Revision: 6459

Added:
   people/jurij/module-packaging-policy.txt
Log:
Initial commit of the draft of the module packaging policy.


Added: people/jurij/module-packaging-policy.txt
==============================================================================
--- (empty file)
+++ people/jurij/module-packaging-policy.txt	Thu Apr 20 03:58:46 2006
@@ -0,0 +1,62 @@
+Packaging scheme
+----------------
+Each source package containing the out-of-tree kernel module source
+should produce the following binary packages: the binary-source
+package, containing the module source in the form suitable for
+building by module-assistant, and binary-binary packages, containing
+the binary modules, which can be used with the official kernels
+currently available in the archive.
+
+Source package
+--------------
+
+The source package should be called $(NAME)-modules, where where
+$(NAME) is unique module package identifier. It should be possible to
+build all the binary packages from the source package simply by
+invoking the 'debian/rules binary' command. In order to build the
+binary-binary module packages for all supported flavours of the
+official kernels, the source package should Build-Depend (at least) on
+the following packages:
+
+* linux-headers-$(VERSION)-all: will pull in the linux-headers for
+  all supported flavours for current architecture.
+* module-assistant: recommended tool to build the binary modules.
+* linux-support-$(VERSION)-$(ABINAME): the support scripts and
+  Makefile snippets to simplify the building of the modules for all
+  flavours. The script modules/gencontrol.py must be used to generate
+  information about available flavours, dependencies, build
+  dependencies and compiler settings for the resulting packages.
+
+
+Please see the example rules file for details.
+
+Binary-source package
+---------------------
+
+The purpose of this package is to give the users a possibility to
+build the modules for a custom-built kernel. It should be adopted for
+building with module assistant, see m-a documentation for details.
+This package should have the name $(NAME)-source. It must include all
+files necessary for building the binary modules from source against
+the official linux-headers packages. If linux-headers packages do not
+contain all the files required for a module build, these files should
+be shipped as a part of the package.
+
+Binary-binary packages
+----------------------
+
+Binary-binary packages should be named
+
+$(NAME)-linux-modules-$(VERSION)-$(ABI)-$(FLAVOUR), 
+
+where $(VERSION), $(ABI) and $(FLAVOUR) parameters should match the
+corresponding values of the official linux-image package for which the
+module is built. Each binary-binary package must depend on the exact
+version of the corresponding linux-image-$(VERSION)-$(ABI)-$(FLAVOUR)
+package. Kernel modules shipped in the package should be installed in
+/lib/modules/$(VERSION)-$(ABINAME)-$(FLAVOUR)/$(NAME) directory. The
+package should invoke 'depmod -a' in its postinst and postrm scripts,
+if the version, abiname and flavour of the kernel running at the time
+the script execution is the same as the version of the kernel the
+module has been built for. These packages should be built using
+module-assistant from the source package.