[Pkg-ocaml-maint-commits] [SCM] dh-ocaml packaging branch, master, updated. debian/0.4.1-32-gbec39da

Mehdi Dogguy dogguy at pps.jussieu.fr
Fri Jul 10 12:36:18 UTC 2009


The following commit has been merged in the master branch:
commit bec39da2a12266103bdc9661e6e1299d5e44603e
Author: Mehdi Dogguy <dogguy at pps.jussieu.fr>
Date:   Fri Jul 10 12:48:53 2009 +0200

    Add manpages for new tools

diff --git a/debian/changelog b/debian/changelog
index 6cd07f7..bb5e805 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -13,6 +13,8 @@ dh-ocaml (0.4.2) UNRELEASED; urgency=low
     /usr/bin (Closes: #516777)
   * Install dom-{apply,save}-patches in /usr/bin/ and update policy to
     explain briefly how to use them.
+  * Add manpages for new tools
+  * Add docbook-xsl, libxml2-utils and xsltproc to generate manpages
 
   [ Ralf Treinen ]
   * Add a section on setting the archive section of ocaml programs.
diff --git a/debian/control b/debian/control
index 2105655..797e72e 100644
--- a/debian/control
+++ b/debian/control
@@ -13,6 +13,9 @@ Build-Depends-Indep:
  debhelper (>= 7),
  docbook-utils,
  docbook-xml,
+ docbook-xsl,
+ xsltproc,
+ libxml2-utils,
  lynx
 Standards-Version: 3.8.0
 Vcs-Git: git://git.debian.org/git/pkg-ocaml-maint/packages/dh-ocaml.git
diff --git a/debian/manpages b/debian/manpages
index a2231ae..8c030a8 100644
--- a/debian/manpages
+++ b/debian/manpages
@@ -1,2 +1,8 @@
 debhelper/dh_ocaml.1
 ocaml-md5sums/ocaml-md5sums.1
+manpages/dom-new-git-repo.1
+manpages/dom-git-checkout.1
+manpages/dom-safe-pull.1
+manpages/dom-save-patches.1
+manpages/dom-apply-patches.1
+manpages/dom-mrconfig.1
diff --git a/debian/rules b/debian/rules
index e3f5fdd..26a48e5 100755
--- a/debian/rules
+++ b/debian/rules
@@ -3,6 +3,7 @@
 build: build-stamp
 build-stamp:
 	dh build
+	$(MAKE) -C manpages
 	touch build-stamp
 
 clean:
diff --git a/manpages/Makefile b/manpages/Makefile
new file mode 100644
index 0000000..4347143
--- /dev/null
+++ b/manpages/Makefile
@@ -0,0 +1,14 @@
+
+MP := $(shell ls -1 dom-*.xml)
+
+all: $(patsubst %.xml,%.1, $(MP))
+
+%.1: %.xml
+	-xmllint --nonet --noout --postvalid --xinclude $<
+	xsltproc --output $@ --nonet --xinclude \
+	  /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
+	  $<
+	sed -i 's/CopyrightCopyright/Copyright/' $@
+
+clean:
+	rm -f *.1
diff --git a/manpages/dom-apply-patches.xml b/manpages/dom-apply-patches.xml
new file mode 100644
index 0000000..1a311ae
--- /dev/null
+++ b/manpages/dom-apply-patches.xml
@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 
+"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
+  <!ENTITY debian "Debian GNU/Linux">
+  <!ENTITY dhprg  "<command>dom-apply-patches</command>">
+]>
+
+<!--**********************************************************************-->
+<!-- Dh-Ocaml manpage                                                     -->
+<!--                                                                      -->
+<!-- Copyright (C) 2009 Mehdi Dogguy <dogguy at pps.jussieu.fr>              -->
+<!--                                                                      -->
+<!-- You have permission to copy, modify, and redistribute under the terms-->
+<!-- of the GNU GPL-3.0. For full license terms, see                      -->
+<!-- `/usr/share/common-licenses/GPL-3'.                                  -->
+<!--                                                                      -->
+<!--**********************************************************************-->
+
+<refentry>
+
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="refentryinfo.xml"/>
+
+  <refmeta>
+    <refentrytitle>&dhprg;</refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo class="software">dh-ocaml</refmiscinfo>
+    <refmiscinfo class="manual">User Commands</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>&dhprg;</refname>
+    <refpurpose>Applies all patches found in
+      <emphasis role="bold">debian/patches/series</emphasis> in a new
+      local branch <emphasis role="bold">patch-queue</emphasis>
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      &dhprg;
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+
+    <itemizedlist>
+      <listitem>
+        <para>&dhprg; creates a local branch <emphasis role="bold">patch-queue
+          </emphasis> from <emphasis role="bold">upstream</emphasis> branch
+        </para>
+      </listitem>
+      <listitem>
+        <para>Applies every patch found in
+          <emphasis role="bold">master:debian/patches/series</emphasis>
+        </para>
+      </listitem>
+    </itemizedlist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+
+    <para>
+      <citerefentry>
+        <refentrytitle>
+          <command>dom-save-patches</command>
+        </refentrytitle>
+        <manvolnum>1</manvolnum>
+      </citerefentry>
+    </para>
+  </refsect1>
+
+</refentry>
diff --git a/manpages/dom-git-checkout.xml b/manpages/dom-git-checkout.xml
new file mode 100644
index 0000000..33d9e65
--- /dev/null
+++ b/manpages/dom-git-checkout.xml
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 
+"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
+  <!ENTITY debian "Debian GNU/Linux">
+  <!ENTITY dhprg  "<command>dom-git-checkout</command>">
+]>
+
+<!--**********************************************************************-->
+<!-- Dh-Ocaml manpage                                                     -->
+<!--                                                                      -->
+<!-- Copyright (C) 2009 Mehdi Dogguy <dogguy at pps.jussieu.fr>              -->
+<!--                                                                      -->
+<!-- You have permission to copy, modify, and redistribute under the terms-->
+<!-- of the GNU GPL-3.0. For full license terms, see                      -->
+<!-- `/usr/share/common-licenses/GPL-3'.                                  -->
+<!--                                                                      -->
+<!--**********************************************************************-->
+
+<refentry>
+
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="refentryinfo.xml"/>
+
+  <refmeta>
+    <refentrytitle>&dhprg;</refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo class="software">dh-ocaml</refmiscinfo>
+    <refmiscinfo class="manual">User Commands</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>&dhprg;</refname>
+    <refpurpose>Checkout the git repository of the package given as argument</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      &dhprg;
+      <arg choice="plain">pkg_name</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+
+    <para>Checkout the git repository of the package given as argument
+      and track <emphasis role="bold">upstream</emphasis>
+      and <emphasis role="bold">pristine-tar</emphasis> branches.
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>OPTIONS</title>
+
+    <variablelist>
+      <varlistentry>
+	<term><option>pkg_name</option></term>
+	<listitem><para>The name of the package to checkout</para></listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+
+  <refsect1>
+    <title>SEE ALSO</title>
+
+    <para>
+      <citerefentry>
+        <refentrytitle>
+          <command>dom-new-git-repo</command>
+        </refentrytitle>
+        <manvolnum>1</manvolnum>
+      </citerefentry>
+    </para>
+  </refsect1>
+
+</refentry>
diff --git a/manpages/dom-mrconfig.xml b/manpages/dom-mrconfig.xml
new file mode 100644
index 0000000..63f4678
--- /dev/null
+++ b/manpages/dom-mrconfig.xml
@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 
+"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
+  <!ENTITY debian "Debian GNU/Linux">
+  <!ENTITY dhprg  "<command>dom-mrconfig</command>">
+]>
+
+<!--**********************************************************************-->
+<!-- Dh-Ocaml manpage                                                     -->
+<!--                                                                      -->
+<!-- Copyright (C) 2009 Mehdi Dogguy <dogguy at pps.jussieu.fr>              -->
+<!--                                                                      -->
+<!-- You have permission to copy, modify, and redistribute under the terms-->
+<!-- of the GNU GPL-3.0. For full license terms, see                      -->
+<!-- `/usr/share/common-licenses/GPL-3'.                                  -->
+<!--                                                                      -->
+<!--**********************************************************************-->
+
+<refentry>
+
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="refentryinfo.xml"/>
+
+  <refmeta>
+    <refentrytitle>&dhprg;</refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo class="software">dh-ocaml</refmiscinfo>
+    <refmiscinfo class="manual">User Commands</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>&dhprg;</refname>
+    <refpurpose>Generates a config file for <emphasis role="bold">mr</emphasis></refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      &dhprg;
+      <arg choice="opt">-h</arg>
+      <arg choice="opt">config_file</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+
+    <para>Generates a config file
+      for <emphasis role="bold">mr</emphasis> with all repositories
+      maintained within <emphasis role="bold">Debian OCaml
+      Maintainers</emphasis> (pkg-ocaml-maint) alioth group.
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>OPTIONS</title>
+
+    <variablelist>
+      <varlistentry>
+	<term><option>-h</option></term>
+	<listitem><para>Prints a brief help</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term><option>config_file</option></term>
+	<listitem><para>Path of the config file to generate</para></listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+
+    <para>
+      <citerefentry>
+        <refentrytitle>
+          <command>dom-safe-pull</command>
+        </refentrytitle>
+        <manvolnum>1</manvolnum>
+      </citerefentry>
+      <citerefentry>
+        <refentrytitle>
+          <command>mr</command>
+        </refentrytitle>
+        <manvolnum>1</manvolnum>
+      </citerefentry>
+    </para>
+  </refsect1>
+
+</refentry>
diff --git a/manpages/dom-new-git-repo.xml b/manpages/dom-new-git-repo.xml
new file mode 100644
index 0000000..0b14d3a
--- /dev/null
+++ b/manpages/dom-new-git-repo.xml
@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 
+"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
+  <!ENTITY debian "Debian GNU/Linux">
+  <!ENTITY dhprg  "<command>dom-new-git-repo</command>">
+]>
+
+<!--**********************************************************************-->
+<!-- Dh-Ocaml manpage                                                     -->
+<!--                                                                      -->
+<!-- Copyright (C) 2009 Mehdi Dogguy <dogguy at pps.jussieu.fr>              -->
+<!--                                                                      -->
+<!-- You have permission to copy, modify, and redistribute under the terms-->
+<!-- of the GNU GPL-3.0. For full license terms, see                      -->
+<!-- `/usr/share/common-licenses/GPL-3'.                                  -->
+<!--                                                                      -->
+<!--**********************************************************************-->
+
+<refentry>
+
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="refentryinfo.xml"/>
+
+  <refmeta>
+    <refentrytitle>&dhprg;</refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo class="software">dh-ocaml</refmiscinfo>
+    <refmiscinfo class="manual">User Commands</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>&dhprg;</refname>
+    <refpurpose>Creates a new Git repository in pkg-ocaml-maint
+      space
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      &dhprg;
+      <arg choice="plain">name</arg>
+      <arg choice="opt">tarball</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+
+    <para>Creates a new Git repository in pkg-ocaml-maint area,
+    installs notifications (IRC, mailing-list, ...) and pushes the
+    repository to Alioth.</para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>OPTIONS</title>
+
+    <variablelist>
+      <varlistentry>
+	<term><option>name</option></term>
+	<listitem><para>Package name</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+	<term><option>tarball</option></term>
+	<listitem><para>Upstream tarball</para></listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+
+  <refsect1>
+    <title>SEE ALSO</title>
+
+    <para>
+      <citerefentry>
+        <refentrytitle>
+          <command>dom-git-checkout</command>
+        </refentrytitle>
+        <manvolnum>1</manvolnum>
+      </citerefentry>
+    </para>
+  </refsect1>
+
+</refentry>
diff --git a/manpages/dom-safe-pull.xml b/manpages/dom-safe-pull.xml
new file mode 100644
index 0000000..c768d10
--- /dev/null
+++ b/manpages/dom-safe-pull.xml
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 
+"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
+  <!ENTITY debian "Debian GNU/Linux">
+  <!ENTITY dhprg  "<command>dom-safe-pull</command>">
+]>
+
+<!--**********************************************************************-->
+<!-- Dh-Ocaml manpage                                                     -->
+<!--                                                                      -->
+<!-- Copyright (C) 2009 Mehdi Dogguy <dogguy at pps.jussieu.fr>              -->
+<!--                                                                      -->
+<!-- You have permission to copy, modify, and redistribute under the terms-->
+<!-- of the GNU GPL-3.0. For full license terms, see                      -->
+<!-- `/usr/share/common-licenses/GPL-3'.                                  -->
+<!--                                                                      -->
+<!--**********************************************************************-->
+
+<refentry>
+
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="refentryinfo.xml"/>
+
+  <refmeta>
+    <refentrytitle>&dhprg;</refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo class="software">dh-ocaml</refmiscinfo>
+    <refmiscinfo class="manual">User Commands</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>&dhprg;</refname>
+    <refpurpose>Safely pull changes from Git remote</refpurpose>
+  </refnamediv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+
+    <para>&dhprg; looks for tracked branches and fetches changes from
+    remote. For each branch, if the changes are fast-forward then it
+    will merge the local branch with the corresponding remote branch. 
+    </para>
+
+  </refsect1>
+
+
+</refentry>
diff --git a/manpages/dom-save-patches.xml b/manpages/dom-save-patches.xml
new file mode 100644
index 0000000..a235630
--- /dev/null
+++ b/manpages/dom-save-patches.xml
@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 
+"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
+  <!ENTITY debian "Debian GNU/Linux">
+  <!ENTITY dhprg  "<command>dom-save-patches</command>">
+]>
+
+<!--**********************************************************************-->
+<!-- Dh-Ocaml manpage                                                     -->
+<!--                                                                      -->
+<!-- Copyright (C) 2009 Mehdi Dogguy <dogguy at pps.jussieu.fr>              -->
+<!--                                                                      -->
+<!-- You have permission to copy, modify, and redistribute under the terms-->
+<!-- of the GNU GPL-3.0. For full license terms, see                      -->
+<!-- `/usr/share/common-licenses/GPL-3'.                                  -->
+<!--                                                                      -->
+<!--**********************************************************************-->
+
+<refentry>
+
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="refentryinfo.xml"/>
+
+  <refmeta>
+    <refentrytitle>&dhprg;</refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo class="software">dh-ocaml</refmiscinfo>
+    <refmiscinfo class="manual">User Commands</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>&dhprg;</refname>
+    <refpurpose>Creates a patch for each commit in branch
+      <emphasis role="bold">patch-queue</emphasis>
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      &dhprg;
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+
+    <para>&dhprg; follows these steps:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>verify the existence of a branch
+          <emphasis role="bold">patch-queue</emphasis>,
+        </para>
+      </listitem>
+      <listitem>
+        <para>move to the <emphasis role="bold">master</emphasis>
+          branch and generates a patch for each commit in
+          branch <emphasis role="bold">patch-queue</emphasis> starting
+          from <emphasis role="bold">upstream</emphasis> branch, from
+          which <emphasis role="bold">patch-queue</emphasis> was created,
+        </para>
+      </listitem>
+      <listitem>
+        <para>update the file
+          <emphasis role="bold">debian/patches/series</emphasis>,
+        </para>
+      </listitem>
+      <listitem>
+        <para>delete the branch
+          <emphasis role="bold">patch-queue</emphasis>.
+        </para>
+      </listitem>
+    </itemizedlist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+
+    <para>
+      <citerefentry>
+        <refentrytitle>
+          <command>dom-apply-patches</command>
+        </refentrytitle>
+        <manvolnum>1</manvolnum>
+      </citerefentry>
+    </para>
+  </refsect1>
+
+</refentry>
diff --git a/manpages/refentryinfo.xml b/manpages/refentryinfo.xml
new file mode 100644
index 0000000..7f89fac
--- /dev/null
+++ b/manpages/refentryinfo.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentryinfo PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 
+"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
+]>
+
+<!--**********************************************************************-->
+<!-- License include for manpage                                          -->
+<!--                                                                      -->
+<!-- Copyright (C) 2009 Mehdi Dogguy <dogguy at pps.jussieu.fr>              -->
+<!-- License: GPL-3+                                                      -->
+<!-- Contact: dogguy at pps.jussieu.fr                                       -->
+<!--**********************************************************************-->
+
+<refentryinfo>
+  <author>
+    <firstname>Mehdi</firstname>
+    <surname>Dogguy</surname>
+    <email>dogguy at pps.jussieu.fr</email>
+    <personblurb><para></para></personblurb>
+  </author>
+  <copyright>
+    <year>2009</year>
+    <holder>Mehdi Dogguy</holder>
+  </copyright>
+  <date>Jul 10, 2009</date>
+</refentryinfo>

-- 
dh-ocaml packaging



More information about the Pkg-ocaml-maint-commits mailing list