diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2011-07-22 10:26:01 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-08-04 15:06:43 +0100 |
commit | 0e697a6c9e59c79735e3c023f76f7f2d813dea82 (patch) | |
tree | ce227ab40b6d27141036e012c91ad902f925f1e0 /documentation | |
parent | 5c6753735f8a786c510208a6361bd2a8e392d0cf (diff) | |
download | poky-0e697a6c9e59c79735e3c023f76f7f2d813dea82.tar.gz |
documentation/dev-manual/dev-manual-newbie.xml: edits to how to submit change section.
(From yocto-docs rev: 16533369264deb5f93b0d97f0d8491ee45fe23db)
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 | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index ffcbe8b537..6654e7153e 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -495,10 +495,9 @@ | |||
495 | </para> | 495 | </para> |
496 | 496 | ||
497 | <para> | 497 | <para> |
498 | Sometimes you might find it necessary to submit a change or patch to the Yocto Project. | 498 | When you submit a change or patch to the Yocto Project you must follow certain procedures. |
499 | If so, you must follow certain procedures. | ||
500 | In particular, the headers in patches and the commit messages must follow a certain standard. | 499 | In particular, the headers in patches and the commit messages must follow a certain standard. |
501 | The general process is the same as described earlier in this section. | 500 | The general process is the same as described earlier in this chapter. |
502 | For complete details on how to create proper commit messages and patch headers see | 501 | For complete details on how to create proper commit messages and patch headers see |
503 | [WRITER NOTE: I need the link to Mark's wiki page here that describes the process.] | 502 | [WRITER NOTE: I need the link to Mark's wiki page here that describes the process.] |
504 | </para> | 503 | </para> |
@@ -511,17 +510,17 @@ | |||
511 | <title>Pushing a Change Upstream</title> | 510 | <title>Pushing a Change Upstream</title> |
512 | 511 | ||
513 | <para> | 512 | <para> |
514 | The basic flow for pushing a change to an upstream contrib repository is as follows: | 513 | The basic flow for pushing a change to an upstream "contrib" Git repository is as follows: |
515 | <itemizedlist> | 514 | <itemizedlist> |
516 | <listitem><para>Make your changes in your local repository.</para></listitem> | 515 | <listitem><para>Make your changes in your local Git repository.</para></listitem> |
517 | <listitem><para>Stage your commit (or change) by using the <filename>git add</filename> | 516 | <listitem><para>Stage your commit (or change) by using the <filename>git add</filename> |
518 | command.</para></listitem> | 517 | command.</para></listitem> |
519 | <listitem><para>Commit the change by using the <filename>git commit</filename> | 518 | <listitem><para>Commit the change by using the <filename>git commit</filename> |
520 | command and push it to an upstream contrib repository. | 519 | command and push it to the upstream "contrib" repository. |
521 | Be sure to provide a commit message that follows the project’s commit standards.</para></listitem> | 520 | Be sure to provide a commit message that follows the project’s commit standards.</para></listitem> |
522 | <listitem><para>Notify the maintainer that you have pushed a change.</para></listitem> | 521 | <listitem><para>Notify the maintainer that you have pushed a change.</para></listitem> |
523 | </itemizedlist> | 522 | </itemizedlist> |
524 | You can find detailed information on how to push a change upstream | 523 | You can find general Git information on how to push a change upstream |
525 | <ulink url='http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#Developing-With-git'> | 524 | <ulink url='http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#Developing-With-git'> |
526 | here</ulink>. | 525 | here</ulink>. |
527 | </para> | 526 | </para> |
@@ -534,7 +533,7 @@ | |||
534 | If you have a just a few changes you can commit them and then submit them as an email to the maintainer. | 533 | If you have a just a few changes you can commit them and then submit them as an email to the maintainer. |
535 | Here is the general procedure: | 534 | Here is the general procedure: |
536 | <itemizedlist> | 535 | <itemizedlist> |
537 | <listitem><para>Make your changes in your local repository.</para></listitem> | 536 | <listitem><para>Make your changes in your local Git repository.</para></listitem> |
538 | <listitem><para>Stage your commit (or change) by using the <filename>git add</filename> | 537 | <listitem><para>Stage your commit (or change) by using the <filename>git add</filename> |
539 | command.</para></listitem> | 538 | command.</para></listitem> |
540 | <listitem><para>Commit the change by using the <filename>git commit</filename> command. | 539 | <listitem><para>Commit the change by using the <filename>git commit</filename> command. |
@@ -549,7 +548,7 @@ | |||
549 | </itemizedlist> | 548 | </itemizedlist> |
550 | Be aware that there could be protocols and standards that you need to follow for your particular | 549 | Be aware that there could be protocols and standards that you need to follow for your particular |
551 | project. | 550 | project. |
552 | You can find detailed information on the general process | 551 | You can find general Git information for submitting a patch |
553 | <ulink url='http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#sharing-development'> | 552 | <ulink url='http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#sharing-development'> |
554 | here</ulink>. | 553 | here</ulink>. |
555 | </para> | 554 | </para> |