From c0c49dd280dea79a4c48f3a8671da160f24f34ff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20O=C5=BCarowski?= <piotr@debian.org>
Date: Tue, 27 Jul 2010 21:27:03 +0200
Subject: [PATCH] add README.PyDist

---
 README.PyDist          | 79 ++++++++++++++++++++++++++++++++++++++++++
 debian/changelog       |  6 ++++
 debian/python-doc.docs |  1 +
 debian/rules           |  3 +-
 4 files changed, 88 insertions(+), 1 deletion(-)
 create mode 100644 README.PyDist
 create mode 100644 debian/python-doc.docs

diff --git a/README.PyDist b/README.PyDist
new file mode 100644
index 0000000..aea1a39
--- /dev/null
+++ b/README.PyDist
@@ -0,0 +1,79 @@
+============
+PyDist files
+============
+
+DISTNAME [VRANGE] DEPENDENCY[; [PEP386] [RULES]]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+PyDist files help tools like dh_python2 to translate Python dependencies (from
+setup.py's install_requires or egg's requires.txt file) to Debian dependencies.
+
+
+Required fields:
+~~~~~~~~~~~~~~~~
+
+DISTNAME
+````````
+Python distribution name (you can find it at the beginning of .egg-info
+file/directory name that your package provides).
+
+Examples:
+ * SQLAlchemy
+ * Jinja2
+ * numpy
+
+DEPENDENCY
+``````````
+Debian dependency, multiple packages or versions are allowed.
+
+Examples:
+ * python-mako
+ * python-jinja2 | python (>= 2.6)
+ * python-sqlalchemy (>= 0.5), python-sqlalchemy (<< 0.6)
+
+
+Optional fields:
+~~~~~~~~~~~~~~~~
+
+VRANGE
+``````
+Python version or version range the line applies to.
+
+Examples:
+ * 2.6		(Python 2.6 only)
+ * 2.5-		(Python 2.5 and newer)
+ * 2.5-2.7	(Python 2.5 or 2.6)
+ * -2.7		(Python 2.6 or older)
+
+PEP386 - standards flag: upstream uses versioning schema described in PEP 386
+
+RULES
+`````
+Rules needed to translate upstream version to Debian one. If PEP386 is
+set, its rules will be applied later. Multiple rules are allowed, separate them
+with a space.
+
+Examples:
+ * s/^/2:/
+ * s/alpha/~alpha/ s/^/1:/
+
+
+Notes:
+~~~~~~
+
+You can use multiple lines if binary package provides more than one Python
+distribution or if you want to specify different dependencies for each Python
+version or version range.
+
+If you use dh_python2, it will install debian/binary_package_name.pydist file
+to /usr/share/python/dist/binary_package_name automatically.
+
+
+Complete examples:
+~~~~~~~~~~~~~~~~~~
+ * SQLAlchemy python-sqlalchemy (>= 0.5), python-sqlalchemy (<< 0.6)
+ * Mako python-mako; PEP386
+ * foo -2.5 python-oldfoo; s/^/3:/
+ * foo 2.5- python-foo; PEP386
+
+.. vim: ft=rst
diff --git a/debian/changelog b/debian/changelog
index 48b45c7..8d24028 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+python-defaults (2.6.5-11) UNRELEASED; urgency=low
+
+  * Add README.PyDist to python-doc package
+
+ -- Piotr Ożarowski <piotr@debian.org>  Tue, 27 Jul 2010 21:25:54 +0200
+
 python-defaults (2.6.5-10) unstable; urgency=medium
 
   * dh_python2:
diff --git a/debian/python-doc.docs b/debian/python-doc.docs
new file mode 100644
index 0000000..1fd7a83
--- /dev/null
+++ b/debian/python-doc.docs
@@ -0,0 +1 @@
+README.PyDist*
diff --git a/debian/rules b/debian/rules
index b3adce9..856860f 100755
--- a/debian/rules
+++ b/debian/rules
@@ -46,6 +46,7 @@ stamp-doc-policy:
 	debiandoc2html debian/python-policy.sgml
 	rm -rf debian/python-policy.html
 	mv -f python-policy.html debian/
+	rst2html README.PyDist README.PyDist.html
 	touch stamp-doc-policy
 
 stamp-doc: stamp-doc-policy
@@ -104,7 +105,7 @@ clean: control-file
 	done
 	rm -f debian/*.py[co]
 	make clean
-	dh_clean
+	dh_clean README.PyDist.html
 
 stamp-control:
 	: # We have to prepare the various control files
-- 
GitLab