[opensuse-packaging] Suggestion: Add READMEs for version control access
I've added now a README.packaging.txt to the packages aaa_base and rpmlint to point out which files are unter version control and how to update. If you have a package that is basically maintained in a version control system, I suggest you add some information for packagers in a similar way. For reference, this is the README from aaa_base: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This package should use just the content of the git tree. If you need to make changes, you have the following options: * Make them in git and update the package from git (you can send merge request if you don't have write access) * Create a patch, add the patch to the package and let one of the aaa_base packagers commit it for you The online repository is at: http://gitorious.org/opensuse/aaa_base For building the package from git run the service directly: osc service disabledrun Note that aaa_base.spec and aaa_base.changes are not part of the git repo. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ I'm also interested in better ideas to point out the version control relationship, Andreas -- Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg) GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126 -- To unsubscribe, e-mail: opensuse-packaging+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-packaging+owner@opensuse.org
Quoting Andreas Jaeger <aj@suse.com>:
I've added now a README.packaging.txt to the packages aaa_base and rpmlint to point out which files are unter version control and how to update.
If you have a package that is basically maintained in a version control system, I suggest you add some information for packagers in a similar way.
I like having a documentation, but as packager, have to admit that I am likely not to read the README in a source tree, unless a reference to it is given in the .spec. Typical locations for such references are: - Close to the version tag (especially when it's about version updates.. then "osc diff" shows that line too) - Between Source: and Patch: tags. For the case of aaa_base, where it's about adding patches, After Source: before Patch: is likely the best point, as it mainly guarantees that the packager will see it when adding the patch line (it does not guarantee though he will read it or even understand it). Dominique -- To unsubscribe, e-mail: opensuse-packaging+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-packaging+owner@opensuse.org
On Wednesday, September 26, 2012 16:55:24 Dominique Leuenberger a.k.a DimStar wrote:
Quoting Andreas Jaeger <aj@suse.com>:
I've added now a README.packaging.txt to the packages aaa_base and rpmlint to point out which files are unter version control and how to update.
If you have a package that is basically maintained in a version control system, I suggest you add some information for packagers in a similar way.
I like having a documentation, but as packager, have to admit that I am likely not to read the README in a source tree, unless a reference to it is given in the .spec.
Typical locations for such references are: - Close to the version tag (especially when it's about version updates.. then "osc diff" shows that line too) - Between Source: and Patch: tags.
For the case of aaa_base, where it's about adding patches, After Source: before Patch: is likely the best point, as it mainly guarantees that the packager will see it when adding the patch line (it does not guarantee though he will read it or even understand it).
Good idea, let's close another hole ;) Andreas -- Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg) GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126 -- To unsubscribe, e-mail: opensuse-packaging+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-packaging+owner@opensuse.org
participants (2)
-
Andreas Jaeger -
Dominique Leuenberger a.k.a DimStar