diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-04-09 15:13:26 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-04-10 16:20:57 +0100 |
| commit | 26bf080f243a66be9bcc7a91aa36e20a4e589750 (patch) | |
| tree | 3a90f3a587de498301e563f3c2b7e4096f7d4a7f /documentation | |
| parent | 326796890e01a23af20c5b7708686f709b278532 (diff) | |
| download | poky-26bf080f243a66be9bcc7a91aa36e20a4e589750.tar.gz | |
dev-manual: Edits to "How to Submit a Change" section.
(From yocto-docs rev: 8b9cff0c35eb76665edca6c8474935d6dc62e7ed)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index da5595d65d..d939b44c54 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
| @@ -1271,9 +1271,10 @@ | |||
| 1271 | </para> | 1271 | </para> |
| 1272 | 1272 | ||
| 1273 | <para> | 1273 | <para> |
| 1274 | The following is some guidance on which mailing list to use for what type of change: | 1274 | Here is some guidance on which mailing list to use for what type of change: |
| 1275 | <itemizedlist> | 1275 | <itemizedlist> |
| 1276 | <listitem><para>For changes to the core metadata, send your patch to the | 1276 | <listitem><para>For changes to the core |
| 1277 | <link linkend='metadata'>Metadata</link>, send your patch to the | ||
| 1277 | <ulink url='&OE_LISTS_URL;/listinfo/openembedded-core'>openembedded-core</ulink> mailing list. | 1278 | <ulink url='&OE_LISTS_URL;/listinfo/openembedded-core'>openembedded-core</ulink> mailing list. |
| 1278 | For example, a change to anything under the <filename>meta</filename> or | 1279 | For example, a change to anything under the <filename>meta</filename> or |
| 1279 | <filename>scripts</filename> directories | 1280 | <filename>scripts</filename> directories |
| @@ -1288,7 +1289,7 @@ | |||
| 1288 | layer's documentation specifies otherwise), tools, and Yocto Project | 1289 | layer's documentation specifies otherwise), tools, and Yocto Project |
| 1289 | documentation, use the | 1290 | documentation, use the |
| 1290 | <ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'>yocto</ulink> mailing list.</para></listitem> | 1291 | <ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'>yocto</ulink> mailing list.</para></listitem> |
| 1291 | <listitem><para>For additional recipes that do not fit into the core metadata, | 1292 | <listitem><para>For additional recipes that do not fit into the core Metadata, |
| 1292 | you should determine which layer the recipe should go into and submit the | 1293 | you should determine which layer the recipe should go into and submit the |
| 1293 | change in the manner recommended by the documentation (e.g. README) supplied | 1294 | change in the manner recommended by the documentation (e.g. README) supplied |
| 1294 | with the layer. If in doubt, please ask on the | 1295 | with the layer. If in doubt, please ask on the |
| @@ -1356,7 +1357,7 @@ | |||
| 1356 | This summary is typically viewable in the "shortlist" of changes. | 1357 | This summary is typically viewable in the "shortlist" of changes. |
| 1357 | Thus, providing something short and descriptive that gives the reader | 1358 | Thus, providing something short and descriptive that gives the reader |
| 1358 | a summary of the change is useful when viewing a list of many commits. | 1359 | a summary of the change is useful when viewing a list of many commits. |
| 1359 | This should be prefixed by the recipe name (if changing a recipe), or | 1360 | This short description should be prefixed by the recipe name (if changing a recipe), or |
| 1360 | else the short form path to the file being changed. | 1361 | else the short form path to the file being changed. |
| 1361 | </para></listitem> | 1362 | </para></listitem> |
| 1362 | <listitem><para>For the body of the commit message, provide detailed information | 1363 | <listitem><para>For the body of the commit message, provide detailed information |
| @@ -1371,7 +1372,7 @@ | |||
| 1371 | references - any commit that addresses a specific bug should include the | 1372 | references - any commit that addresses a specific bug should include the |
| 1372 | bug ID in the description (typically at the beginning) as follows: | 1373 | bug ID in the description (typically at the beginning) as follows: |
| 1373 | <literallayout class='monospaced'> | 1374 | <literallayout class='monospaced'> |
| 1374 | [YOCTO #<bug-id>] | 1375 | Fixes YOCTO #<bug-id> |
| 1375 | 1376 | ||
| 1376 | <detailed description of change> | 1377 | <detailed description of change> |
| 1377 | </literallayout></para></listitem> | 1378 | </literallayout></para></listitem> |
| @@ -1387,8 +1388,8 @@ | |||
| 1387 | </para> | 1388 | </para> |
| 1388 | 1389 | ||
| 1389 | <para> | 1390 | <para> |
| 1390 | Following are general instructions for both pushing changes upstream and for submitting | 1391 | The next two sections describe general instructions for both pushing |
| 1391 | changes as patches. | 1392 | changes upstream and for submitting changes as patches. |
| 1392 | </para> | 1393 | </para> |
| 1393 | 1394 | ||
| 1394 | <section id='pushing-a-change-upstream'> | 1395 | <section id='pushing-a-change-upstream'> |
