[policy] 02/05: Some clarifications about the packaging process

[Sylvestre Ledru]

This is an automated email from the git hooks/post-receive script.

sylvestre pushed a commit to branch master
in repository policy.

commit 302c0ea06a562f9d2b61191cf8221dd373f382c4
Author: Pablo de Oliveira <pablo at sifflez.org>
Date:   Fri Aug 16 01:53:48 2013 +0200

    Some clarifications about the packaging process
    
     * Clarify that /git/ is mounted read-only on alioth.debian.org
       and one should log into git.debian.org instead.
    
     * Give the reportbug syntax to put debian-maintainers in CC when
       filling a new ITP bug
    
     * Fix example to activate post-update hook in git
    
     * Add a link to gpb in section Package Repositories
---
 debian-science-policy.xml |   21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/debian-science-policy.xml b/debian-science-policy.xml
index 5a14131..a20a780 100644
--- a/debian-science-policy.xml
+++ b/debian-science-policy.xml
@@ -155,7 +155,8 @@ can be found in /usr/share/common-licenses/GPL.
     <para><emphasis>&DebSci; Repository</emphasis> means the location where all package repositories are stored.</para>
     <sect2>
       <title>The &DebSci; Repository</title>
-      <para>The &DebSci; Repository is located on &Alioth; in the directory <filename>/git/debian-science/</filename>. All group members have write access to the directory.</para>
+      <para>The &DebSci; Repository is located on &Alioth; in the directory <filename>/git/debian-science/</filename>.
+      All group members have write access to the directory when logged on <ulink url="ssh://git.debian.org/">git.debian.org</ulink> but the <filename>/git/</filename> directory is mounted as read-only when logged on <ulink url="ssh://alioth.debian.org">alioth.debian.org</ulink>.</para>
       <para>The &DebSci; Repository is structured by a directory hierarchy containing several Git Repositories and other directories. It is structured like this:</para>
 <screen>
 debian-science/
@@ -176,15 +177,16 @@ debian-science/
       <para>The following sections explain the preferred Package Repository layout.</para>
       <sect3>
 	<title>Repository Layout and Structure</title>
-	<para>Each Package Repository has to be stored as bare Git Repository inside the <filename>packages/</filename> sub-directory of the &DebSci; Repository.</para>
-	<para>The Package Repository name has to be the name of the source package followed by a ".git" extension. A source package named "foo" is therefore stored in a Package Repository named "foo.git".</para>
+	<para>Each Package Repository has to be stored as a bare Git Repository inside the <filename>packages/</filename> sub-directory of the &DebSci; Repository.</para>
+	<para>The Package Repository name has to be the name of the source package followed by a <filename>.git</filename> extension. A source package named <filename>foo</filename> is therefore stored in a Package Repository named <filename>foo.git</filename>.</para>
       </sect3>
       <sect3>
 	<title>Branches</title>
 	<para>All Package Repositories should contain a common set of branches in order to ease maintenance.</para>
-	<para>All Debian-specific changes (such as the <filename>debian/</filename> directory) should go to a branch named <emphasis>debian</emphasis> or <emphasis>master</emphasis>. If you use several branches to organize your changes, the <emphasis>debian</emphasis> branch should be treated as integration branch.</para>
+	<para>All Debian-specific changes (such as the <filename>debian/</filename> directory) should go to a branch named <emphasis>debian</emphasis> or <emphasis>master</emphasis>. If you use several branches to organize your changes, the <emphasis>debian</emphasis> branch should be treated as the integration branch.</para>
 	<para>If upstream sources are included in the Package Repository they should be stored in a branch named <emphasis>upstream</emphasis>. It can either store upstream sources from a VCS or source tar-ball snapshots.</para>
 	<para>It is recommended to use <ulink url="http://packages.debian.org/pristine-tar">pristine-tar</ulink> to be able to restore upstream tar-balls from the source files in the Package Repository. The delta files produced by pristine-tar should be stored in the <emphasis>pristine-tar</emphasis> branch.</para>
+  <para><ulink url="http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.html">Git-buildpackage</ulink> follows the above branch conventions and automates the process of importing upstream snapshots.</para>
       </sect3>
       <sect3>
 	<title>Tags</title>
@@ -224,7 +226,13 @@ $ chmod 0775 hooks/post-receive
     <title>ITP/RFP reports</title>
 	  <sect2>
 	    <title>Intend To Package (ITP)</title>
-		    <para>When a Debian Science Maintainer is sending an ITP to the BTS, <email>debian-science-maintainers at lists.alioth.debian.org</email> should one of the receiver of this ITP. Therefore, members of the team will be informed of the on-going work and could provide help.</para>
+
+		    <para>When a Debian Science Maintainer is sending an ITP to the BTS, <email>debian-science-maintainers at lists.alioth.debian.org</email> should one of the receiver of this ITP. Therefore, members of the team will be informed of the on-going work and could provide help.
+         If using <ulink url="http://packages.debian.org/reportbug">reportbug</ulink> to file the ITP, this can be accomplished with the following command:</para>
+<screen><![CDATA[
+reportbug --list-cc=debian-science-maintainers at lists.debian.org wnpp
+]]></screen>
+
 		    <para>Also please include the pseudo-headers:
 	<screen><![CDATA[
 User: debian-science at lists.debian.org
@@ -370,7 +378,7 @@ $ git checkout -b bug-123456 upstream/1.0
     <sect2>
       <title>Publishing Your Repository</title>
       <para>This section will explain how to publish a repository in the &DebSci; scope but should be easy to adopt for other teams or locations.</para>
-      <para>First, login to &Alioth; and create a new shared bare repository:</para>
+      <para>First, login to <ulink url='ssh://git.debian.org'>git.debian.org</ulink> and create a new shared bare repository:</para>
       <screen><![CDATA[
 $ cd /git/debian-science/packages/
 $ mkdir foo.git && cd foo.git
@@ -378,6 +386,7 @@ $ git --bare init --shared=all
 ]]></screen>
       <para>You should also active the post-update-hook to allow checkouts via HTTP.</para>
       <screen><![CDATA[
+$ mv hooks/post-update.sample hooks/post-update
 $ chmod 0775 hooks/post-update
 ]]></screen>
       <note><para>It is not recommended to use Git over HTTP but it may be handy for people behind a firewall.</para></note>

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/policy.git