r29 - /web/deps/dep4.mdwn
codehelp at users.alioth.debian.org
codehelp at users.alioth.debian.org
Thu Mar 19 21:28:39 UTC 2009
Author: codehelp
Date: Thu Mar 19 21:28:39 2009
New Revision: 29
URL: http://svn.debian.org/wsvn/dep/?sc=1&rev=29
Log:
Add a toc using the plugin and tidy up some DEP formatting.
Modified:
web/deps/dep4.mdwn
Modified: web/deps/dep4.mdwn
URL: http://svn.debian.org/wsvn/dep/web/deps/dep4.mdwn?rev=29&op=diff
==============================================================================
--- web/deps/dep4.mdwn (original)
+++ web/deps/dep4.mdwn Thu Mar 19 21:28:39 2009
@@ -12,18 +12,28 @@
progress. Online version: http://people.debian.org /~codehelp/tdeb
Source SGML: /~codehelp/tdeb/Draft.sgml
+[[!toc levels=2]]
+
+---
+
# TDeb Specification
+
---
This is where the Draft TDeb Specification, created at the ftp-master/i18n
meeting in Extremadura, will be developed and improved.
+---
+
## Motivation
+
---
1. Updates to translations should not require source NMU's.
-2. Translation data should not be distributed in architecture-dependent packages.
-3. Translators should have a common interface for getting updates into Debian (possibly with automated TDeb generation after i18n team review).
+2. Translation data should not be distributed in architecture-dependent
+packages.
+3. Translators should have a common interface for getting updates into
+Debian (possibly with automated TDeb generation after i18n team review).
## Version 0.0.2
@@ -36,14 +46,15 @@
* Frank Lichtenheld <email>djpig at debian.org</email>,
* partially based on dpkg man pages, © by the original authors.
-This document 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 2 of the License, or (at your
-option) any later version.
-
-For more details, on Debian GNU/Linux systems, see the file
-/usr/share/common-licenses/GPL for the full license.
-</copyright>
+ This document 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 2 of the License, or (at your
+ option) any later version.
+
+ For more details, on Debian GNU/Linux systems, see the file
+ /usr/share/common-licenses/GPL-2 for the full license.
+
+---
# Format of binary translation packages (tdeb)
@@ -91,46 +102,53 @@
with something other than underscores, or will (more likely) cause the
major version number to be increased.
+---
+
# Source format
## +t1.diff.gz
TDebs will use a source format for translation updates that will not
-cause any changes in the package binaries. The foo_1.2.3-4+t1.diff.gz will be
-created for changes made by translators and tools will need to apply the
-translation diff after applying the .diff.gz prepared (and signed) by the
-Debian maintainer.
-
-The +t[0-9] update will need to be built from the source package but only details
-changes in the translated content. No changes will be allowed in the package
-binaries or untranslated content.
-
-Translation updates are source-package based and translation updates are denoted
-by the +t[0-9] suffix where 0 is assumed to be the original upload by the
-Debian maintainer.
+cause any changes in the package binaries. The foo_1.2.3-4+t1.diff.gz
+will be created for changes made by translators and tools will need to
+apply the translation diff after applying the .diff.gz prepared
+(and signed) by the Debian maintainer.
+
+The +t[0-9] update will need to be built from the source package but
+only details changes in the translated content. No changes will be
+allowed in the package binaries or untranslated content.
+
+Translation updates are source-package based and translation updates
+are denoted by the +t[0-9] suffix where 0 is assumed to be the original
+upload by the Debian maintainer.
e.g. for a non-native package foo:
-> source version 1.2.3-4,
-> the first TDeb update would be foo_1.2.3-4+t1
-> the changes from -4 to -4+t1 will be in foo_1.2.3-4+t1.diff.gz
-
-BinNMU versions are not affected as it is
-source based.
+
+ source version 1.2.3-4,
+ the first TDeb update would be foo_1.2.3-4+t1
+ the changes from -4 to -4+t1 will be in foo_1.2.3-4+t1.diff.gz
+
+BinNMU versions are not affected as it is source based.
The +t1.diff.gz needs dpkg support which is being implemented:
New translations and translation fixes are currently tracked in the BTS.
-Tdeb uploads shall be able to close those bugs. Using a changelog might be the easiest way.
-During the transition, those bugs will remain. After the transition, those bugs
-will go away so there should be no need for a closure method. We'll need to
-rely on i18n.debian.org for translation tracking after Squeeze.
+Tdeb uploads shall be able to close those bugs. Using a changelog might
+be the easiest way.
+
+During the transition, those bugs will remain. After the transition,
+those bugs will go away so there should be no need for a closure method.
+We'll need to rely on i18n.debian.org for translation tracking after
+Squeeze.
+
+---
# TDeb contents
## What goes into a TDeb?
-(With the exception of debconf templates, untranslated content remains in the
-original package).
+(With the exception of debconf templates, untranslated content remains
+in the original package).
* Translations from upstream -/usr/share/locale/*/LC_MESSAGES/*.mo
* Other localisation files from upstream - /usr/share/locale/*/LC_*/*
@@ -139,7 +157,7 @@
* Translated manpages
* Translated info documents (if supported by info)
-* Translated documentation<item>With provisos that packages with
+* Translated documentation. With provisos that packages with
large amounts of translated documentation and debconf templates
would create two tdebs, one minimal tdeb for debconf and one for
the rest.
@@ -193,30 +211,37 @@
will be included into the TDeb.
Packages will no longer be able to have unactivated or unused translations.
-(This is a debhelper / other packaging tool implementation problem, not a dpkg one)
+(This is a debhelper / other packaging tool implementation problem, not
+a dpkg one)
As a result of this requirement, the debhelper tdeb tool (dh_gentdeb)
-handles finding the translations, preparing the binary translation files and moving the
-translations to suitable directories within the package build.
-
-##TDebs and binary packages
-
-The filesystem contents of TDebs and their associated binary packages must be
-mutually exclusive, so that dpkg doesn't need any special replace handling.
-We will still need some Replaces for the transition, but that can be
-handled like any other Replaces.
+handles finding the translations, preparing the binary translation
+files and moving the translations to suitable directories within the
+package build.
+
+## TDebs and binary packages
+
+The filesystem contents of TDebs and their associated binary packages
+must be mutually exclusive, so that dpkg doesn't need any special
+replace handling. We will still need some Replaces for the transition,
+but that can be handled like any other Replaces.
## Migrating packages to TDeb support
+
Maintainers will need to make a variety of changes to support TDebs:
* Replaces Add the recommended $src-tdeb package name with
Replaces: $binaries (<< $srcversion)
where $srcversion is a fixed string for the version prior to TDebs
-> e.g. Replaces: apt (<< 0.7.19), apt-utils (<< 0.7.19)
+
+ e.g. Replaces: apt (<< 0.7.19), apt-utils (<< 0.7.19)
+
* Remove translated content from all *.install files in debian/
* Remove any lines in debian/rules that handle translated content
* Ensure that dh_gentdeb is called in debian/rules (CDBS will be
patched to implement this support automatically).
+
+---
# Resolution of corner cases
@@ -231,10 +256,11 @@
translations, it <strong>must</strong> have a tdeb named after the
source package (suffixed with -tdeb) and all
debconf templates must be placed in it. Such a package should place all
-architecture independent documentation (even in the native language) into a tdeb.
-If a package contains documentation which is not always required (for
-example API documentation or user documentation), the source package
-may provide additional ${source}-${foo}-tdeb_$version_all.tdeb files.
+architecture independent documentation (even in the native language)
+into a tdeb. If a package contains documentation which is not always
+required (for example API documentation or user documentation), the
+source package may provide additional
+${source}-${foo}-tdeb_$version_all.tdeb files.
If tdebs are revised by the translation teams, the suffix +t[0-9]+
must be used and all tdebs for the source package must be revised
@@ -248,8 +274,10 @@
with -tdeb appended.
In the case of Translation-Version: 1 or higher, the tdeb name is
-${source}-tdeb_$version+t[0-9]+_all.tdeb. Additional tdebs are referenced in the
-Packages file in the following way: Additional-Translations: ${source}-api-tdeb, ${source}-user-tdeb
+${source}-tdeb_$version+t[0-9]+_all.tdeb. Additional tdebs are
+referenced in the Packages file in the following way:
+Additional-Translations: ${source}-api-tdeb, ${source}-user-tdeb
+
In cases where a base tdeb is present, package managers *must* call
dpkg with the tdeb and the deb in the same invocation in order to ensure that
all debconf templates can be extracted before the config script is run.
@@ -282,12 +310,14 @@
## PO translations
-* No source changes - The Tdeb packages should not add messages not related to a message of the
-original source package. How to check this? If there is a POT file, then it is
-possible to do the comparison with the gettext msg* tools. POT file will not be
-in the tdeb, only in the main source package. When a PO file is modified,
-lintian can get the POT file of the same directory from the source package.
-* msgfmt warnings - Modification of upstream PO files should be avoided. A warning could be produced.
+* No source changes - The Tdeb packages should not add messages not
+related to a message of the original source package. How to check this?
+If there is a POT file, then it is possible to do the comparison with
+the gettext msg* tools. POT file will not be in the tdeb, only in the
+main source package. When a PO file is modified, lintian can get the
+POT file of the same directory from the source package.
+* msgfmt warnings - Modification of upstream PO files should be avoided.
+A warning could be produced.
* File naming rules
* Location of PO files in the source package (+t1.diff.gz)
* Location of mo files in the binary packages (tdeb)
@@ -300,8 +330,8 @@
Rather than allow repeat uploads of the same change in multiple
languages, coordinate builds of tdebs to make a single upload with as
-many changes as possible at one time. Translation-Maintainers: in debian/control
-and Localisation Assistants.
+many changes as possible at one time. Translation-Maintainers: in
+debian/control and Localisation Assistants.
# TDeb implementation
@@ -353,7 +383,7 @@
for specific locale roots).
* dpkg-source building support - (partially implemented in git)
* debhelper support for both tdebs explicitly, and also marking files into
- classes in general (partially implemented via dh_gentdeb in git)
+classes in general (partially implemented via dh_gentdeb in git)
* provide a patch to cdbs for running dh_gentdeb in the right place.
(Done - only remains for the patch to be filed and applied, after Lenny).
* apt/aptitude support for pulling in and removing tdebs
@@ -366,10 +396,12 @@
desktop.)
We do need the toolchain changes in squeeze so we can enable use
- of it in squeeze+1.
+of it in squeeze+1.
# Changes
-----
2009-03-08 - [Neil Williams]
* Convert to DEP.
+2009-03-19 - [Neil Williams]
+* Add a table of contents via ikiwiki
More information about the dep-commits
mailing list