diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2021-04-16 18:27:05 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-04-23 16:39:03 +0100 |
commit | c3c6de21876aad811e08538544c8fe76d22ccd09 (patch) | |
tree | e22ee00a9c1ec588965f32050a42e05946bc9f71 /documentation/dev-manual/start.rst | |
parent | 773536c333248214f8f41eff698d8bfd3c687249 (diff) | |
download | poky-c3c6de21876aad811e08538544c8fe76d22ccd09.tar.gz |
manuals: code insertion simplification over two lines
This simplifies paragraphs ending with a colon and followed
by code insertion.
Automatically substituted through the command:
sed -i -z "s/:\n\s*::/::/g" file.rst
This generates identical HTML output.
(From yocto-docs rev: 28e2192a7c12d64b68061138a9f6c796453eebb1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/start.rst')
-rw-r--r-- | documentation/dev-manual/start.rst | 30 |
1 files changed, 10 insertions, 20 deletions
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 84abf4c51f..f8c8637d47 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst | |||
@@ -486,8 +486,7 @@ your Yocto Project build host: | |||
486 | distribution. | 486 | distribution. |
487 | 487 | ||
488 | 3. *Check your Linux distribution is using WSLv2:* Open a Windows | 488 | 3. *Check your Linux distribution is using WSLv2:* Open a Windows |
489 | PowerShell and run: | 489 | PowerShell and run:: |
490 | :: | ||
491 | 490 | ||
492 | C:\WINDOWS\system32> wsl -l -v | 491 | C:\WINDOWS\system32> wsl -l -v |
493 | NAME STATE VERSION | 492 | NAME STATE VERSION |
@@ -514,8 +513,7 @@ your Yocto Project build host: | |||
514 | 513 | ||
515 | 1. *Find the location of your VHDX file:* First you need to find the | 514 | 1. *Find the location of your VHDX file:* First you need to find the |
516 | distro app package directory, to achieve this open a Windows | 515 | distro app package directory, to achieve this open a Windows |
517 | Powershell as Administrator and run: | 516 | Powershell as Administrator and run:: |
518 | :: | ||
519 | 517 | ||
520 | C:\WINDOWS\system32> Get-AppxPackage -Name "*Ubuntu*" | Select PackageFamilyName | 518 | C:\WINDOWS\system32> Get-AppxPackage -Name "*Ubuntu*" | Select PackageFamilyName |
521 | PackageFamilyName | 519 | PackageFamilyName |
@@ -525,8 +523,7 @@ your Yocto Project build host: | |||
525 | 523 | ||
526 | You should now | 524 | You should now |
527 | replace the PackageFamilyName and your user on the following path | 525 | replace the PackageFamilyName and your user on the following path |
528 | to find your VHDX file: | 526 | to find your VHDX file:: |
529 | :: | ||
530 | 527 | ||
531 | ls C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ | 528 | ls C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ |
532 | Mode LastWriteTime Length Name | 529 | Mode LastWriteTime Length Name |
@@ -536,8 +533,7 @@ your Yocto Project build host: | |||
536 | ``C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ext4.vhdx`` | 533 | ``C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ext4.vhdx`` |
537 | 534 | ||
538 | 2. *Optimize your VHDX file:* Open a Windows Powershell as | 535 | 2. *Optimize your VHDX file:* Open a Windows Powershell as |
539 | Administrator to optimize your VHDX file, shutting down WSL first: | 536 | Administrator to optimize your VHDX file, shutting down WSL first:: |
540 | :: | ||
541 | 537 | ||
542 | C:\WINDOWS\system32> wsl --shutdown | 538 | C:\WINDOWS\system32> wsl --shutdown |
543 | C:\WINDOWS\system32> optimize-vhd -Path C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ext4.vhdx -Mode full | 539 | C:\WINDOWS\system32> optimize-vhd -Path C:\Users\myuser\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79abcdefgh\LocalState\ext4.vhdx -Mode full |
@@ -741,8 +737,7 @@ Follow these steps to create a local version of the upstream | |||
741 | 737 | ||
742 | 2. *Clone the Repository:* The following example command clones the | 738 | 2. *Clone the Repository:* The following example command clones the |
743 | ``poky`` repository and uses the default name "poky" for your local | 739 | ``poky`` repository and uses the default name "poky" for your local |
744 | repository: | 740 | repository:: |
745 | :: | ||
746 | 741 | ||
747 | $ git clone git://git.yoctoproject.org/poky | 742 | $ git clone git://git.yoctoproject.org/poky |
748 | Cloning into 'poky'... | 743 | Cloning into 'poky'... |
@@ -764,8 +759,7 @@ Follow these steps to create a local version of the upstream | |||
764 | 759 | ||
765 | Once the local repository is created, you can change to that | 760 | Once the local repository is created, you can change to that |
766 | directory and check its status. Here, the single "master" branch | 761 | directory and check its status. Here, the single "master" branch |
767 | exists on your system and by default, it is checked out: | 762 | exists on your system and by default, it is checked out:: |
768 | :: | ||
769 | 763 | ||
770 | $ cd poky | 764 | $ cd poky |
771 | $ git status | 765 | $ git status |
@@ -826,8 +820,7 @@ and then specifically check out that development branch. | |||
826 | 820 | ||
827 | 3. *Check out the Branch:* Check out the development branch in which you | 821 | 3. *Check out the Branch:* Check out the development branch in which you |
828 | want to work. For example, to access the files for the Yocto Project | 822 | want to work. For example, to access the files for the Yocto Project |
829 | &DISTRO; Release (&DISTRO_NAME;), use the following command: | 823 | &DISTRO; Release (&DISTRO_NAME;), use the following command:: |
830 | :: | ||
831 | 824 | ||
832 | $ git checkout -b &DISTRO_NAME_NO_CAP; origin/&DISTRO_NAME_NO_CAP; | 825 | $ git checkout -b &DISTRO_NAME_NO_CAP; origin/&DISTRO_NAME_NO_CAP; |
833 | Branch &DISTRO_NAME_NO_CAP; set up to track remote branch &DISTRO_NAME_NO_CAP; from origin. | 826 | Branch &DISTRO_NAME_NO_CAP; set up to track remote branch &DISTRO_NAME_NO_CAP; from origin. |
@@ -839,8 +832,7 @@ and then specifically check out that development branch. | |||
839 | 832 | ||
840 | The following command displays the branches that are now part of your | 833 | The following command displays the branches that are now part of your |
841 | local poky repository. The asterisk character indicates the branch | 834 | local poky repository. The asterisk character indicates the branch |
842 | that is currently checked out for work: | 835 | that is currently checked out for work:: |
843 | :: | ||
844 | 836 | ||
845 | $ git branch | 837 | $ git branch |
846 | master | 838 | master |
@@ -867,14 +859,12 @@ similar to checking out by branch name except you use tag names. | |||
867 | section. | 859 | section. |
868 | 860 | ||
869 | 2. *Fetch the Tag Names:* To checkout the branch based on a tag name, | 861 | 2. *Fetch the Tag Names:* To checkout the branch based on a tag name, |
870 | you need to fetch the upstream tags into your local repository: | 862 | you need to fetch the upstream tags into your local repository:: |
871 | :: | ||
872 | 863 | ||
873 | $ git fetch --tags | 864 | $ git fetch --tags |
874 | $ | 865 | $ |
875 | 866 | ||
876 | 3. *List the Tag Names:* You can list the tag names now: | 867 | 3. *List the Tag Names:* You can list the tag names now:: |
877 | :: | ||
878 | 868 | ||
879 | $ git tag | 869 | $ git tag |
880 | 1.1_M1.final | 870 | 1.1_M1.final |