summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual/sdk-extensible.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-05-30 15:15:59 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-06-15 11:26:46 +0100
commit779f47897d5d7e5d9d8c25633c98fbb03745b5b4 (patch)
tree7cf6ad02da964ac2ba33f90ded5c4859aa5d50a5 /documentation/sdk-manual/sdk-extensible.xml
parentd0373e0834268385c388a5fb730e7102769c027b (diff)
downloadpoky-779f47897d5d7e5d9d8c25633c98fbb03745b5b4.tar.gz
sdk-manual: Changes to the devtool upgrade section.
Edits to improve this section. (From yocto-docs rev: f062882b3b3cf9c454466fa9d243284d97592bdc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/sdk-manual/sdk-extensible.xml')
-rw-r--r--documentation/sdk-manual/sdk-extensible.xml81
1 files changed, 52 insertions, 29 deletions
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml
index 2fd2bf0239..82f123be71 100644
--- a/documentation/sdk-manual/sdk-extensible.xml
+++ b/documentation/sdk-manual/sdk-extensible.xml
@@ -708,9 +708,25 @@
708 your source code modifications. 708 your source code modifications.
709 </para></listitem> 709 </para></listitem>
710 <listitem><para> 710 <listitem><para>
711 <emphasis>Build the Recipe</emphasis>: 711 <emphasis>Build the Recipe or Rebuild the Image</emphasis>:
712 Once you have updated the source files, you can build 712 The next step you take depends on what you are going
713 the recipe. 713 to do with the new code.</para>
714
715 <para>If you need to eventually move the build output
716 to the target hardware, use the following
717 <filename>devtool</filename> command:
718 <literallayout class='monospaced'>
719 $ devtool build <replaceable>recipe</replaceable>
720 </literallayout></para>
721
722 <para>On the other hand, if you want an image to
723 contain the recipe's packages from the workspace
724 for immediate deployment onto a device (e.g. for
725 testing purposes), you can use
726 the <filename>devtool build-image</filename> command:
727 <literallayout class='monospaced'>
728 $ devtool build-image <replaceable>image</replaceable>
729 </literallayout>
714 </para></listitem> 730 </para></listitem>
715 <listitem><para> 731 <listitem><para>
716 <emphasis>Deploy the Build Output</emphasis>: 732 <emphasis>Deploy the Build Output</emphasis>:
@@ -800,7 +816,7 @@
800 workflow to make sure your recipes you are using for builds 816 workflow to make sure your recipes you are using for builds
801 are up-to-date with their upstream counterparts. 817 are up-to-date with their upstream counterparts.
802 <note> 818 <note>
803 Several methods exist by which you can upgrade recipes. 819 Several methods exist by which you can upgrade recipes -
804 <filename>devtool upgrade</filename> happens to be one. 820 <filename>devtool upgrade</filename> happens to be one.
805 You can read about all the methods by which you can 821 You can read about all the methods by which you can
806 upgrade recipes in the 822 upgrade recipes in the
@@ -819,12 +835,8 @@
819 </para> 835 </para>
820 836
821 <para> 837 <para>
822 Depending on your particular scenario, the arguments and 838 The following diagram shows the common development flow
823 options you use with <filename>devtool upgrade</filename> form 839 used with the <filename>devtool upgrade</filename> command:
824 different combinations.
825 The following diagram shows a common development flow
826 you would use with the <filename>devtool upgrade</filename>
827 command:
828 </para> 840 </para>
829 841
830 <para> 842 <para>
@@ -835,19 +847,18 @@
835 <orderedlist> 847 <orderedlist>
836 <listitem><para> 848 <listitem><para>
837 <emphasis>Initiate the Upgrade</emphasis>: 849 <emphasis>Initiate the Upgrade</emphasis>:
838 The top part of the flow shows a typical scenario by 850 The top part of the flow shows the typical scenario by
839 which you could use 851 which you use the <filename>devtool upgrade</filename>
840 <filename>devtool upgrade</filename>. 852 command.
841 The following conditions exist: 853 The following conditions exist:
842 <itemizedlist> 854 <itemizedlist>
843 <listitem><para> 855 <listitem><para>
844 The recipe exists in some layer external 856 The recipe exists in a local layer external
845 to the <filename>devtool</filename> workspace. 857 to the <filename>devtool</filename> workspace.
846 </para></listitem> 858 </para></listitem>
847 <listitem><para> 859 <listitem><para>
848 The source files for the new release 860 The source files for the new release
849 exist adjacent to the same location pointed to 861 exist in the same location pointed to by
850 by
851 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> 862 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
852 in the recipe (e.g. a tarball with the new 863 in the recipe (e.g. a tarball with the new
853 version number in the name, or as a different 864 version number in the name, or as a different
@@ -888,19 +899,19 @@
888 <para>Once <filename>devtool</filename> locates the 899 <para>Once <filename>devtool</filename> locates the
889 recipe, it uses the <filename>SRC_URI</filename> 900 recipe, it uses the <filename>SRC_URI</filename>
890 variable to locate the source code and any local patch 901 variable to locate the source code and any local patch
891 files from other developers are located. 902 files from other developers.
892 The result is that the command sets up the source 903 The result is that the command sets up the source
893 code, the new version of the recipe, and an append file 904 code, the new version of the recipe, and an append file
894 all within the workspace. 905 all within the workspace.
895 </para></listitem> 906 </para></listitem>
896 <listitem><para><emphasis> 907 <listitem><para>
897 Resolve any Conflicts created by the Upgrade</emphasis>: 908 <emphasis>Resolve any Conflicts created by the Upgrade</emphasis>:
898 At this point, conflicts could exist due to the 909 Conflicts could exist due to the software being
899 software being upgraded to a new version. 910 upgraded to a new version.
900 Conflicts occur if your recipe specifies some patch 911 Conflicts occur if your recipe specifies some patch
901 files in <filename>SRC_URI</filename> that conflict 912 files in <filename>SRC_URI</filename> that conflict
902 with changes made in the new version of the software. 913 with changes made in the new version of the software.
903 If this is the case, you need to resolve the conflicts 914 For such cases, you need to resolve the conflicts
904 by editing the source and following the normal 915 by editing the source and following the normal
905 <filename>git rebase</filename> conflict resolution 916 <filename>git rebase</filename> conflict resolution
906 process.</para> 917 process.</para>
@@ -910,13 +921,25 @@
910 newer or different version of the software. 921 newer or different version of the software.
911 </para></listitem> 922 </para></listitem>
912 <listitem><para> 923 <listitem><para>
913 <emphasis>Build the Recipe</emphasis>: 924 <emphasis>Build the Recipe or Rebuild the Image</emphasis>:
914 Once you have your recipe in order, you can build it. 925 The next step you take depends on what you are going
915 You can either use <filename>devtool build</filename> 926 to do with the new code.</para>
916 or <filename>bitbake</filename>. 927
917 Either method produces build output that is stored 928 <para>If you need to eventually move the build output
918 in 929 to the target hardware, use the following
919 <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink>. 930 <filename>devtool</filename> command:
931 <literallayout class='monospaced'>
932 $ devtool build <replaceable>recipe</replaceable>
933 </literallayout></para>
934
935 <para>On the other hand, if you want an image to
936 contain the recipe's packages from the workspace
937 for immediate deployment onto a device (e.g. for
938 testing purposes), you can use
939 the <filename>devtool build-image</filename> command:
940 <literallayout class='monospaced'>
941 $ devtool build-image <replaceable>image</replaceable>
942 </literallayout>
920 </para></listitem> 943 </para></listitem>
921 <listitem><para> 944 <listitem><para>
922 <emphasis>Deploy the Build Output</emphasis>: 945 <emphasis>Deploy the Build Output</emphasis>: