aboutsummaryrefslogtreecommitdiff
path: root/docs/manpages
diff options
context:
space:
mode:
authorGuido Guenther <agx@sigxcpu.org>2006-11-08 22:25:36 +0100
committerGuido Guenther <agx@bogon.sigxcpu.org>2006-11-08 22:25:36 +0100
commit6f94038f6ed75bb2c1798ef15a9f1642fb5a4e79 (patch)
treeb0db574b9e1b07b3fb9b4e1de1b69adce7e02571 /docs/manpages
parentc48e88ca55a8ec2c90f4846a3081c1cc136aa826 (diff)
move docs around
for the later merge of the (yet mostly unwritten) manual
Diffstat (limited to 'docs/manpages')
-rw-r--r--docs/manpages/git-buildpackage.sgml103
-rw-r--r--docs/manpages/git-import-dsc.sgml75
-rw-r--r--docs/manpages/git-import-orig.sgml99
-rw-r--r--docs/manpages/manpages.ent3
4 files changed, 280 insertions, 0 deletions
diff --git a/docs/manpages/git-buildpackage.sgml b/docs/manpages/git-buildpackage.sgml
new file mode 100644
index 0000000..913b629
--- /dev/null
+++ b/docs/manpages/git-buildpackage.sgml
@@ -0,0 +1,103 @@
+<refentry id="gbp.man.git.buildpackage">
+ <refentryinfo>
+ <address>
+ &dhemail;
+ </address>
+ <author>
+ &dhfirstname;
+ &dhsurname;
+ </author>
+ <copyright>
+ <year>2006</year>
+ <holder>&dhusername;</holder>
+ </copyright>
+ &dhdate;
+ </refentryinfo>
+ <refmeta>
+ <refentrytitle>git-buildpackage</refentrytitle>
+ &dhsection;
+ </refmeta>
+ <refnamediv>
+ <refname>&git-buildpackage;</refname>
+ <refpurpose>Build Debian packages from a Git repository</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ &git-buildpackage;
+
+ <arg><option>--git-ignore-new</option></arg>
+ <arg><option>--git-tag</option></arg>
+ <arg><option>--git-verbose</option></arg>
+ <arg><option>--git-builder=<replaceable>BUILD_CMD</replaceable></option></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+ <para>
+ &git-buildpackage; is used to build Debian source and .deb packages from a GIT repository.
+ </para>
+ <para>
+ &git-buildpackage; will, in order:
+ </para>
+ <itemizedlist>
+ <listitem><para>Verify that it is being executed from the
+ proper location.</para>
+ </listitem>
+ <listitem><para>Call <application>debuild</application> (1)
+ (or the application specified via --git-builder)
+ with arguments instructing it to ignore Git meta-data in
+ the diff.gz, passing along all arguments given to
+ &git-buildpackage; that don't start with --git-.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>--git-ignore-new</option>
+ </term>
+ <listitem>
+ <para>Build the .diff.gz and debian package although there are
+ uncommitted changes in the source tree.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--git-tag</option>
+ </term>
+ <listitem>
+ <para>Add a git tag after a successfull build.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--git-builder=<replaceable>BUILD_CMD</replaceable></option></term>
+ <listitem>
+ <para>Use <replaceable>BUILD_CMD</replaceable> instead of <command>debuild</command></para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <variablelist>
+ <varlistentry>
+ <term><option>--git-verbose</option>
+ </term>
+ <listitem>
+ <para>Verbose execution</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para>git-import-dsc (1), git-import-orig (1), debuild (1), git (1)</para>
+
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+
+ <para>&dhusername; &dhemail;</para>
+
+ </refsect1>
+</refentry>
diff --git a/docs/manpages/git-import-dsc.sgml b/docs/manpages/git-import-dsc.sgml
new file mode 100644
index 0000000..22a5f6e
--- /dev/null
+++ b/docs/manpages/git-import-dsc.sgml
@@ -0,0 +1,75 @@
+<refentry id="gbp.man.git.import.dsc">
+ <refentryinfo>
+ <address>
+ &dhemail;
+ </address>
+ <author>
+ &dhfirstname;
+ &dhsurname;
+ </author>
+ <copyright>
+ <year>2006</year>
+ <holder>&dhusername;</holder>
+ </copyright>
+ &dhdate;
+ </refentryinfo>
+ <refmeta>
+ <refentrytitle>git-import-dsc</refentrytitle>
+ &dhsection;
+ </refmeta>
+ <refnamediv>
+ <refname>&git-import-dsc;</refname>
+
+ <refpurpose>Import Debian packages into a Git repository</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ &git-import-dsc;
+
+ <arg><option>--verbose</option></arg>
+ <arg><option>--upstream-branch=<replaceable>branch_name</replaceable></option></arg>
+ <arg choice="plain"><replaceable>dsc_file</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+ <para>
+ &git-import-dsc; imports a Debian source package into a &git-buildpackage;
+ repository, notes the package version in the commit logs, and commits the
+ change. All information, including package name, version, Debian diffs,
+ and upstream source, is automatically detected from the source package.
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+
+ <variablelist>
+ <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 'upstream'</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--verbose</option>, <option>-v</option>
+ </term>
+ <listitem>
+ <para>Verbose execution.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para>git-buildpackage (1), git-import-orig (1), git (1), git_load_dirs (1)</para>
+
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+
+ <para>&dhusername; &dhemail;</para>
+
+ </refsect1>
+</refentry>
diff --git a/docs/manpages/git-import-orig.sgml b/docs/manpages/git-import-orig.sgml
new file mode 100644
index 0000000..01068df
--- /dev/null
+++ b/docs/manpages/git-import-orig.sgml
@@ -0,0 +1,99 @@
+<refentry id="gbp.man.git.import.orig">
+ <refentryinfo>
+ <address>
+ &dhemail;
+ </address>
+ <author>
+ &dhfirstname;
+ &dhsurname;
+ </author>
+ <copyright>
+ <year>2006</year>
+ <holder>&dhusername;</holder>
+ </copyright>
+ &dhdate;
+ </refentryinfo>
+ <refmeta>
+ <refentrytitle>git-import-orig</refentrytitle>
+ &dhsection;
+ </refmeta>
+ <refnamediv>
+ <refname>&git-import-orig;</refname>
+
+ <refpurpose>Import an upstream source into a git-buildpackage repository</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ &git-import-orig;
+
+ <arg><option>--verbose</option></arg>
+ <arg><option>--upstream-branch=<replaceable>branch_name</replaceable></option></arg>
+ <arg><option>--debian-branch=<replaceable>branch_name</replaceable></option></arg>
+ <arg><option>--upstream-version=<replaceable>version</replaceable></option></arg>
+ <arg choice="plain"><replaceable>tar_gz</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+ <para>
+ &git-import-orig; imports a tar.gz file given by
+ <replaceable>tar_gz<replaceable> into the git-buildpackage repository. If
+ <replaceable>tar_gz</replaceable> is already of the form
+ package_version.orig.tar.gz, it reads the version information from the
+ tarball's filename otherwise it can be specified on the commandline.
+
+ When importing the new version <command>git_load_dirs</command> is being
+ used to detect file renames and removals.
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>--upstream-version</option>=<replaceable>version</replaceable>,
+ <option>-u</option><replaceable>version</replaceable>
+ </term>
+ <listitem>
+ <para>The upstream version number</para>
+ </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 'upstream'</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 'master'. After importing the new sources on
+ the upstream branch, &git-import-orig; will try to merge the new
+ version onto this branch.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--verbose</option>, <option>-v</option>
+ </term>
+ <listitem>
+ <para>Verbose execution.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para>git-buildpackage (1), git-import-dsc (1), git (1), git_load_dirs (1)</para>
+
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+
+ <para>&dhusername; &dhemail;</para>
+
+ </refsect1>
+</refentry>
diff --git a/docs/manpages/manpages.ent b/docs/manpages/manpages.ent
new file mode 100644
index 0000000..d024c6a
--- /dev/null
+++ b/docs/manpages/manpages.ent
@@ -0,0 +1,3 @@
+<!ENTITY man.git.importorig SYSTEM "git-import-orig.sgml">
+<!ENTITY man.git.importdsc SYSTEM "git-import-dsc.sgml">
+<!ENTITY man.git.buildpackage SYSTEM "git-buildpackage.sgml">