doc: Updated pull request with suggested changes.

signed-off by: John Wilkins <john.wilkins@inktank.com>

diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst
index 1301650783eb5700ee046771e3452b754e3d3962..11c5bdce709f9a2d224a70d10f74594ad5d259ab 100644 (file)
--- a/doc/start/documenting-ceph.rst
+++ b/doc/start/documenting-ceph.rst
@@ -220,14 +220,16 @@ pushing them to your forked Ceph repository.
 
 Ceph documentation commits are simple, but follow a strict convention:
 
-- A commit MUST have 1 file per commit (it simplifies rollback).
+- A commit SHOULD have 1 file per commit (it simplifies rollback). You MAY
+  commit multiple files with related changes. Unrelated changes SHOULD NOT
+  be put into the same commit.
 - A commit MUST have a comment.
 - A commit comment MUST be prepended with ``doc:``. (strict)
 - The comment summary MUST be one line only. (strict)
 - Additional comments MAY follow a blank line after the summary, 
   but should be terse.
-- A commit MAY include ``fixes: {bug number}``.
-- Commits MUST include ``signed-off by: {email address}``. (strict)
+- A commit MAY include ``fixes: #{bug number}``.
+- Commits MUST include ``signed-off by: Firstname Lastname <email>``. (strict)
 
 .. tip:: Follow the foregoing convention particularly where it says 
    ``(strict)`` or you will be asked to modify your commit to comply with 
@@ -237,7 +239,7 @@ The following is a common commit comment (preferred)::
 
        doc: Fixes a spelling error and a broken hyperlink.
        
-       signed-off by: john.doe@gmail.com
+       signed-off by: John Doe <john.doe@gmail.com>
 
 
 The following comment includes a reference to a bug. :: 
@@ -246,7 +248,7 @@ The following comment includes a reference to a bug. ::
 
        fixes: #1234
        
-       signed-off by: john.doe@gmail.com
+       signed-off by: John Doe <john.doe@gmail.com>
 
 
 The following comment includes a terse sentence following the comment summary.
@@ -257,7 +259,7 @@ There is a carriage return between the summary line and the description::
        Describes 'mon setting', which is a new setting added
        to config_opts.h.
        
-       signed-off by: john.doe@gmail.com
+       signed-off by: John Doe <john.doe@gmail.com>
 
 
 To commit changes, execute the following:: 
@@ -443,4 +445,4 @@ improves the readability of the document in a command line interface.
 .. _Showing code examples: http://sphinx-doc.org/markup/code.html
 .. _paragraph level markup: http://sphinx-doc.org/markup/para.html
 .. _topic directive: http://docutils.sourceforge.net/docs/ref/rst/directives.html#topic
-.. _John Wilkins: mailto:john.wilkins@inktank.com
\ No newline at end of file
+.. _John Wilkins: mailto:john.wilkins@inktank.com