diff options
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.rst | 63 |
1 files changed, 25 insertions, 38 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst index d43205712d..2a521905e5 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.rst +++ b/documentation/dev-manual/dev-manual-common-tasks.rst | |||
@@ -10690,19 +10690,10 @@ layers you are contributing to. | |||
10690 | 10690 | ||
10691 | The following sections provide procedures for submitting a change. | 10691 | The following sections provide procedures for submitting a change. |
10692 | 10692 | ||
10693 | .. _pushing-a-change-upstream: | 10693 | .. _preparing-changes-for-submissions: |
10694 | |||
10695 | Using Scripts to Push a Change Upstream and Request a Pull | ||
10696 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
10697 | |||
10698 | Follow this procedure to push a change to an upstream "contrib" Git | ||
10699 | repository: | ||
10700 | 10694 | ||
10701 | .. note:: | 10695 | Preparing Changes for Submission |
10702 | 10696 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
10703 | You can find general Git information on how to push a change upstream | ||
10704 | in the | ||
10705 | `Git Community Book <https://git-scm.com/book/en/v2/Distributed-Git-Distributed-Workflows>`__. | ||
10706 | 10697 | ||
10707 | 1. *Make Your Changes Locally:* Make your changes in your local Git | 10698 | 1. *Make Your Changes Locally:* Make your changes in your local Git |
10708 | repository. You should make small, controlled, isolated changes. | 10699 | repository. You should make small, controlled, isolated changes. |
@@ -10784,7 +10775,22 @@ repository: | |||
10784 | 10775 | ||
10785 | detailed description of change | 10776 | detailed description of change |
10786 | 10777 | ||
10787 | 4. *Push Your Commits to a "Contrib" Upstream:* If you have arranged for | 10778 | .. _pushing-a-change-upstream: |
10779 | |||
10780 | Using Scripts to Push a Change Upstream and Request a Pull | ||
10781 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
10782 | |||
10783 | Follow this procedure to push a change to an upstream "contrib" Git | ||
10784 | repository once the steps in :ref:`preparing-changes-for-submissions` have | ||
10785 | been followed: | ||
10786 | |||
10787 | .. note:: | ||
10788 | |||
10789 | You can find general Git information on how to push a change upstream | ||
10790 | in the | ||
10791 | `Git Community Book <https://git-scm.com/book/en/v2/Distributed-Git-Distributed-Workflows>`__. | ||
10792 | |||
10793 | 1. *Push Your Commits to a "Contrib" Upstream:* If you have arranged for | ||
10788 | permissions to push to an upstream contrib repository, push the | 10794 | permissions to push to an upstream contrib repository, push the |
10789 | change to that repository: | 10795 | change to that repository: |
10790 | :: | 10796 | :: |
@@ -10801,7 +10807,7 @@ repository: | |||
10801 | 10807 | ||
10802 | $ git push meta-intel-contrib your_name/README | 10808 | $ git push meta-intel-contrib your_name/README |
10803 | 10809 | ||
10804 | 5. *Determine Who to Notify:* Determine the maintainer or the mailing | 10810 | 2. *Determine Who to Notify:* Determine the maintainer or the mailing |
10805 | list that you need to notify for the change. | 10811 | list that you need to notify for the change. |
10806 | 10812 | ||
10807 | Before submitting any change, you need to be sure who the maintainer | 10813 | Before submitting any change, you need to be sure who the maintainer |
@@ -10830,7 +10836,7 @@ repository: | |||
10830 | lists <resources-mailinglist>`" section in | 10836 | lists <resources-mailinglist>`" section in |
10831 | the Yocto Project Reference Manual. | 10837 | the Yocto Project Reference Manual. |
10832 | 10838 | ||
10833 | 6. *Make a Pull Request:* Notify the maintainer or the mailing list that | 10839 | 3. *Make a Pull Request:* Notify the maintainer or the mailing list that |
10834 | you have pushed a change by making a pull request. | 10840 | you have pushed a change by making a pull request. |
10835 | 10841 | ||
10836 | The Yocto Project provides two scripts that conveniently let you | 10842 | The Yocto Project provides two scripts that conveniently let you |
@@ -10897,29 +10903,10 @@ mailing lists, see the ":ref:`Mailing Lists <resources-mailinglist>`" section in | |||
10897 | Yocto Project Reference Manual. | 10903 | Yocto Project Reference Manual. |
10898 | 10904 | ||
10899 | Here is the general procedure on how to submit a patch through email | 10905 | Here is the general procedure on how to submit a patch through email |
10900 | without using the scripts: | 10906 | without using the scripts once the steps in |
10901 | 10907 | :ref:`preparing-changes-for-submissions` have been followed: | |
10902 | 1. *Make Your Changes Locally:* Make your changes in your local Git | ||
10903 | repository. You should make small, controlled, isolated changes. | ||
10904 | Keeping changes small and isolated aids review, makes | ||
10905 | merging/rebasing easier and keeps the change history clean should | ||
10906 | anyone need to refer to it in future. | ||
10907 | |||
10908 | 2. *Stage Your Changes:* Stage your changes by using the ``git add`` | ||
10909 | command on each file you changed. | ||
10910 | |||
10911 | 3. *Commit Your Changes:* Commit the change by using the | ||
10912 | ``git commit --signoff`` command. Using the ``--signoff`` option | ||
10913 | identifies you as the person making the change and also satisfies the | ||
10914 | Developer's Certificate of Origin (DCO) shown earlier. | ||
10915 | |||
10916 | When you form a commit, you must follow certain standards established | ||
10917 | by the Yocto Project development team. See :ref:`Step 3 | ||
10918 | <dev-manual/dev-manual-common-tasks:using scripts to push a change upstream and request a pull>` | ||
10919 | in the previous section for information on how to provide commit information | ||
10920 | that meets Yocto Project commit message standards. | ||
10921 | 10908 | ||
10922 | 4. *Format the Commit:* Format the commit into an email message. To | 10909 | 1. *Format the Commit:* Format the commit into an email message. To |
10923 | format commits, use the ``git format-patch`` command. When you | 10910 | format commits, use the ``git format-patch`` command. When you |
10924 | provide the command, you must include a revision list or a number of | 10911 | provide the command, you must include a revision list or a number of |
10925 | patches as part of the command. For example, either of these two | 10912 | patches as part of the command. For example, either of these two |
@@ -10952,7 +10939,7 @@ without using the scripts: | |||
10952 | or to OpenEmbedded, you might consider requesting a contrib area | 10939 | or to OpenEmbedded, you might consider requesting a contrib area |
10953 | and the necessary associated rights. | 10940 | and the necessary associated rights. |
10954 | 10941 | ||
10955 | 5. *Import the Files Into Your Mail Client:* Import the files into your | 10942 | 2. *Import the Files Into Your Mail Client:* Import the files into your |
10956 | mail client by using the ``git send-email`` command. | 10943 | mail client by using the ``git send-email`` command. |
10957 | 10944 | ||
10958 | .. note:: | 10945 | .. note:: |