diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-08-26 17:06:00 +0300 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-08-30 18:14:13 +0100 |
commit | 987f91e16cb054635fb58cd10c801514ad235771 (patch) | |
tree | 82cb6e5ff0cfe9e4df482af631ed642c4c5358fc /documentation | |
parent | 2abfe0cc3d222f5e84642063f8645ceaf9d66fb2 (diff) | |
download | poky-987f91e16cb054635fb58cd10c801514ad235771.tar.gz |
ref-manual, mega-manual: Edits for expanded packaging description
Fixes [YOCTO #2808]
Applied review comments to the package splitting section in the
section that digs deeper into the build process. This involved
updating the figure that resides in both "figures" directories
of the ref-manual and the mega-manual. Also updated supporting
text throughout the section per Paul's comments.
(From yocto-docs rev: 34e3610d0c6912530f678e9f1fa4587aaaf9fc70)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/mega-manual/figures/analysis-for-package-splitting.png | bin | 58199 -> 67836 bytes | |||
-rw-r--r-- | documentation/ref-manual/figures/analysis-for-package-splitting.png | bin | 58199 -> 67836 bytes | |||
-rw-r--r-- | documentation/ref-manual/technical-details.xml | 54 |
3 files changed, 33 insertions, 21 deletions
diff --git a/documentation/mega-manual/figures/analysis-for-package-splitting.png b/documentation/mega-manual/figures/analysis-for-package-splitting.png index 5edf62c706..e312c84c4a 100644 --- a/documentation/mega-manual/figures/analysis-for-package-splitting.png +++ b/documentation/mega-manual/figures/analysis-for-package-splitting.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/figures/analysis-for-package-splitting.png b/documentation/ref-manual/figures/analysis-for-package-splitting.png index 5edf62c706..e312c84c4a 100644 --- a/documentation/ref-manual/figures/analysis-for-package-splitting.png +++ b/documentation/ref-manual/figures/analysis-for-package-splitting.png | |||
Binary files differ | |||
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 1b67ca7424..1171fec0a4 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml | |||
@@ -1130,38 +1130,49 @@ | |||
1130 | <title>Package Splitting</title> | 1130 | <title>Package Splitting</title> |
1131 | 1131 | ||
1132 | <para> | 1132 | <para> |
1133 | After source code configured and compiled, BitBake analyzes | 1133 | After source code is configured and compiled, the |
1134 | the results and splits the output into package: | 1134 | OpenEmbedded build system analyzes |
1135 | the results and splits the output into packages: | ||
1135 | <imagedata fileref="figures/analysis-for-package-splitting.png" align="center" width="7in" depth="7in" /> | 1136 | <imagedata fileref="figures/analysis-for-package-splitting.png" align="center" width="7in" depth="7in" /> |
1136 | </para> | 1137 | </para> |
1137 | 1138 | ||
1138 | <para> | 1139 | <para> |
1139 | The <filename>do_package</filename> and | 1140 | The <filename>do_package</filename> and |
1140 | <filename>do_packagedata</filename> tasks combine to analyze | 1141 | <filename>do_packagedata</filename> tasks combine to analyze |
1141 | the data found in the | 1142 | the files found in the |
1142 | <link linkend='var-D'><filename>D</filename></link> directory | 1143 | <link linkend='var-D'><filename>D</filename></link> directory |
1143 | and split it into subsets based on available packages and | 1144 | and split them into subsets based on available packages and |
1144 | files. | 1145 | files. |
1145 | The analyzing process involves splitting out debugging symbols, | 1146 | The analyzing process involves the following as well as other |
1146 | looking at shared library dependencies between packages, and | 1147 | items: splitting out debugging symbols, |
1147 | looking at package relationships. | 1148 | looking at shared library dependencies between packages, |
1148 | The <filename>do_packagedata</filename> task puts package | 1149 | and looking at package relationships. |
1149 | metadata based on the analysis such that BitBake can generate | 1150 | The <filename>do_packagedata</filename> task creates package |
1150 | the final packages. | 1151 | metadata based on the analysis such that the |
1151 | Intermediate results of the package analysis and splitting | 1152 | OpenEmbedded build system can generate the final packages. |
1152 | end up in the | 1153 | Working, staged, and intermediate results of the analysis |
1153 | <link linkend='var-PKGDEST'><filename>PKGDEST</filename></link> | 1154 | and package splitting process use these areas: |
1154 | directory with the | 1155 | <itemizedlist> |
1155 | <link linkend='var-FILES'><filename>FILES</filename></link> | 1156 | <listitem><para><link linkend='var-PKGD'><filename>PKGD</filename></link> |
1156 | variable defining the files that go into the packages. | 1157 | </para></listitem> |
1157 | If you want some details on how this is accomplished, you can | 1158 | <listitem><para><link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link> |
1159 | </para></listitem> | ||
1160 | <listitem><para><link linkend='var-PKGDESTWORK'><filename>PKGDESTWORK</filename></link> | ||
1161 | </para></listitem> | ||
1162 | <listitem><para><link linkend='var-PKGDEST'><filename>PKGDEST</filename></link> | ||
1163 | </para></listitem> | ||
1164 | </itemizedlist> | ||
1165 | The <link linkend='var-FILES'><filename>FILES</filename></link> | ||
1166 | variable defines the files that go into each package in | ||
1167 | <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>. | ||
1168 | If you want details on how this is accomplished, you can | ||
1158 | look at | 1169 | look at |
1159 | <link linkend='ref-classes-package'><filename>package.bbclass</filename></link>. | 1170 | <link linkend='ref-classes-package'><filename>package.bbclass</filename></link>. |
1160 | </para> | 1171 | </para> |
1161 | 1172 | ||
1162 | <para> | 1173 | <para> |
1163 | Depending on the type of packages being created (RPM, DEB, or | 1174 | Depending on the type of packages being created (RPM, DEB, or |
1164 | IPK), the <filename>do_packagewrite_*</filename> task | 1175 | IPK), the <filename>do_package_write_*</filename> task |
1165 | creates the actual packages and places them in the | 1176 | creates the actual packages and places them in the |
1166 | Package Feed area, which is | 1177 | Package Feed area, which is |
1167 | <filename>${TMPDIR}/deploy</filename>. | 1178 | <filename>${TMPDIR}/deploy</filename>. |
@@ -1173,9 +1184,10 @@ | |||
1173 | <filename>deploy/*</filename> directories does not exist. | 1184 | <filename>deploy/*</filename> directories does not exist. |
1174 | Creating such feeds usually requires some kind of feed | 1185 | Creating such feeds usually requires some kind of feed |
1175 | maintenance mechanism that would upload the new packages | 1186 | maintenance mechanism that would upload the new packages |
1176 | into an official package feed (e.g. angstrom). | 1187 | into an official package feed (e.g. the |
1177 | Providing such a piece for the user is not feasible since | 1188 | Ångström distribution). |
1178 | it is very distribution-specific. | 1189 | This functionality is highly distribution-specific |
1190 | and thus is not provided out of the box. | ||
1179 | </note> | 1191 | </note> |
1180 | </para> | 1192 | </para> |
1181 | </section> | 1193 | </section> |