diff options
| author | Mark Hecomovich <mheco@google.com> | 2016-07-20 16:32:00 -0700 |
|---|---|---|
| committer | Mark Hecomovich <mheco@google.com> | 2016-07-21 12:54:01 -0700 |
| commit | c859b34b0f96cb7d4793ea89a2640485f62c71ee (patch) | |
| tree | 7839d0f262340547db85336ce8360c4a7a32a20d /src | |
| parent | 47300112de5ca3797493aba3aa76dd9e5a1c2b7e (diff) | |
| download | source.android.com-c859b34b0f96cb7d4793ea89a2640485f62c71ee.tar.gz | |
Docs: Update commit comment description
Bug: 19249780
Change-Id: If0b1ea45c8f6af9f54a45aa8aec8a5cc5de3ff82
Diffstat (limited to 'src')
| -rw-r--r-- | src/source/submit-patches.jd | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/src/source/submit-patches.jd b/src/source/submit-patches.jd index 0298ea94..03150857 100644 --- a/src/source/submit-patches.jd +++ b/src/source/submit-patches.jd @@ -76,22 +76,27 @@ $ git commit -s description will be pushed to the public AOSP repository, so please follow our guidelines for writing changelist descriptions: </p> <ul> -<li> -<p>Start with a one-line summary (60 characters max), followed by a blank line. -This format is used by git and gerrit for various displays. </p> -<pre><code>short description on first line -more detailed description of your patch, -which is likely to take up multiple lines. -</code></pre> +<li> +<p>Start with a one-line summary (50 characters maximum), followed by a blank line. +This format is used by git and gerrit for various displays.</p> </li> + <li> -<p>The description should focus on what issue it solves, and how it solves it. The second part is somewhat optional when implementing new features, though desirable.</p> +<p>Starting on the third line, enter a longer description, which must hard-wrap at 72 characters maximum. This description should focus on what issue the change solves, and how it solves it. The second part is somewhat optional when implementing new features, though desirable.</p> </li> <li> <p>Include a brief note of any assumptions or background information that may be important when another contributor works on this feature next year. </p> </li> </ul> + +<p>Here is an example commit message:</p> +<pre><code>short description on first line + +more detailed description of your patch, +which is likely to take up multiple lines. +</code></pre> + <p>A unique change ID and your name and email as provided during <code>repo init</code> will be automatically added to your commit message. </p> <h2 id="upload-to-gerrit">Upload to gerrit</h2> <p>Once you have committed your change to your personal history, upload it to gerrit with</p> |