From: Guido Günther <agx@sigxcpu.org>
Date: Thu, 22 Aug 2013 08:22:37 +0000 (+0200)
Subject: Minor docstring updates
X-Git-Tag: debian/0.6.3~7
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=d0fb6d86201d04fb9194119239ccc212302a1b6f;p=tools%2Fgit-buildpackage.git

Minor docstring updates
---

diff --git a/gbp/deb/control.py b/gbp/deb/control.py
index da01ebea..b15d3601 100644
--- a/gbp/deb/control.py
+++ b/gbp/deb/control.py
@@ -14,7 +14,7 @@
 #    You should have received a copy of the GNU General Public License
 #    along with this program; if not, write to the Free Software
 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-"""A Debian Control"""
+"""A Debian Control file"""
 
 import email
 import os
diff --git a/gbp/deb/policy.py b/gbp/deb/policy.py
index b35603c4..006dbb21 100644
--- a/gbp/deb/policy.py
+++ b/gbp/deb/policy.py
@@ -14,7 +14,11 @@
 #    You should have received a copy of the GNU General Public License
 #    along with this program; if not, write to the Free Software
 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-"""provides some debian source package related helpers"""
+"""
+Debian Packaging policies
+
+like allowed characters in version numbers, etc.
+"""
 
 import os
 import re
diff --git a/gbp/git/args.py b/gbp/git/args.py
index 8f0ffba6..f9fc64d6 100644
--- a/gbp/git/args.py
+++ b/gbp/git/args.py
@@ -14,6 +14,9 @@
 #    You should have received a copy of the GNU General Public License
 #    along with this program; if not, write to the Free Software
 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""
+Git command argument handling helpers
+"""
 
 import collections
 
diff --git a/gbp/scripts/__init__.py b/gbp/scripts/__init__.py
index e69de29b..fde82674 100644
--- a/gbp/scripts/__init__.py
+++ b/gbp/scripts/__init__.py
@@ -0,0 +1,17 @@
+# vim: set fileencoding=utf-8 :
+#
+# (C) 2013 Guido Günther <agx@sigxcpu.org>
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program; if not, write to the Free Software
+#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""The gbp commands"""
diff --git a/gbp/scripts/common/__init__.py b/gbp/scripts/common/__init__.py
index e69de29b..14464836 100644
--- a/gbp/scripts/common/__init__.py
+++ b/gbp/scripts/common/__init__.py
@@ -0,0 +1,17 @@
+# vim: set fileencoding=utf-8 :
+#
+# (C) 2013 Guido Günther <agx@sigxcpu.org>
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program; if not, write to the Free Software
+#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""Parts shared between the deb and rpm commands"""
diff --git a/gbp/tristate.py b/gbp/tristate.py
index 6e26c829..93610605 100644
--- a/gbp/tristate.py
+++ b/gbp/tristate.py
@@ -15,6 +15,10 @@
 #    along with this program; if not, write to the Free Software
 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
+"""
+A switch with three states: on|off|auto
+"""
+
 class Tristate(object):
     """Tri-state value: on, off or auto """
     ON  = True      # state is on == do it
diff --git a/setup.py b/setup.py
index f74715f0..23bde20c 100644
--- a/setup.py
+++ b/setup.py
@@ -37,6 +37,7 @@ def fetch_version():
         pass # Failing is fine, we just can't print the version then
 
     with file('gbp/version.py', 'w') as f:
+        f.write('"The current gbp version number"\n')
         f.write('gbp_version="%s"\n' % version)
 
     return version