diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-11-20 20:17:33 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-01-04 10:55:00 +0000 |
commit | fa0cb4d34b1073f215fa3c680f2316208739d53d (patch) | |
tree | ba89c1f4289fd6456af4409a6a19caf6548dfb9c /documentation/overview-manual/overview-manual-development-environment.xml | |
parent | a038e58f3cd82c56102444bdc5ac76c9f1550a0d (diff) | |
download | poky-fa0cb4d34b1073f215fa3c680f2316208739d53d.tar.gz |
sphinx: import docs
The Yocto Project docs was migrated from Docbook to Sphinx in YP
3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to'
the docs in 3.2, we agreed to backport sphinx docs onto 3.1.
This first patch brings all changes done in 3.2 until:
7f64574f7 README: include detailed information about sphinx
There are other changes after this commit, but they will be
selectively backported in individual patches.
This patch was generated with the following command:
git cherry-pick -n \
$(git log --reverse --oneline \
ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \
| cut -f1 -d' ')
The following commits were applies in the dunfell docs, but not in
master, so they were first reverted (and squashed into this change). A
commit will reintroduce the content from these patches in the Sphinx
files in a followup patch.
069c27574 Documenation: Prepared for the 3.1.1 release
bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit
17cc71a8f Documenation: Prepared for the 3.1.2 release
1a69e2c02 Documenation: Prepared for the 3.1.3 release
8910ac1c7 Documenation: Prepared for the 3.1.4 release
(From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual/overview-manual-development-environment.xml')
-rw-r--r-- | documentation/overview-manual/overview-manual-development-environment.xml | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/documentation/overview-manual/overview-manual-development-environment.xml b/documentation/overview-manual/overview-manual-development-environment.xml index 36ebf8a321..08ad071316 100644 --- a/documentation/overview-manual/overview-manual-development-environment.xml +++ b/documentation/overview-manual/overview-manual-development-environment.xml | |||
@@ -1,6 +1,7 @@ | |||
1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > |
4 | <!--SPDX-License-Identifier: CC-BY-2.0-UK--> | ||
4 | 5 | ||
5 | <chapter id='overview-development-environment'> | 6 | <chapter id='overview-development-environment'> |
6 | <title>The Yocto Project Development Environment</title> | 7 | <title>The Yocto Project Development Environment</title> |
@@ -326,7 +327,7 @@ | |||
326 | For the Yocto Project, a key individual called the "maintainer" is | 327 | For the Yocto Project, a key individual called the "maintainer" is |
327 | responsible for the integrity of the "master" branch of a given Git | 328 | responsible for the integrity of the "master" branch of a given Git |
328 | repository. | 329 | repository. |
329 | The "master" branch is the “upstream” repository from which final or | 330 | The "master" branch is the "upstream" repository from which final or |
330 | most recent builds of a project occur. | 331 | most recent builds of a project occur. |
331 | The maintainer is responsible for accepting changes from other | 332 | The maintainer is responsible for accepting changes from other |
332 | developers and for organizing the underlying branch structure to | 333 | developers and for organizing the underlying branch structure to |
@@ -371,7 +372,7 @@ | |||
371 | might arise within files that are being worked on simultaneously by | 372 | might arise within files that are being worked on simultaneously by |
372 | more than one person. | 373 | more than one person. |
373 | All this work is done locally on the development host before | 374 | All this work is done locally on the development host before |
374 | anything is pushed to a "contrib" area and examined at the maintainer’s | 375 | anything is pushed to a "contrib" area and examined at the maintainer's |
375 | level. | 376 | level. |
376 | </para> | 377 | </para> |
377 | 378 | ||
@@ -379,7 +380,7 @@ | |||
379 | A somewhat formal method exists by which developers commit changes | 380 | A somewhat formal method exists by which developers commit changes |
380 | and push them into the "contrib" area and subsequently request that | 381 | and push them into the "contrib" area and subsequently request that |
381 | the maintainer include them into an upstream branch. | 382 | the maintainer include them into an upstream branch. |
382 | This process is called “submitting a patch” or "submitting a change." | 383 | This process is called "submitting a patch" or "submitting a change." |
383 | For information on submitting patches and changes, see the | 384 | For information on submitting patches and changes, see the |
384 | "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>Submitting a Change to the Yocto Project</ulink>" | 385 | "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>Submitting a Change to the Yocto Project</ulink>" |
385 | section in the Yocto Project Development Tasks Manual. | 386 | section in the Yocto Project Development Tasks Manual. |
@@ -388,7 +389,7 @@ | |||
388 | <para> | 389 | <para> |
389 | In summary, a single point of entry | 390 | In summary, a single point of entry |
390 | exists for changes into a "master" or development branch of the | 391 | exists for changes into a "master" or development branch of the |
391 | Git repository, which is controlled by the project’s maintainer. | 392 | Git repository, which is controlled by the project's maintainer. |
392 | And, a set of developers exist who independently develop, test, and | 393 | And, a set of developers exist who independently develop, test, and |
393 | submit changes to "contrib" areas for the maintainer to examine. | 394 | submit changes to "contrib" areas for the maintainer to examine. |
394 | The maintainer then chooses which changes are going to become a | 395 | The maintainer then chooses which changes are going to become a |
@@ -733,7 +734,7 @@ | |||
733 | <listitem><para id='git-commands-clone'> | 734 | <listitem><para id='git-commands-clone'> |
734 | <emphasis><filename>git clone</filename>:</emphasis> | 735 | <emphasis><filename>git clone</filename>:</emphasis> |
735 | Creates a local clone of a Git repository that is on | 736 | Creates a local clone of a Git repository that is on |
736 | equal footing with a fellow developer’s Git repository | 737 | equal footing with a fellow developer's Git repository |
737 | or an upstream repository. | 738 | or an upstream repository. |
738 | </para></listitem> | 739 | </para></listitem> |
739 | <listitem><para> | 740 | <listitem><para> |
@@ -751,7 +752,7 @@ | |||
751 | Commits are used for historical purposes, for determining | 752 | Commits are used for historical purposes, for determining |
752 | if a maintainer of a project will allow the change, | 753 | if a maintainer of a project will allow the change, |
753 | and for ultimately pushing the change from your local | 754 | and for ultimately pushing the change from your local |
754 | Git repository into the project’s upstream repository. | 755 | Git repository into the project's upstream repository. |
755 | </para></listitem> | 756 | </para></listitem> |
756 | <listitem><para> | 757 | <listitem><para> |
757 | <emphasis><filename>git status</filename>:</emphasis> | 758 | <emphasis><filename>git status</filename>:</emphasis> |