From: "Paul Barker" <pbarker@konsulko.com>
To: docs@lists.yoctoproject.org
Cc: Paul Barker <pbarker@konsulko.com>
Subject: [PATCH v2 4/9] dev-manual-common-tasks: Tidy up patch submission process
Date: Wed, 18 Nov 2020 10:07:00 +0000 [thread overview]
Message-ID: <20201118100705.3656-4-pbarker@konsulko.com> (raw)
In-Reply-To: <20201118100705.3656-1-pbarker@konsulko.com>
Reduce duplication by pulling out the common steps of committing changes
locally from the steps of submitting those changes via the pull request
scripts or via email.
Signed-off-by: Paul Barker <pbarker@konsulko.com>
---
.../dev-manual/dev-manual-common-tasks.rst | 63 ++++++++-----------
1 file 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 d53f68cc1..72481ae50 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -10689,19 +10689,10 @@ layers you are contributing to.
The following sections provide procedures for submitting a change.
-.. _pushing-a-change-upstream:
-
-Using Scripts to Push a Change Upstream and Request a Pull
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Follow this procedure to push a change to an upstream "contrib" Git
-repository:
+.. _preparing-changes-for-submissions:
-.. note::
-
- You can find general Git information on how to push a change upstream
- in the
- `Git Community Book <https://git-scm.com/book/en/v2/Distributed-Git-Distributed-Workflows>`__.
+Preparing Changes for Submission
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. *Make Your Changes Locally:* Make your changes in your local Git
repository. You should make small, controlled, isolated changes.
@@ -10783,7 +10774,22 @@ repository:
detailed description of change
-4. *Push Your Commits to a "Contrib" Upstream:* If you have arranged for
+.. _pushing-a-change-upstream:
+
+Using Scripts to Push a Change Upstream and Request a Pull
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Follow this procedure to push a change to an upstream "contrib" Git
+repository once the steps in :ref:`preparing-changes-for-submissions` have
+been followed:
+
+.. note::
+
+ You can find general Git information on how to push a change upstream
+ in the
+ `Git Community Book <https://git-scm.com/book/en/v2/Distributed-Git-Distributed-Workflows>`__.
+
+1. *Push Your Commits to a "Contrib" Upstream:* If you have arranged for
permissions to push to an upstream contrib repository, push the
change to that repository:
::
@@ -10800,7 +10806,7 @@ repository:
$ git push meta-intel-contrib your_name/README
-5. *Determine Who to Notify:* Determine the maintainer or the mailing
+2. *Determine Who to Notify:* Determine the maintainer or the mailing
list that you need to notify for the change.
Before submitting any change, you need to be sure who the maintainer
@@ -10829,7 +10835,7 @@ repository:
lists <resources-mailinglist>`" section in
the Yocto Project Reference Manual.
-6. *Make a Pull Request:* Notify the maintainer or the mailing list that
+3. *Make a Pull Request:* Notify the maintainer or the mailing list that
you have pushed a change by making a pull request.
The Yocto Project provides two scripts that conveniently let you
@@ -10896,29 +10902,10 @@ mailing lists, see the ":ref:`Mailing Lists <resources-mailinglist>`" section in
Yocto Project Reference Manual.
Here is the general procedure on how to submit a patch through email
-without using the scripts:
-
-1. *Make Your Changes Locally:* Make your changes in your local Git
- repository. You should make small, controlled, isolated changes.
- Keeping changes small and isolated aids review, makes
- merging/rebasing easier and keeps the change history clean should
- anyone need to refer to it in future.
-
-2. *Stage Your Changes:* Stage your changes by using the ``git add``
- command on each file you changed.
-
-3. *Commit Your Changes:* Commit the change by using the
- ``git commit --signoff`` command. Using the ``--signoff`` option
- identifies you as the person making the change and also satisfies the
- Developer's Certificate of Origin (DCO) shown earlier.
-
- When you form a commit, you must follow certain standards established
- by the Yocto Project development team. See :ref:`Step 3
- <dev-manual/dev-manual-common-tasks:using scripts to push a change upstream and request a pull>`
- in the previous section for information on how to provide commit information
- that meets Yocto Project commit message standards.
+without using the scripts once the steps in
+:ref:`preparing-changes-for-submissions` have been followed:
-4. *Format the Commit:* Format the commit into an email message. To
+1. *Format the Commit:* Format the commit into an email message. To
format commits, use the ``git format-patch`` command. When you
provide the command, you must include a revision list or a number of
patches as part of the command. For example, either of these two
@@ -10951,7 +10938,7 @@ without using the scripts:
or to OpenEmbedded, you might consider requesting a contrib area
and the necessary associated rights.
-5. *Import the Files Into Your Mail Client:* Import the files into your
+2. *Import the Files Into Your Mail Client:* Import the files into your
mail client by using the ``git send-email`` command.
.. note::
--
2.20.1
next prev parent reply other threads:[~2020-11-18 10:07 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-18 10:06 [PATCH v2 1/9] conf.py: Add oe_git directive Paul Barker
2020-11-18 10:06 ` [PATCH v2 2/9] dev-manual-common-tasks: Fix refs to testing branches Paul Barker
2020-11-18 11:23 ` [docs] " Nicolas Dechesne
2020-11-20 12:12 ` Paul Barker
2020-11-23 15:39 ` Paul Barker
2020-11-23 16:00 ` Nicolas Dechesne
2020-11-23 16:05 ` Quentin Schulz
2020-11-23 16:07 ` Paul Barker
2020-11-23 16:58 ` Nicolas Dechesne
2020-11-23 17:46 ` Paul Barker
2020-11-18 10:06 ` [PATCH v2 3/9] dev-manual-common-tasks: Update & move patchwork reference Paul Barker
2020-11-18 10:07 ` Paul Barker [this message]
2020-11-18 10:07 ` [PATCH v2 5/9] dev-manual-common-tasks: Describe git-send-email accurately Paul Barker
2020-11-18 10:07 ` [PATCH v2 6/9] dev-manual-common-tasks: Describe how to handle patch feedback Paul Barker
2020-11-18 10:07 ` [PATCH v2 7/9] dev-manual-common-tasks: Describe how to propose changes to stable branches Paul Barker
2020-11-18 11:39 ` [docs] " Nicolas Dechesne
2020-11-18 10:07 ` [PATCH v2 8/9] dev-manual-common-tasks: Re-order patch submission instructions Paul Barker
2020-11-18 10:07 ` [PATCH v2 9/9] documentation/README: Refer to top-level README for contributions Paul Barker
2020-11-18 11:42 ` [docs] [PATCH v2 1/9] conf.py: Add oe_git directive Nicolas Dechesne
2020-11-18 14:39 ` Quentin Schulz
2020-11-18 14:52 ` Nicolas Dechesne
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201118100705.3656-4-pbarker@konsulko.com \
--to=pbarker@konsulko.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.