[med-svn] r9469 - trunk/community/website/docs
Charles Plessy
plessy at alioth.debian.org
Sat Jan 28 07:19:46 UTC 2012
Author: plessy
Date: 2012-01-28 07:19:45 +0000 (Sat, 28 Jan 2012)
New Revision: 9469
Modified:
trunk/community/website/docs/policy.xml
Log:
Using formalpara for better separation and hover messages in the browsers.
Modified: trunk/community/website/docs/policy.xml
===================================================================
--- trunk/community/website/docs/policy.xml 2012-01-28 06:59:00 UTC (rev 9468)
+++ trunk/community/website/docs/policy.xml 2012-01-28 07:19:45 UTC (rev 9469)
@@ -324,10 +324,11 @@
<sect2 id="git-tips">
<title>Git tips</title>
- <para id="new-repository-with-gbp">
- To create a new local git repository for a package where the upstream
- sources are distributed as compressed <command>tar</command> archives
- (<literal>tar.gz</literal>, …).<programlisting>
+ <formalpara id="new-repository-with-gbp">
+ <title>To create a new local git repository</title>
+ <para>
+ When the upstream sources are distributed as compressed <command>tar</command> archives
+ (<literal>tar.gz</literal>, …):<programlisting>
<command>mkdir</command> <filename class="directory">package</filename>
<command>cd</command> <filename class="directory">package</filename>
<command>git init</command>
@@ -340,83 +341,100 @@
<literal>pristine-tar</literal> tool during the package build process to
recreate the original tarball, and <literal>upstream</literal>, which
will contain the upstream source.
- </para>
- <para id="debcheckout-sets-git-options">
- Configure Git to commit using your packager name and address. The
- <option>--global</option> option is to say Git these
+ </para>
+ </formalpara>
+ <formalpara id="debcheckout-sets-git-options">
+ <title>Configure Git to commit using your packager name and address</title>
+ <para>The <option>--global</option> option is to say Git these
are the default parameters for every Git repository you commit to,
without it the settings will be per-repository only:<programlisting>
<command>git config</command> <option><optional>--global</optional></option> <option>user.name "$DEBFULLNAME"</option>
<command>git config</command> <option><optional>--global</optional></option> <option>user.email "$DEBEMAIL"</option></programlisting>
- </para>
- <para id="debcheckout-git-track">
- To clone and follow every branch of a git repository containing a
- package that is already in the Debian archive, you can use the
+ </para>
+ </formalpara>
+ <formalpara id="debcheckout-git-track">
+ <title>To clone and follow every branch of a git repository</title>
+ <para>When the package is already in the Debian archive, you can use the
<command>debcheckout</command> command with its
<command><option>--git-track='*'</option></command> option. To restrict
the tracked branch to the standard ones used by
<command>git-buildpackage</command>, <literal>master upstream
pristine-tar</literal> can be passed instead of the wildcard.
- </para>
- <para id="git-track-new-branches">
- Example commands to track new branches: <programlisting>
+ </para>
+ </formalpara>
+ <formalpara id="git-track-new-branches">
+ <title>Example commands to track new branches</title>
+ <para><programlisting>
<command>git branch</command> <option>-t <replaceable>upstream</replaceable> <replaceable>origin/upstream</replaceable></option>
<command>git branch</command> <option>-t <replaceable>pristine-tar</replaceable> <replaceable>origin/pristine-tar</replaceable></option></programlisting>
- </para>
- <para id="git-options-devscripts">
- If the <package>devscripts</package> variables
- <varname>DEBEMAIL</varname> and <varname>DEBFULLNAME</varname> are set,
- <command>debcheckout</command> will set <command>git</command>'s options
- <varname>user.email</varname> and <varname>user.name</varname>
- accordingly.
- </para>
- <para id="git-add-alioth-branch">
- To push changes to Alioth, a remote branch needs to be configured. This
+ </para>
+ </formalpara>
+ <formalpara id="git-options-devscripts">
+ <title>Set the <package>devscripts</package> variables
+ <varname>DEBEMAIL</varname> and <varname>DEBFULLNAME</varname></title>
+ <para><command>debcheckout</command> will then set
+ <command>git</command>'s options <varname>user.email</varname> and
+ <varname>user.name</varname> accordingly.
+ </para>
+ </formalpara>
+ <formalpara id="git-add-alioth-branch">
+ <title>To push changes to Alioth</title>
+ <para>A remote branch needs to be configured. This
is done automatically after cloning a repository, for instance with
<link linkend="debcheckout-git-track">debcheckout</link>. The default
remote branch is called <quote>origin</quote>. Here are example
commands to set up Alioth as a remote branch on a freshly created
repository:<programlisting>
<command>git remote add</command> <literal>origin</literal> <filename class="directory">git+ssh://git.debian.org/git/debian-med/package.git</filename></programlisting>
- </para>
- <para id="create-git-repository-on-alioth">
- To create a new empty bare repository on Alioth, where to push changes,
- connect to <literal>git.debian.org</literal>, enter the
+ </para>
+ </formalpara>
+ <formalpara id="create-git-repository-on-alioth">
+ <title>To create a new empty bare repository on Alioth, where to push changes</title>
+ <para>Connect to <literal>git.debian.org</literal>, enter the
<filename class="directory">/git/debian-med</filename> directory,
and run <code><command>./setup-repository</command>
<option>packagename</option> <option>"Description of the
package"</option></code>. It will create a <filename
class="directory">packagename.git</filename> repository on with the
proper hooks set up for our team.
- </para>
- <para id="push-package-to-alioth">
- To push the package (make sure you've added the alioth remote!), do the
+ </para>
+ </formalpara>
+ <formalpara id="push-package-to-alioth">
+ <title>To push the package</title>
+ <para>(make sure you've added the alioth remote!), do the
following: <code><command>git push</command> <option>origin
master</option></code>. For the first push, it's necessary to specify
<option>origin master</option>. The next time you will push, a
<command>git push</command> will suffice.
- </para>
- <para id="git-push-all-tags">
- <command>git push</command>this will only push the
- <literal>master</literal> branch unless it is somehow related to other
- branches), so be sure to also do a run with <option>--all</option>, and one with <option>--tags</option> if you created new tags.
- </para>
- <para id="git-tag-release">
- To tag a release:
- <code><command>git tag</command> <option>debian/x.y-z</option></code>.
+ </para>
+ </formalpara>
+ <formalpara id="git-push-all-tags">
+ <title>To push all your work</title>
+ <para>Be sure to also do a run <command>git push</command> with
+ <option>--all</option>, and one with <option>--tags</option> if you
+ created new tags.
+ </para>
+ </formalpara>
+ <formalpara id="git-tag-release">
+ <title>To tag a release</title>
+ <para><code><command>git tag</command> <option>debian/x.y-z</option></code>.
You can also easily retroactively make tags:
<code><command>git tag</command> <option>debian/x.y-z</option> <option><commit hash></option></code>.
Remember to <code><command>git push --tags</command></code>.
- </para>
- <para id="git-layout-variants">
- In particular for Git repositories that are not stored in Alioth, the
+ </para>
+ </formalpara>
+ <formalpara id="git-layout-variants">
+ <title>Layout variants</title>
+ <para>In particular for Git repositories that are not stored in Alioth, the
layout can differ from <command>git-buildpackage</command> conventions.
In that case, look for instance for a branch called <literal>debian</literal>.
- </para>
- <para id="git-debian-version-from-commit">
- If upstream manages his sources with Git, the following makefile
- script can help producing a version number when no Git tag is
- available:<programlisting>
+ </para>
+ </formalpara>
+ <formalpara id="git-debian-version-from-commit">
+ <title>If upstream manages his sources with Git</title>
+ <para>
+ The following makefile script can help producing a version number when
+ no Git tag is available:<programlisting>
SOURCEPKG=$(shell dpkg-parsechangelog | sed -n 's/^Source: \(.*\)/\1/p')
UPSTREAM=$(shell dpkg-parsechangelog | sed -n 's/^Version: \(.*\)-[^-]*/\1/p')
SHA1=$(lastword $(subst ~g, ,$(UPSTREAM)))
@@ -427,26 +445,31 @@
get-orig-source:
git archive --format=tar $(SHA1) | gzip -9 > ../$(ORIG)</programlisting>
- </para>
- <para id="git-pbuilder">
- To make <command>git-buildpackage</command> build the package with
- <command>pdebuild</command>, you can add the following to the
- configuration file <filename>~/.gbp.conf</filename> or
- <filename>debian/gbp.conf</filename>:<programlisting>
+ </para>
+ </formalpara>
+ <formalpara id="git-pbuilder">
+ <title>To make <command>git-buildpackage</command> build the package with
+ <command>pdebuild</command></title>
+ <para>
+ Add the following to the configuration file
+ <filename>~/.gbp.conf</filename> or
+ <filename>debian/gbp.conf</filename>:<programlisting>
[DEFAULT]
builder = ~/bin/git-pbuilder</programlisting>
- With this configuration file you're specifying that
- <command>git-buildpackage</command> will use
- <filename>~/bin/git-pbuilder</filename> as the builder script. This is
- an example script you can use:<programlisting>
+ With this configuration file you're specifying that
+ <command>git-buildpackage</command> will use
+ <filename>~/bin/git-pbuilder</filename> as the builder script.
+ This is an example script you can use:<programlisting>
#!/bin/sh
set -e
pdebuild --pbuilder cowbuilder --debbuildopts "-i\.git -I.git $*"
rm ../*_source.changes</programlisting>
- This will build the package inside the default cowbuilder chroot, while
- passing any more parameters directly do <command>dpkg-buildpackage</command>.
- </para>
+ This will build the package inside the default cowbuilder chroot,
+ while passing any more parameters directly do
+ <command>dpkg-buildpackage</command>.
+ </para>
+ </formalpara>
</sect2>
<sect2 id="subversion-to-git">
More information about the debian-med-commit
mailing list