[Debian-olpc-devel] "readme.source and readme.cdbs" ( was?Re:?Bug#485233: Path still broken in 23-2

[Jonas Smedegaard]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Mon, Feb 02, 2009 at 02:31:46PM +0100, Holger Levsen wrote:
>Hi,
>
>On Montag, 2. Februar 2009, Jonas Smedegaard wrote:
>> If you mean that the cdbs Subersion branch should be extended to contain
>> info on how to package using git-buildpackage and the specific
>> additional branches used by Sugar, then no. That's the wrong way around.
>
>I mean it should document how to use these tweaks in packages and how to 
>modify them.

Why?

Debian Policy recommends documenting specific packaging aspects in 
README.source, not all aspects of packaging.

cdbs provides skeleton routines that would otherwise be written directly 
into debian/rules. Only for the cases that cdbs-provided routines 
implement aspects of packaging covered by README.source should such 
routines be documented in order to be compliant with current Policy.

Example: for packages using quilt for patches, README.source of that 
package should refer to /usr/share/doc/quilt/README.source for details 
on that (or duplicate similar info in its own README.source, but 
referring is good enough as it is offline too). It is not necessary to 
document how quilt has been enabled indirectly through a cdbs snippet 
rather than directly by the quilt-provided snippet, and it is not 
necessary to document additional quilt-related features provided by cdbs 
(like taking care of build-dependencies).

I believe you are talking about a "nice to have", not a "should have".


  - Jonas

- -- 
* Jonas Smedegaard - idealist og Internet-arkitekt
* Tlf.: +45 40843136  Website: http://dr.jones.dk/

  [x] quote me freely  [ ] ask before reusing  [ ] keep private
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)

iEYEARECAAYFAkmG+5IACgkQn7DbMsAkQLiB9gCfWtsxH2OTx+WADljoOxkU6Kvf
8eYAoJgr6McSrjNqKrPxOPSAPK1ax2IN
=YUgF
-----END PGP SIGNATURE-----