From: Eric Harney <eharney@redhat.com>
Date: Mon, 22 Oct 2012 22:37:11 +0000 (-0400)
Subject: Update HACKING.rst and related changes from Nova/PEP8.
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=b3b1d48d5384cb9f70fdc4b27e07006ba44daa14;p=openstack-build%2Fcinder-build.git

Update HACKING.rst and related changes from Nova/PEP8.

Sync up with changes made in Nova, this adds information
about line continuation (PEP8), OpenStack capitalization,
and commit messages.

Change-Id: Id6637307411bcc7a3637ac514c4ec34e26481e0d
---

diff --git a/HACKING.rst b/HACKING.rst
index e9c0162f5..b67867ee9 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -10,6 +10,8 @@ General
 -------
 - Put two newlines between top-level code (funcs, classes, etc)
 - Put one newline between methods in classes and anywhere else
+- Long lines should be wrapped in parentheses
+  in preference to using a backslash for line continuation.
 - Do not write "except:", use "except Exception:" at the very least
 - Include your name with TODOs as in "#TODO(termie)"
 - Do not shadow a built-in or reserved word. Example::
@@ -211,3 +213,44 @@ with the help of openstack-common's update.py script. See:
 The copy of the code should never be directly modified here. Please
 always update openstack-common first and then run the script to copy
 the changes across.
+
+OpenStack Trademark
+-------------------
+
+OpenStack is a registered trademark of OpenStack, LLC, and uses the
+following capitalization:
+
+   OpenStack
+
+
+Commit Messages
+---------------
+Using a common format for commit messages will help keep our git history
+readable. Follow these guidelines:
+
+  First, provide a brief summary (it is recommended to keep the commit title
+  under 50 chars).
+
+  The first line of the commit message should provide an accurate
+  description of the change, not just a reference to a bug or
+  blueprint. It must be followed by a single blank line.
+
+  If the change relates to a specific driver (libvirt, xenapi, qpid, etc...),
+  begin the first line of the commit message with the driver name, lowercased,
+  followed by a colon.
+
+  Following your brief summary, provide a more detailed description of
+  the patch, manually wrapping the text at 72 characters. This
+  description should provide enough detail that one does not have to
+  refer to external resources to determine its high-level functionality.
+
+  Once you use 'git review', two lines will be appended to the commit
+  message: a blank line followed by a 'Change-Id'. This is important
+  to correlate this commit with a specific review in Gerrit, and it
+  should not be modified.
+
+For further information on constructing high quality commit messages,
+and how to split up commits into a series of changes, consult the
+project wiki:
+
+   http://wiki.openstack.org/GitCommitMessages
diff --git a/bin/cinder-clear-rabbit-queues b/bin/cinder-clear-rabbit-queues
index 321a94d90..c39081458 100755
--- a/bin/cinder-clear-rabbit-queues
+++ b/bin/cinder-clear-rabbit-queues
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # vim: tabstop=4 shiftwidth=4 softtabstop=4
 
-# Copyright (c) 2011 Openstack, LLC.
+# Copyright (c) 2011 OpenStack, LLC.
 # All Rights Reserved.
 #
 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
diff --git a/bin/cinder-rootwrap b/bin/cinder-rootwrap
index 3ea6cc370..2a1f5afea 100755
--- a/bin/cinder-rootwrap
+++ b/bin/cinder-rootwrap
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # vim: tabstop=4 shiftwidth=4 softtabstop=4
 
-# Copyright (c) 2011 Openstack, LLC.
+# Copyright (c) 2011 OpenStack, LLC.
 # All Rights Reserved.
 #
 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
diff --git a/bin/cinder-volume-usage-audit b/bin/cinder-volume-usage-audit
index 49b47706c..6f39e1124 100755
--- a/bin/cinder-volume-usage-audit
+++ b/bin/cinder-volume-usage-audit
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # vim: tabstop=4 shiftwidth=4 softtabstop=4
 
-# Copyright (c) 2011 Openstack, LLC.
+# Copyright (c) 2011 OpenStack, LLC.
 # All Rights Reserved.
 #
 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
diff --git a/doc/source/devref/xensmvolume.rst b/doc/source/devref/xensmvolume.rst
index 4b736dcaf..1221c5ec0 100644
--- a/doc/source/devref/xensmvolume.rst
+++ b/doc/source/devref/xensmvolume.rst
@@ -85,4 +85,4 @@ cinder-manage sm backend_remove 1
 API Changes
 ===========
 
-No API changes have been introduced so far. The existing euca-create-volume and euca-delete-volume commands (or equivalent Openstack API commands) should be used.
+No API changes have been introduced so far. The existing euca-create-volume and euca-delete-volume commands (or equivalent OpenStack API commands) should be used.
diff --git a/etc/cinder/api-paste.ini b/etc/cinder/api-paste.ini
index e0d7224a9..e18a9da22 100644
--- a/etc/cinder/api-paste.ini
+++ b/etc/cinder/api-paste.ini
@@ -1,5 +1,5 @@
 #############
-# Openstack #
+# OpenStack #
 #############
 
 [composite:osapi_volume]