aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorGuido Günther <agx@sigxcpu.org>2011-01-10 16:09:05 +0100
committerGuido Günther <agx@sigxcpu.org>2011-01-11 07:47:13 +0100
commit03f3d75d43458978ecc375f7e16cfc8f35b5ae99 (patch)
tree81e7ec81df5ff6a123e5f856d8c5e738c485cdd2 /docs
parent05d9ecb7e4eaf6cfc8942c5c47b6f9dde2e99459 (diff)
Make gbp-create-remote-repo a first class citizen
Add manpage, move into path, add bash completion
Diffstat (limited to 'docs')
-rw-r--r--docs/chapters/import.sgml2
-rw-r--r--docs/common.ent1
-rw-r--r--docs/man.gbp-create-remote-repo.sgml11
-rw-r--r--docs/manpages/gbp-create-remote-repo.sgml125
-rw-r--r--docs/manpages/manpages.ent1
-rw-r--r--docs/manual.sgml1
6 files changed, 140 insertions, 1 deletions
diff --git a/docs/chapters/import.sgml b/docs/chapters/import.sgml
index 079ea334..cbb88048 100644
--- a/docs/chapters/import.sgml
+++ b/docs/chapters/import.sgml
@@ -168,6 +168,6 @@ EOF
&git-import-orig; <option>-u</option> <replaceable>0.1</replaceable> <filename>../package-0.1.tar.gz</filename>
<command>dh_make</command>
</screen>
- That's it, you're done.
+ That's it, you're done. If you want to publish you're new repository you can use &gbp-create-remote-repo;.
</sect1>
</chapter>
diff --git a/docs/common.ent b/docs/common.ent
index 19fbd442..8a7e3e24 100644
--- a/docs/common.ent
+++ b/docs/common.ent
@@ -11,6 +11,7 @@
<!ENTITY gbp-pull "<command>gbp-pull</command>">
<!ENTITY gbp-clone "<command>gbp-clone</command>">
<!ENTITY gbp-pq "<command>gbp-pq</command>">
+ <!ENTITY gbp-create-remote-repo "<command>gbp-create-remote-repo</command>">
<!ENTITY gitcmd "<command>git</command>">
<!ENTITY gitkcmd "<command>gitk</command>">
<!ENTITY pbuildercmd "<command>pbuilder</command>">
diff --git a/docs/man.gbp-create-remote-repo.sgml b/docs/man.gbp-create-remote-repo.sgml
new file mode 100644
index 00000000..f46421a3
--- /dev/null
+++ b/docs/man.gbp-create-remote-repo.sgml
@@ -0,0 +1,11 @@
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+ <!ENTITY % COMMON SYSTEM "common.ent">
+ %COMMON;
+ <!ENTITY % MANPAGES SYSTEM "manpages/manpages.ent">
+ %MANPAGES;
+]>
+
+<reference>
+<title>git-buildpackage Manual</title>
+&man.gbp.create.remote.repo;
+</reference>
diff --git a/docs/manpages/gbp-create-remote-repo.sgml b/docs/manpages/gbp-create-remote-repo.sgml
new file mode 100644
index 00000000..a68b74d5
--- /dev/null
+++ b/docs/manpages/gbp-create-remote-repo.sgml
@@ -0,0 +1,125 @@
+<refentry id="gbp.man.gbp.create.remote.repo">
+ <refentryinfo>
+ <address>
+ &dhemail;
+ </address>
+ <author>
+ &dhfirstname;
+ &dhsurname;
+ </author>
+ </refentryinfo>
+ <refmeta>
+ <refentrytitle>gbp-create-remote-repo</refentrytitle>
+ &dhsection;
+ </refmeta>
+ <refnamediv>
+ <refname>&gbp-create-remote-repo;</refname>
+
+ <refpurpose>Create remote repositories</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ &gbp-create-remote-repo;
+ <arg><option>--verbose</option></arg>
+ <arg><option>--color=</option><replaceable>[auto|on|off]</replaceable></arg>
+ <arg><option>--remote-url-pattern=</option><replaceable>url-pattern</replaceable></arg>
+ <arg><option>--[no-]pristine-tar</option></arg>
+ <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
+ <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
+ <arg><option>--[no-]track</option></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+ <para>
+ &gbp-create-remote-repo; creates a repository at a remote location via ssh
+ and pushes the local repository into it. It then sets up remote branch
+ tracking so you can use &gbp-pull; to update your repo from there.
+ </para>
+ <para>
+ Note: By default the remote repositories are created in the <systemitem
+ class="groupname">collab-maint</systemitem> repository on <systemitem
+ class="systemname">alioth.debian.org</systemitem>.
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--remote-url-pattern</option>=<replaceable>pattern</replaceable>
+ </term>
+ <listitem>
+ <para>Where to create the remote repository. The part
+ <replaceable>%(pkg)s</replaceable> will be replaced by the package name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--debian-branch</option>=<replaceable>branch_name</replaceable>
+ </term>
+ <listitem>
+ <para>The branch in the Git repository the Debian package is being
+ developed on, default is <replaceable>master</replaceable>.
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--upstream-branch</option>=<replaceable>branch_name</replaceable>
+ </term>
+ <listitem>
+ <para>The branch in the &git; repository the upstream sources are put
+ onto. Default is <replaceable>upstream</replaceable>.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--pristine-tar</option>
+ </term>
+ <listitem>
+ <para>Whether to push the pristine tar branch.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--verbose</option></term>
+ <term><option>-v</option></term>
+ <listitem>
+ <para>verbose execution</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--color=</option><replaceable>[auto|on|off]</replaceable>
+ </term>
+ <listitem>
+ <para>Wheter to use colored output.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--[no-]track</option>
+ </term>
+ <listitem>
+ <para>Wheter to set up branch tracking for the debian, upstream and
+ pristine-tar branches.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <refsect1>
+ &man.git.config-files;
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>git-buildpackage</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>gbp-pull</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+
+ <para>&dhusername; &dhemail;</para>
+
+ </refsect1>
+</refentry>
diff --git a/docs/manpages/manpages.ent b/docs/manpages/manpages.ent
index 62115cfc..be577db8 100644
--- a/docs/manpages/manpages.ent
+++ b/docs/manpages/manpages.ent
@@ -6,5 +6,6 @@
<!ENTITY man.gbp.pull SYSTEM "gbp-pull.sgml">
<!ENTITY man.gbp.clone SYSTEM "gbp-clone.sgml">
<!ENTITY man.gbp.pq SYSTEM "gbp-pq.sgml">
+<!ENTITY man.gbp.create.remote.repo SYSTEM "gbp-create-remote-repo.sgml">
<!ENTITY man.git.config-files SYSTEM "man.conffiles.sgml">
<!ENTITY man.seealso.common SYSTEM "man.seealso.sgml">
diff --git a/docs/manual.sgml b/docs/manual.sgml
index 79776917..3e3add82 100644
--- a/docs/manual.sgml
+++ b/docs/manual.sgml
@@ -35,6 +35,7 @@
&man.gbp.clone;
&man.gbp.pull;
&man.gbp.pq;
+ &man.gbp.create.remote.repo;
</appendix>
<appendix id="gbp.copyleft">
<title>Copyright</title>