Move contents of debian/README into debian/README.source

svn path=/dists/trunk/linux-2.6/; revision=14773
This commit is contained in:
Ben Hutchings 2009-12-12 00:53:57 +00:00
parent b12d2c8be3
commit dd74fc7666
2 changed files with 34 additions and 35 deletions

34
debian/README vendored
View File

@ -1,34 +0,0 @@
Kernel config files
-------------------
Configuration files are constructed dynamically from a number of config
files, as listed in debian/config/<arch>/defines.
Control file
------------
The master control file debian/control must be generated before
the package is uploaded. debian/rules contains the debian/control
target, which generates the control file by invoking the
debian/bin/gencontrol.py script, which combines the templates from
the templates directory and architecture-specific defines file to
produce the debian/control file. Note that this target is intentionally
made to fail with a non-zero exit code to make sure that it is never
run during an automatic build. The following variables are substituted
into the templates:
@version@ Upstream kernel version, for example 2.6.11.
@major@ The major version, for example 2.6
@arch@ The Debian arch name, such as powerpc or i386.
@flavour@ The build flavour, such as 686 or k7-smp.
@class@ The CPU/architecture class; displayed in synopsis. It should
be fairly short, as the synopsis is supposed to be <80 chars.
It should be in the form "foo class", and will show up in the
description as "foo class machines".
@longclass@ The CPU/architecture class; displayed in the extended
description. The same rules apply as in @class@. If
this is unset, it will default to @class@.
@desc@ (Potentially) multi-line verbiage that's appended to
-image descriptions.
@abiname@ Current abiname, a single digit.
Normally, the arch-specific contents should be controlled by
adjusting the corresponding defines file.

35
debian/README.source vendored
View File

@ -39,10 +39,43 @@ of 2.6.26-12:
The same syntax applies for specifing the patches, but an additional The same syntax applies for specifing the patches, but an additional
argument is needed which specifies the featureset the patch applies to. argument is needed which specifies the featureset the patch applies to.
Kernel config files
===================
Configuration files are constructed dynamically from a number of config
files, as listed in debian/config/<arch>/defines.
Control file
============
The master control file debian/control must be generated before
the package is uploaded. debian/rules contains the debian/control
target, which generates the control file by invoking the
debian/bin/gencontrol.py script, which combines the templates from
the templates directory and architecture-specific defines file to
produce the debian/control file. Note that this target is intentionally
made to fail with a non-zero exit code to make sure that it is never
run during an automatic build. The following variables are substituted
into the templates:
@version@ Upstream kernel version, for example 2.6.11.
@major@ The major version, for example 2.6
@arch@ The Debian arch name, such as powerpc or i386.
@flavour@ The build flavour, such as 686 or k7-smp.
@class@ The CPU/architecture class; displayed in synopsis. It should
be fairly short, as the synopsis is supposed to be <80 chars.
It should be in the form "foo class", and will show up in the
description as "foo class machines".
@longclass@ The CPU/architecture class; displayed in the extended
description. The same rules apply as in @class@. If
this is unset, it will default to @class@.
@desc@ (Potentially) multi-line verbiage that's appended to
-image descriptions.
@abiname@ Current abiname, a single digit.
Normally, the arch-specific contents should be controlled by
adjusting the corresponding defines file.
TODO: TODO:
- Generating DFSG tarballs - Generating DFSG tarballs
- How to define a flavour - How to define a flavour
- Generation of debian/control and configs - More detail on generation of debian/control and configs