diff options
-rw-r--r-- | documentation/sdk-manual/sdk-extensible.xml | 85 |
1 files changed, 73 insertions, 12 deletions
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml index bd5278493f..94d2a241fe 100644 --- a/documentation/sdk-manual/sdk-extensible.xml +++ b/documentation/sdk-manual/sdk-extensible.xml | |||
@@ -618,7 +618,23 @@ | |||
618 | The result is that the command sets up both | 618 | The result is that the command sets up both |
619 | the source code and an append file within the | 619 | the source code and an append file within the |
620 | workspace while the recipe remains in its | 620 | workspace while the recipe remains in its |
621 | original location. | 621 | original location.</para> |
622 | |||
623 | <para>Additionally, if you have any non-patch | ||
624 | local files (i.e. files referred to with | ||
625 | <filename>file://</filename> entries in | ||
626 | <filename>SRC_URI</filename> statement excluding | ||
627 | <filename>*.patch/</filename> or | ||
628 | <filename>*.diff</filename>), these files are | ||
629 | copied to an | ||
630 | <filename>oe-local-files</filename> folder | ||
631 | under the newly created source tree. | ||
632 | Copying the files here gives you a convenient | ||
633 | area from which you can modify the files. | ||
634 | Any changes or additions you make to those | ||
635 | files are incorporated into the build the next | ||
636 | time you build the software just as are other | ||
637 | changes you might have made to the source. | ||
622 | </para></listitem> | 638 | </para></listitem> |
623 | <listitem><para> | 639 | <listitem><para> |
624 | <emphasis>Middle</emphasis>: | 640 | <emphasis>Middle</emphasis>: |
@@ -633,10 +649,10 @@ | |||
633 | </para> | 649 | </para> |
634 | 650 | ||
635 | <para>The following command tells | 651 | <para>The following command tells |
636 | <filename>devtool</filename> what recipe with | 652 | <filename>devtool</filename> the recipe with |
637 | which to work and, in this case, identifies a | 653 | which to work and, in this case, identifies a |
638 | local area for the extracted source files that | 654 | local area for the extracted source files that |
639 | is outside of the default | 655 | exists outside of the default |
640 | <filename>devtool</filename> workspace: | 656 | <filename>devtool</filename> workspace: |
641 | <literallayout class='monospaced'> | 657 | <literallayout class='monospaced'> |
642 | $ devtool modify <replaceable>recipe srctree</replaceable> | 658 | $ devtool modify <replaceable>recipe srctree</replaceable> |
@@ -650,8 +666,12 @@ | |||
650 | the recipe's <filename>SRC_URI</filename> | 666 | the recipe's <filename>SRC_URI</filename> |
651 | statements to locate the source files and any | 667 | statements to locate the source files and any |
652 | associated patch files. | 668 | associated patch files. |
653 | Once the files are located, the command by | 669 | Non-patch files are copied to an |
654 | default extracts them into | 670 | <filename>oe-local-files</filename> folder |
671 | under the newly created source tree.</para> | ||
672 | |||
673 | <para>Once the files are located, the command | ||
674 | by default extracts them into | ||
655 | <replaceable>srctree</replaceable>.</para> | 675 | <replaceable>srctree</replaceable>.</para> |
656 | 676 | ||
657 | <para>Within workspace, | 677 | <para>Within workspace, |
@@ -685,9 +705,21 @@ | |||
685 | </literallayout> | 705 | </literallayout> |
686 | </para> | 706 | </para> |
687 | 707 | ||
688 | <para>Once the command finishes, it creates only | 708 | <para>If an <filename>oe-local-files</filename> |
689 | an append file for the recipe in the | 709 | subdirectory happens to exist and it contains |
690 | <filename>devtool</filename> workspace. | 710 | non-patch files, the files are used. |
711 | However, if the subdirectory does not exist and | ||
712 | you run the <filename>devtool finish</filename> | ||
713 | command, any non-patch files that might exist | ||
714 | next to the recipe are removed because it | ||
715 | appears to <filename>devtool</filename> that | ||
716 | you have deleted those files.</para> | ||
717 | |||
718 | <para>Once the | ||
719 | <filename>devtool modify</filename> command | ||
720 | finishes, it creates only an append file for | ||
721 | the recipe in the <filename>devtool</filename> | ||
722 | workspace. | ||
691 | The recipe and the source code remain in their | 723 | The recipe and the source code remain in their |
692 | original locations. | 724 | original locations. |
693 | </para></listitem> | 725 | </para></listitem> |
@@ -778,7 +810,12 @@ | |||
778 | original recipe in the original layer or the command | 810 | original recipe in the original layer or the command |
779 | creates a <filename>.bbappend</filename> file in a | 811 | creates a <filename>.bbappend</filename> file in a |
780 | different layer as provided by | 812 | different layer as provided by |
781 | <replaceable>layer</replaceable>.</para> | 813 | <replaceable>layer</replaceable>. |
814 | Any work you did in the | ||
815 | <filename>oe-local-files</filename> directory is | ||
816 | preserved in the original files next to the recipe | ||
817 | during the <filename>devtool finish</filename> | ||
818 | command.</para> | ||
782 | 819 | ||
783 | <para>As a final process of the | 820 | <para>As a final process of the |
784 | <filename>devtool finish</filename> command, the state | 821 | <filename>devtool finish</filename> command, the state |
@@ -898,7 +935,23 @@ | |||
898 | files from other developers. | 935 | files from other developers. |
899 | The result is that the command sets up the source | 936 | The result is that the command sets up the source |
900 | code, the new version of the recipe, and an append file | 937 | code, the new version of the recipe, and an append file |
901 | all within the workspace. | 938 | all within the workspace.</para> |
939 | |||
940 | <para>Additionally, if you have any non-patch | ||
941 | local files (i.e. files referred to with | ||
942 | <filename>file://</filename> entries in | ||
943 | <filename>SRC_URI</filename> statement excluding | ||
944 | <filename>*.patch/</filename> or | ||
945 | <filename>*.diff</filename>), these files are | ||
946 | copied to an | ||
947 | <filename>oe-local-files</filename> folder | ||
948 | under the newly created source tree. | ||
949 | Copying the files here gives you a convenient | ||
950 | area from which you can modify the files. | ||
951 | Any changes or additions you make to those | ||
952 | files are incorporated into the build the next | ||
953 | time you build the software just as are other | ||
954 | changes you might have made to the source. | ||
902 | </para></listitem> | 955 | </para></listitem> |
903 | <listitem><para> | 956 | <listitem><para> |
904 | <emphasis>Resolve any Conflicts created by the Upgrade</emphasis>: | 957 | <emphasis>Resolve any Conflicts created by the Upgrade</emphasis>: |
@@ -976,10 +1029,18 @@ | |||
976 | Git repository, moves the new recipe to a more | 1029 | Git repository, moves the new recipe to a more |
977 | permanent layer, and then resets the recipe so that | 1030 | permanent layer, and then resets the recipe so that |
978 | the recipe is built normally rather than from the | 1031 | the recipe is built normally rather than from the |
979 | workspace. | 1032 | workspace.</para> |
1033 | |||
1034 | <para>Any work you did in the | ||
1035 | <filename>oe-local-files</filename> directory is | ||
1036 | preserved in the original files next to the recipe | ||
1037 | during the <filename>devtool finish</filename> | ||
1038 | command.</para> | ||
1039 | |||
1040 | <para> | ||
980 | If you specify a destination layer that is the same as | 1041 | If you specify a destination layer that is the same as |
981 | the original source, then the old version of the | 1042 | the original source, then the old version of the |
982 | recipe and associated files will be removed prior to | 1043 | recipe and associated files are removed prior to |
983 | adding the new version. | 1044 | adding the new version. |
984 | <literallayout class='monospaced'> | 1045 | <literallayout class='monospaced'> |
985 | $ devtool finish <replaceable>recipe layer</replaceable> | 1046 | $ devtool finish <replaceable>recipe layer</replaceable> |