/[debian-med]/trunk/community/website/docs/policy.xml
ViewVC logotype

Diff of /trunk/community/website/docs/policy.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 6354 by plessy, Mon Mar 21 12:46:23 2011 UTC revision 6399 by tille, Wed Mar 30 07:35:52 2011 UTC
# Line 113  Line 113 
113                    the Subversion tags take a disproportionated size, when the maintainer is                    the Subversion tags take a disproportionated size, when the maintainer is
114                    much more comfortable with Git than Subversion, when some special features of                    much more comfortable with Git than Subversion, when some special features of
115                    Git or git-buildpackage are desired, or more simply when the maintainer wants                    Git or git-buildpackage are desired, or more simply when the maintainer wants
116                    to thake the opportunity to familiarise with Git.                    to take the opportunity to familiarise with Git.
117                  </para>                  </para>
118                  <warning id="umask">                  <warning id="umask">
119                          <para>                          <para>
120                                  For most direct operaitons on the repositories in Alioth, an <command>umask</command> of <literal>002</literal> is necessary to avoid problems of missing write permission to the other team members.                                  For most direct operations on the repositories in Alioth, an <command>umask</command> of <literal>002</literal> is necessary to avoid problems of missing write permission to the other team members.
121                          </para>                          </para>
122                  </warning>                  </warning>
123                  <sect2 id="source">                  <sect2 id="source">
124                          <title>Give me the source!</title>                          <title>Give me the source!</title>
125                          <para>                          <para>
126                                  To check sources out from our repostitories, please do:                                  To check sources out from our repositories, please do:
127                                  <itemizedlist>                                  <itemizedlist>
128                                          <listitem>                                          <listitem>
129                                                  <para>                                                  <para>
# Line 305  lintian ../build-area/*changes</programl Line 305  lintian ../build-area/*changes</programl
305                                  </para>                                  </para>
306                                  <para>                                  <para>
307                                          Debian releases are tagged with names like                                          Debian releases are tagged with names like
308                                          <literal>debian/debianversion</literal> and upstream relases are                                          <literal>debian/debianversion</literal> and upstream releases are
309                                          tagged with names like <literal>upstream/upstreamversion</literal>.                                          tagged with names like <literal>upstream/upstreamversion</literal>.
310                                  </para>                                  </para>
311                          </sect3>                          </sect3>
# Line 313  lintian ../build-area/*changes</programl Line 313  lintian ../build-area/*changes</programl
313                                  <title>Social Git</title>                                  <title>Social Git</title>
314                                  <para>                                  <para>
315                                    For some projects, like the ones hosted on <ulink                                    For some projects, like the ones hosted on <ulink
316                                    url="http://www.github.com">Github</ulink> or <ulink                                    url="http://www.github.com">GitHub</ulink> or <ulink
317                                    url="http://www.gitorious.com">Gitorious</ulink>, it may be easier to                                    url="http://www.gitorious.com">Gitorious</ulink>, it may be easier to
318                                    forward changes made in the Debian package if this one is itself                                    forward changes made in the Debian package if this one is itself
319                                    hosted on the same platform, as a clone. In that case, the layouts                                    hosted on the same platform, as a clone. In that case, the layouts
# Line 430  get-orig-source: Line 430  get-orig-source:
430                          </para>                          </para>
431                          <para>                          <para>
432                                  To make <command>git-buildpackage</command> builds the package with a                                  To make <command>git-buildpackage</command> builds the package with a
433                                  chroot, you can add the folowwing to the configuration file <filename>~/.gbp.conf</filename> or <filename>debian/gbp.conf</filename>:<programlisting>                                  chroot, you can add the following to the configuration file <filename>~/.gbp.conf</filename> or <filename>debian/gbp.conf</filename>:<programlisting>
434  [DEFAULT]  [DEFAULT]
435  builder = ~/bin/git-pbuilder  builder = ~/bin/git-pbuilder
436  cleaner = fakeroot debian/rules clean  cleaner = fakeroot debian/rules clean
# Line 459  rm ../*_source.changes</programlisting> Line 459  rm ../*_source.changes</programlisting>
459                    <para>There is no easy way to prepare a Git repository from our Subversion repository that would                    <para>There is no easy way to prepare a Git repository from our Subversion repository that would
460                          look like the package was always managed in Git, because we use svn-buildpackage with the                          look like the package was always managed in Git, because we use svn-buildpackage with the
461                          mergeWithUpstream property set, which excludes the upstream sources. Nevertheless, the                          mergeWithUpstream property set, which excludes the upstream sources. Nevertheless, the
462                          following receipe will genearate a Git repostitory that contains all the history of                          following recipe will generate a Git repository that contains all the history of
463                          the debian directory, plus a collection of selected upstream source releases.                          the debian directory, plus a collection of selected upstream source releases.
464                    </para>                    </para>
465                      <itemizedlist>                      <itemizedlist>
# Line 480  rm ../*_source.changes</programlisting> Line 480  rm ../*_source.changes</programlisting>
480                  <sect2 id="updating-git-package">                  <sect2 id="updating-git-package">
481                    <title>Updating a source package managed with Git</title>                    <title>Updating a source package managed with Git</title>
482                    <para>Most source packages maintained as Git repositories in Debian Med are using the <command>git-buildpackage</command> helper toolkit. In doubt, try this one first.</para>                    <para>Most source packages maintained as Git repositories in Debian Med are using the <command>git-buildpackage</command> helper toolkit. In doubt, try this one first.</para>
483                    <para><command>git-buildpackage</command>'s command <command>git-import-orig</command> allows very easy update of the <emphasis>upstream</emphasis> branch when the original sources are distributed as a compressed archive. Its option <command>--pristine-tar</command> is useful for stablizing the MD5 sum of the “<filename>orig.tar.gz</filename>” produced when building a source package from the repository alone (not doing so results in archive rejection of package updates). With recent versions of git-buildpackage, it is often unnecessary to rename the freshly downloaded original upstream archive.</para>                    <para><command>git-buildpackage</command>'s command <command>git-import-orig</command> allows very easy update of the <emphasis>upstream</emphasis> branch when the original sources are distributed as a compressed archive. Its option <command>--pristine-tar</command> is useful for stabilizing the MD5 sum of the “<filename>orig.tar.gz</filename>” produced when building a source package from the repository alone (not doing so results in archive rejection of package updates). With recent versions of git-buildpackage, it is often unnecessary to rename the freshly downloaded original upstream archive.</para>
484                  </sect2>                  </sect2>
485          </sect1>          </sect1>
486          <sect1 id="packaging">          <sect1 id="packaging">
# Line 540  rm ../*_source.changes</programlisting> Line 540  rm ../*_source.changes</programlisting>
540                                  <listitem>                                  <listitem>
541                                  <formalpara>                                  <formalpara>
542                                          <title>Uploaders</title>                                          <title>Uploaders</title>
543                                          <para>Please add yourelf as an uploader when you have a significant interest in a package. Being Uploader means that you are expected to answer to the bug reports. For more occasional works, you can do a <ulink url="http://www.debian.org/doc/developers-reference/pkgs#nmu-team-upload">team upload</ulink>.                                          <para>Please add yourself as an uploader when you have a significant interest in a package. Being Uploader means that you are expected to answer to the bug reports. For more occasional works, you can do a <ulink url="http://www.debian.org/doc/developers-reference/pkgs#nmu-team-upload">team upload</ulink>.
544                                          </para>                                          </para>
545                                  </formalpara>                                  </formalpara>
546                                  </listitem>                                  </listitem>
# Line 579  Vcs-Browser: http://git.debian.org/?p=de Line 579  Vcs-Browser: http://git.debian.org/?p=de
579    
580                  <sect2 id="debian-copyright">                  <sect2 id="debian-copyright">
581                          <title><filename>debian/copyright</filename></title>                          <title><filename>debian/copyright</filename></title>
582                          <para>We use the <ulink url="http://wiki.debian.org/Proposals/CopyrightFormat">proposed machine-readable format</ulink> for the <filename>debian/copyright</filename> file. The <computeroutput>Source</computeroutput> field does not need to contain the full URL to the particular version that is being packaged, since this can be determined by the <command>uscan</command> program with the <filename>debian/watch</filename> file. Please list yourself in the <computeroutput>Files: debian/*</computeroutput> section if you think that your contributions are not trivial and therefore subjected to copyright. Please chose a license that is compatible with the program you package. You can also use <quote>same as if it were in the public domain</quote> or <quote>same as the packaged program itself</quote>.</para>                          <para>We use the <ulink url="http://wiki.debian.org/Proposals/CopyrightFormat">proposed machine-readable format</ulink>
583                                  for the <filename>debian/copyright</filename> file. The <computeroutput>Source</computeroutput> field does not
584                                  need to contain the full URL to the particular version that is being packaged, since this can be determined by
585                                  the <command>uscan</command> program with the <filename>debian/watch</filename> file. Please list yourself in the
586                                  <computeroutput>Files: debian/*</computeroutput> section if you think that your contributions are not trivial and
587                                  therefore subjected to copyright. Please chose a license that is compatible with the program you package. You can
588                                  also use <quote>same as if it were in the public domain</quote> or <quote>same as the packaged program itself</quote>.
589                            </para>
590                            <para>To verify the correct syntax of the <filename>debian/copyright</filename> file you can use</para>
591                            <blockquote><userinput>
592                                  <command>config-edit -application dpkg-copyright -ui none</command>
593                            </userinput></blockquote>
594                  </sect2>                  </sect2>
595    
596                  <sect2 id="debian-changelog">                  <sect2 id="debian-changelog">
# Line 588  Vcs-Browser: http://git.debian.org/?p=de Line 599  Vcs-Browser: http://git.debian.org/?p=de
599                  </sect2>                  </sect2>
600                  <sect2 id="debian-readme-source">                  <sect2 id="debian-readme-source">
601                          <title><filename>debian/README.source</filename></title>                          <title><filename>debian/README.source</filename></title>
602                          <para>This file is recommended by the Policy (<ulink url="http://www.debian.org/doc/debian-policy/ch-source.html#s-readmesource">§ 4.14</ulink>) from version 3.8.0 for documenting source package handling. Please follow the recommendation. For instance, this file is needed when we use a patch system, when the upstream sources are in another format than gzipped tar achive, when we repack the sources,…</para>                          <para>This file is recommended by the Policy (<ulink url="http://www.debian.org/doc/debian-policy/ch-source.html#s-readmesource">§ 4.14</ulink>) from version 3.8.0 for documenting source package handling. Please follow the recommendation. For instance, this file is needed when we use a patch system, when the upstream sources are in another format than gzipped tar archive, when we repack the sources,…</para>
603                  </sect2>                  </sect2>
604    
605                  <sect2 id="debhelper">                  <sect2 id="debhelper">
# Line 598  Vcs-Browser: http://git.debian.org/?p=de Line 609  Vcs-Browser: http://git.debian.org/?p=de
609                          touch packages only because it has an older Debhelper version.</para>                          touch packages only because it has an older Debhelper version.</para>
610                          <para>                          <para>
611                          It is strongly recommended to use the short <emphasis>dh</emphasis> notation in <filename>debian/rules</filename> files which makes code factorisation very                          It is strongly recommended to use the short <emphasis>dh</emphasis> notation in <filename>debian/rules</filename> files which makes code factorisation very
612                          simple and easy to understand the packaging for other members of the team.  Even complex packaging becomes quite transparant this way.                          simple and easy to understand the packaging for other members of the team.  Even complex packaging becomes quite transparent this way.
613                          </para>                          </para>
614                  </sect2>                  </sect2>
615    
# Line 634  Vcs-Browser: http://git.debian.org/?p=de Line 645  Vcs-Browser: http://git.debian.org/?p=de
645                                          class="directory">/git/debian-med</filename> directory on Alioth and                                          class="directory">/git/debian-med</filename> directory on Alioth and
646                                          created with the <link                                          created with the <link
647                                          linkend="create-git-repository-on-alioth"><command>setup-repository</command></link>                                          linkend="create-git-repository-on-alioth"><command>setup-repository</command></link>
648                                          script available there.                                          script available there.  There, they must give write access to the
649                                            <literal>debian-med</literal> Alioth group and all the Debian
650                                            Developers, with appropriate Unix permissions (including SGID bit on
651                                            directories) and ACLs.  See <filename class="directory">/git/debian-med</filename>
652                                            itself as an example.  <command>setup-repository</command> does this
653                                            automatically.
654                                  </para>                                  </para>
655                                  <para>                                  <para>
656                                          Git repositories managed with a helper tool should announce it.  For                                          Git repositories managed with a helper tool should announce it.  For
# Line 666  Vcs-Browser: http://git.debian.org/?p=de Line 682  Vcs-Browser: http://git.debian.org/?p=de
682                          <title>The Debian Med Blend tasks</title>                          <title>The Debian Med Blend tasks</title>
683                          <para>                          <para>
684                                  Once you injected a new package please make sure that it is mentioned                                  Once you injected a new package please make sure that it is mentioned
685                                  in the apropriate tasks file in the SVN source of the                                  in the appropriate <link linkend="tasks">tasks</link> file in the SVN
686                                  <package>debian-med</package> Blend package.  Some team members watch                                  source of the <package>debian-med</package> Blend package.  Some team
687                                  the changes in the Debian Med packaging pool but it helps if the                                  members watch the changes in the Debian Med packaging pool but it helps
688                                  maintainer of a new package verifies that everything is in the right                                  if the maintainer of a new package verifies that everything is in the
689                                  place.                                  right place.
690                          </para>                          </para>
691                  </sect2>                  </sect2>
692                  <sect2 id="building-and-tagging">                  <sect2 id="building-and-tagging">

Legend:
Removed from v.6354  
changed lines
  Added in v.6399

  ViewVC Help
Powered by ViewVC 1.1.5