diff options
| -rw-r--r-- | documentation/ref-manual/ref-tasks.xml | 47 |
1 files changed, 42 insertions, 5 deletions
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index 97c8a9e1dd..a9559bbb0b 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml | |||
| @@ -241,11 +241,48 @@ | |||
| 241 | <title><filename>do_install</filename></title> | 241 | <title><filename>do_install</filename></title> |
| 242 | 242 | ||
| 243 | <para> | 243 | <para> |
| 244 | Copies files from the compilation directory, which is defined by | 244 | Copies files that are to be packaged into the holding area |
| 245 | the | 245 | <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename>. |
| 246 | <link linkend='var-B'><filename>B</filename></link> variable, | 246 | This task runs with the current working directory set to |
| 247 | to a holding area defined by the | 247 | <filename>${</filename><link linkend='var-B'><filename>B</filename></link><filename>}</filename>, |
| 248 | <link linkend='var-D'><filename>D</filename></link> variable. | 248 | which is the compilation directory. |
| 249 | <note> | ||
| 250 | <title>Caution</title> | ||
| 251 | |||
| 252 | <para> | ||
| 253 | When installing files, be careful not to set the owner and | ||
| 254 | group IDs of the installed files to unintended values. | ||
| 255 | Some methods of copying files, notably when using the | ||
| 256 | recursive <filename>cp</filename> command, can preserve the | ||
| 257 | UID and/or GID of the original file, which is usually not | ||
| 258 | what you want. | ||
| 259 | The host-user-contaminated QA check checks for files | ||
| 260 | that probably have the wrong ownership. | ||
| 261 | </para> | ||
| 262 | |||
| 263 | <para> | ||
| 264 | Safe methods for installing files include the following: | ||
| 265 | <itemizedlist> | ||
| 266 | <listitem><para> | ||
| 267 | The <filename>install</filename> utility. | ||
| 268 | This utility is the preferred method. | ||
| 269 | </para></listitem> | ||
| 270 | <listitem><para> | ||
| 271 | The <filename>cp</filename> command with the | ||
| 272 | "--no-preserve=ownership" option. | ||
| 273 | </para></listitem> | ||
| 274 | <listitem><para> | ||
| 275 | The <filename>tar</filename> command with the | ||
| 276 | "--no-same-owner" option. | ||
| 277 | See the <filename>bin_package.bbclass</filename> | ||
| 278 | file in the <filename>meta/classes</filename> | ||
| 279 | directory of the | ||
| 280 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | ||
| 281 | for an example. | ||
| 282 | </para></listitem> | ||
| 283 | </itemizedlist> | ||
| 284 | </para> | ||
| 285 | </note> | ||
| 249 | </para> | 286 | </para> |
| 250 | </section> | 287 | </section> |
| 251 | 288 | ||
