summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-start.rst
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2020-10-18 19:57:10 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-10-20 11:12:06 +0100
commitce8ff73294afda3bc23d0a9ad96332a8034eaa8d (patch)
treea5456e828f74aac368c135b27550c7053f2f0850 /documentation/dev-manual/dev-manual-start.rst
parent5d1102403167fdd4d64ede3119a6c30ad6cfe90b (diff)
downloadpoky-ce8ff73294afda3bc23d0a9ad96332a8034eaa8d.tar.gz
docs: dev-manual: fix typos, highlights, indentation and links
(From yocto-docs rev: ab244dcd48968ea6d0e328808c9aac4aef281032) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-start.rst')
-rw-r--r--documentation/dev-manual/dev-manual-start.rst79
1 files changed, 32 insertions, 47 deletions
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst
index 333c6a566f..a85b86fbfb 100644
--- a/documentation/dev-manual/dev-manual-start.rst
+++ b/documentation/dev-manual/dev-manual-start.rst
@@ -88,12 +88,10 @@ particular working environment and set of practices.
88 .. note:: 88 .. note::
89 89
90 For information about BitBake, see the 90 For information about BitBake, see the
91 BitBake User Manual 91 :doc:`bitbake:index`.
92 .
93 92
94 It is relatively easy to set up Git services and create 93 It is relatively easy to set up Git services and create
95 infrastructure like 94 infrastructure like :yocto_git:`/`, which is based on
96 :yocto_git:`http://git.yoctoproject.org <>`, which is based on
97 server software called ``gitolite`` with ``cgit`` being used to 95 server software called ``gitolite`` with ``cgit`` being used to
98 generate the web interface that lets you view the repositories. The 96 generate the web interface that lets you view the repositories. The
99 ``gitolite`` software identifies users using SSH keys and allows 97 ``gitolite`` software identifies users using SSH keys and allows
@@ -106,10 +104,7 @@ particular working environment and set of practices.
106 However, sites such as the following exist that describe how to 104 However, sites such as the following exist that describe how to
107 perform setup: 105 perform setup:
108 106
109 - `Git documentation <http://git-scm.com/book/ch4-8.html>`__: 107 - `Gitolite <https://gitolite.com>`__: Information for
110 Describes how to install ``gitolite`` on the server.
111
112 - `Gitolite <http://gitolite.com>`__: Information for
113 ``gitolite``. 108 ``gitolite``.
114 109
115 - `Interfaces, frontends, and 110 - `Interfaces, frontends, and
@@ -161,8 +156,7 @@ particular working environment and set of practices.
161 integration" style testing of software components and regression 156 integration" style testing of software components and regression
162 identification and tracking. 157 identification and tracking.
163 158
164 See "`Yocto Project 159 See ":yocto_ab:`Yocto Project Autobuilder <>`" for more
165 Autobuilder <http://autobuilder.yoctoproject.org>`__" for more
166 information and links to buildbot. The Yocto Project team has found 160 information and links to buildbot. The Yocto Project team has found
167 this implementation works well in this role. A public example of 161 this implementation works well in this role. A public example of
168 this is the Yocto Project Autobuilders, which the Yocto Project team 162 this is the Yocto Project Autobuilders, which the Yocto Project team
@@ -207,8 +201,7 @@ particular working environment and set of practices.
207 201
208 .. note:: 202 .. note::
209 203
210 You can also use a more collective push model. The 204 You can also use a more collective push model. The ``gitolite``
211 gitolite
212 software supports both the push and pull models quite easily. 205 software supports both the push and pull models quite easily.
213 206
214 As with any development environment, it is important to document the 207 As with any development environment, it is important to document the
@@ -285,11 +278,10 @@ v2 (WSL).
285.. note:: 278.. note::
286 279
287 The Yocto Project is not compatible with 280 The Yocto Project is not compatible with
288 Windows Subsystem for Linux v1 281 `Windows Subsystem for Linux v1 <https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux>`__.
289 . It is compatible but not officially supported nor validated with 282 It is compatible but not officially supported nor validated with
290 WSLv2. If you still decide to use WSL please upgrade to 283 WSLv2. If you still decide to use WSL please upgrade to
291 WSLv2 284 `WSLv2 <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`__.
292 .
293 285
294Once your build host is set up to use the Yocto Project, further steps 286Once your build host is set up to use the Yocto Project, further steps
295are necessary depending on what you want to accomplish. See the 287are necessary depending on what you want to accomplish. See the
@@ -453,9 +445,9 @@ as your Yocto Project build host:
453 445
454Once you have a container set up, everything is in place to develop just 446Once you have a container set up, everything is in place to develop just
455as if you were running on a native Linux machine. If you are going to 447as if you were running on a native Linux machine. If you are going to
456use the Poky container, see the "`Cloning the ``poky`` 448use the Poky container, see the
457Repository <#cloning-the-poky-repository>`__" section. If you are going 449":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`"
458to use the Extensible SDK container, see the 450section. If you are going to use the Extensible SDK container, see the
459":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto 451":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto
460Project Application Development and the Extensible Software Development 452Project Application Development and the Extensible Software Development
461Kit (eSDK) manual. If you are going to use the Toaster container, see 453Kit (eSDK) manual. If you are going to use the Toaster container, see
@@ -566,10 +558,7 @@ your Yocto Project build host:
566 558
567 The current implementation of WSLv2 does not have out-of-the-box 559 The current implementation of WSLv2 does not have out-of-the-box
568 access to external devices such as those connected through a USB 560 access to external devices such as those connected through a USB
569 port, but it automatically mounts your 561 port, but it automatically mounts your ``C:`` drive on ``/mnt/c/``
570 C:
571 drive on
572 /mnt/c/
573 (and others), which you can use to share deploy artifacts to be later 562 (and others), which you can use to share deploy artifacts to be later
574 flashed on hardware through Windows, but your build directory should 563 flashed on hardware through Windows, but your build directory should
575 not reside inside this mountpoint. 564 not reside inside this mountpoint.
@@ -623,11 +612,8 @@ Use the following procedure to locate the latest upstream copy of the
623 612
624 .. note:: 613 .. note::
625 614
626 For information on cloning a repository, see the " 615 For information on cloning a repository, see the
627 Cloning the 616 ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" section.
628 poky
629 Repository
630 " section.
631 617
632Accessing Index of Releases 618Accessing Index of Releases
633--------------------------- 619---------------------------
@@ -653,12 +639,10 @@ Follow these steps to locate and download a particular tarball:
653 639
654 .. note:: 640 .. note::
655 641
656 The 642 The ``yocto`` directory contains the full array of released Poky
657 yocto 643 tarballs. The ``poky`` directory in the Index of Releases was
658 directory contains the full array of released Poky tarballs. The 644 historically used for very early releases and exists now only for
659 poky 645 retroactive completeness.
660 directory in the Index of Releases was historically used for very
661 early releases and exists now only for retroactive completeness.
662 646
6632. *Select a Component:* Click on any released component in which you 6472. *Select a Component:* Click on any released component in which you
664 are interested (e.g. ``yocto``). 648 are interested (e.g. ``yocto``).
@@ -702,8 +686,7 @@ Releases <#accessing-index-of-releases>`__" section.
702 .. note:: 686 .. note::
703 687
704 For a "map" of Yocto Project releases to version numbers, see the 688 For a "map" of Yocto Project releases to version numbers, see the
705 Releases 689 :yocto_wiki:`Releases </wiki/Releases>` wiki page.
706 wiki page.
707 690
708 You can use the "RELEASE ARCHIVE" link to reveal a menu of all Yocto 691 You can use the "RELEASE ARCHIVE" link to reveal a menu of all Yocto
709 Project releases. 692 Project releases.
@@ -825,8 +808,9 @@ and then specifically check out that development branch.
825 808
8261. *Switch to the Poky Directory:* If you have a local poky Git 8091. *Switch to the Poky Directory:* If you have a local poky Git
827 repository, switch to that directory. If you do not have the local 810 repository, switch to that directory. If you do not have the local
828 copy of poky, see the "`Cloning the ``poky`` 811 copy of poky, see the
829 Repository <#cloning-the-poky-repository>`__" section. 812 ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`"
813 section.
830 814
8312. *Determine Existing Branch Names:* 8152. *Determine Existing Branch Names:*
832 :: 816 ::
@@ -854,13 +838,13 @@ and then specifically check out that development branch.
854 &DISTRO; Release (&DISTRO_NAME;), use the following command: 838 &DISTRO; Release (&DISTRO_NAME;), use the following command:
855 :: 839 ::
856 840
857 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; 841 $ git checkout -b &DISTRO_NAME_NO_CAP; origin/&DISTRO_NAME_NO_CAP;
858 Branch &DISTRO_NAME; set up to track remote branch &DISTRO_NAME; from origin. 842 Branch &DISTRO_NAME_NO_CAP; set up to track remote branch &DISTRO_NAME_NO_CAP; from origin.
859 Switched to a new branch '&DISTRO_NAME;' 843 Switched to a new branch '&DISTRO_NAME_NO_CAP;'
860 844
861 The previous command checks out the "&DISTRO_NAME;" development 845 The previous command checks out the "&DISTRO_NAME_NO_CAP;" development
862 branch and reports that the branch is tracking the upstream 846 branch and reports that the branch is tracking the upstream
863 "origin/&DISTRO_NAME;" branch. 847 "origin/&DISTRO_NAME_NO_CAP;" branch.
864 848
865 The following command displays the branches that are now part of your 849 The following command displays the branches that are now part of your
866 local poky repository. The asterisk character indicates the branch 850 local poky repository. The asterisk character indicates the branch
@@ -868,8 +852,8 @@ and then specifically check out that development branch.
868 :: 852 ::
869 853
870 $ git branch 854 $ git branch
871 master * 855 master
872 &DISTRO_NAME; 856 * &DISTRO_NAME_NO_CAP;
873 857
874.. _checkout-out-by-tag-in-poky: 858.. _checkout-out-by-tag-in-poky:
875 859
@@ -889,8 +873,9 @@ similar to checking out by branch name except you use tag names.
889 873
8901. *Switch to the Poky Directory:* If you have a local poky Git 8741. *Switch to the Poky Directory:* If you have a local poky Git
891 repository, switch to that directory. If you do not have the local 875 repository, switch to that directory. If you do not have the local
892 copy of poky, see the "`Cloning the ``poky`` 876 copy of poky, see the
893 Repository <#cloning-the-poky-repository>`__" section. 877 ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`"
878 section.
894 879
8952. *Fetch the Tag Names:* To checkout the branch based on a tag name, 8802. *Fetch the Tag Names:* To checkout the branch based on a tag name,
896 you need to fetch the upstream tags into your local repository: 881 you need to fetch the upstream tags into your local repository: