diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-08-02 16:01:13 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-08-30 15:54:59 +0100 |
| commit | 8a11abf6a9dac76bf9739c44102a49984e3c2977 (patch) | |
| tree | e9fad45beb65d1330dad49408de14cd164820bd4 /documentation/overview-manual | |
| parent | ddf3b3ecd4b1680dc0dedfd4eaebcf3441b14ca7 (diff) | |
| download | poky-8a11abf6a9dac76bf9739c44102a49984e3c2977.tar.gz | |
manuals: create a dedicated "Contributor Guide" document
Starting from the original contents of dev-manual/changes.rst
and from text contributed by Richard Purdie.
(From yocto-docs rev: 55587d9dd009cbc92273376e0f7665b2d574d280)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual')
| -rw-r--r-- | documentation/overview-manual/development-environment.rst | 19 |
1 files changed, 9 insertions, 10 deletions
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 6139e7a412..55f34c18da 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst | |||
| @@ -232,8 +232,8 @@ and so forth. | |||
| 232 | 232 | ||
| 233 | For information on finding out who is responsible for (maintains) a | 233 | For information on finding out who is responsible for (maintains) a |
| 234 | particular area of code in the Yocto Project, see the | 234 | particular area of code in the Yocto Project, see the |
| 235 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" | 235 | ":doc:`../contributor-guide/identify-component`" |
| 236 | section of the Yocto Project Development Tasks Manual. | 236 | section of the Yocto Project and OpenEmbedded Contributor Guide. |
| 237 | 237 | ||
| 238 | The Yocto Project ``poky`` Git repository also has an upstream | 238 | The Yocto Project ``poky`` Git repository also has an upstream |
| 239 | contribution Git repository named ``poky-contrib``. You can see all the | 239 | contribution Git repository named ``poky-contrib``. You can see all the |
| @@ -264,8 +264,8 @@ push them into the "contrib" area and subsequently request that the | |||
| 264 | maintainer include them into an upstream branch. This process is called | 264 | maintainer include them into an upstream branch. This process is called |
| 265 | "submitting a patch" or "submitting a change." For information on | 265 | "submitting a patch" or "submitting a change." For information on |
| 266 | submitting patches and changes, see the | 266 | submitting patches and changes, see the |
| 267 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" | 267 | ":doc:`../contributor-guide/submit-change`" section in the Yocto Project |
| 268 | section in the Yocto Project Development Tasks Manual. | 268 | and OpenEmbedded Contributor Guide. |
| 269 | 269 | ||
| 270 | In summary, there is a single point of entry for changes into the | 270 | In summary, there is a single point of entry for changes into the |
| 271 | development branch of the Git repository, which is controlled by the | 271 | development branch of the Git repository, which is controlled by the |
| @@ -328,11 +328,10 @@ Book <https://book.git-scm.com>`__. | |||
| 328 | software on which to develop. The Yocto Project has two scripts named | 328 | software on which to develop. The Yocto Project has two scripts named |
| 329 | ``create-pull-request`` and ``send-pull-request`` that ship with the | 329 | ``create-pull-request`` and ``send-pull-request`` that ship with the |
| 330 | release to facilitate this workflow. You can find these scripts in | 330 | release to facilitate this workflow. You can find these scripts in |
| 331 | the ``scripts`` folder of the | 331 | the ``scripts`` folder of the :term:`Source Directory`. For information |
| 332 | :term:`Source Directory`. For information | ||
| 333 | on how to use these scripts, see the | 332 | on how to use these scripts, see the |
| 334 | ":ref:`dev-manual/changes:using scripts to push a change upstream and request a pull`" | 333 | ":ref:`contributor-guide/submit-change:using scripts to push a change upstream and request a pull`" |
| 335 | section in the Yocto Project Development Tasks Manual. | 334 | section in the Yocto Project and OpenEmbedded Contributor Guide. |
| 336 | 335 | ||
| 337 | - *Patch Workflow:* This workflow allows you to notify the maintainer | 336 | - *Patch Workflow:* This workflow allows you to notify the maintainer |
| 338 | through an email that you have a change (or patch) you would like | 337 | through an email that you have a change (or patch) you would like |
| @@ -340,8 +339,8 @@ Book <https://book.git-scm.com>`__. | |||
| 340 | this type of change, you format the patch and then send the email | 339 | this type of change, you format the patch and then send the email |
| 341 | using the Git commands ``git format-patch`` and ``git send-email``. | 340 | using the Git commands ``git format-patch`` and ``git send-email``. |
| 342 | For information on how to use these scripts, see the | 341 | For information on how to use these scripts, see the |
| 343 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" | 342 | ":doc:`../contributor-guide/submit-change`" section in the Yocto Project |
| 344 | section in the Yocto Project Development Tasks Manual. | 343 | and OpenEmbedded Contributor Guide. |
| 345 | 344 | ||
| 346 | Git | 345 | Git |
| 347 | === | 346 | === |
