summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJulian Andres Klode <jak@debian.org>2009-07-13 19:53:13 +0200
committerJulian Andres Klode <jak@debian.org>2009-07-13 19:53:13 +0200
commit0f753709899127e0bbdc6bfcabfc84b0ba5cd3c2 (patch)
tree4c0989ff65c98922f7cb0f1799b91314241b97c0 /doc
parent4bea536827ad8f0d294bdac5268a893c6ac22a8a (diff)
downloadpython-apt-0f753709899127e0bbdc6bfcabfc84b0ba5cd3c2.tar.gz
doc/source/contributing.rst: List debian-experimental, fix highlighting.
Diffstat (limited to 'doc')
-rw-r--r--doc/source/contributing.rst28
1 files changed, 19 insertions, 9 deletions
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
index eafc2a2e..7c6b6e6d 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@@ -27,6 +27,14 @@ submit them.
VCS-Browser: http://bzr.debian.org/loggerhead/apt/python-apt/debian-sid/changes
+**debian-experimental:** http://bzr.debian.org/apt/python-apt/debian-experimental
+
+ This is another official Debian branch of python-apt, for releases
+ targetted at Debian experimental. This branch may contain unstable code
+ and may thus not work correctly.
+
+ VCS-Browser: http://bzr.debian.org/loggerhead/apt/python-apt/debian-experimental/changes
+
**jak:** http://bzr.debian.org/users/jak/python-apt/jak
This is Julian Andres Klode's (the documentation author's) branch. This
is the place where cleanup and documentation updates happen. It is based
@@ -41,6 +49,8 @@ submit them.
VCS-Browser: https://code.launchpad.net/~ubuntu-core-dev/python-apt/ubuntu
+.. highlightlang:: c
+
C++ Coding style
----------------
This document gives coding conventions for the C++ code comprising
@@ -185,7 +195,7 @@ Documentation Strings
PyDoc_STRVAR(myfunction__doc__,
"myfunction(name: str, value) -> bool\n\n"
- Determine whether name and value make a valid pair.");
+ "Determine whether name and value make a valid pair.");
The signature line should be formatted using the format for function
annotations described in :PEP:`3107`, whereas the annotations shall reflect
@@ -224,8 +234,10 @@ deprecated as of Python 2.6.
Submitting your patch
---------------------
-First of all, the patch you create should be based against the debian-sid
-branch of python-apt.
+First of all, the patch you create should be based against the most current
+branch of python-apt (debian-sid or debian-experimental). If it is a bugfix,
+you should probably use debian-sid. If you choose the wrong branch, we will
+ask you to rebase your patches against the correct one.
Once you have made your change, check that it:
@@ -271,13 +283,11 @@ patch, you may need to *merge* the branch instead.
Documentation updates
---------------------
If you want to update the documentation, please follow the procedure as written
-above. But please CC: jak@debian.org in the bug report.
-
-You can send your content in plain text, but reStructuredText is the preferred
-format. I (Julian Andres Klode) will review your patch and will forward them to
-Michael Vogt, for inclusion in his branch. On release, this will be merged into
-the debian-sid branch.
+above. You can send your content in plain text, but reStructuredText is the
+preferred format. I (Julian Andres Klode) will review your patch and include
+it.
+.. highlightlang:: sh
Example patch session
----------------------