diff options
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 36 |
1 files changed, 21 insertions, 15 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 678b102c50..66bb6a8138 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -2637,10 +2637,11 @@ | |||
2637 | </para> | 2637 | </para> |
2638 | 2638 | ||
2639 | <para> | 2639 | <para> |
2640 | To use the <filename>FILES</filename> variable, provide a package name | 2640 | To use the <filename>FILES</filename> variable, provide a |
2641 | override that identifies the resulting package. | 2641 | package name override that identifies the resulting package. |
2642 | Then, provide a space-separated list of files or paths that identifies the | 2642 | Then, provide a space-separated list of files or paths |
2643 | files you want included as part of the resulting package. | 2643 | that identify the files you want included as part of the |
2644 | resulting package. | ||
2644 | Here is an example: | 2645 | Here is an example: |
2645 | <literallayout class='monospaced'> | 2646 | <literallayout class='monospaced'> |
2646 | FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile" | 2647 | FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile" |
@@ -2648,24 +2649,29 @@ | |||
2648 | </para> | 2649 | </para> |
2649 | 2650 | ||
2650 | <note> | 2651 | <note> |
2651 | When specifying paths as part of the <filename>FILES</filename> variable, | 2652 | When specifying paths as part of the |
2652 | it is good practice to use appropriate path variables. | 2653 | <filename>FILES</filename> variable, it is good practice |
2653 | For example, use <filename>${sysconfdir}</filename> rather than | 2654 | to use appropriate path variables. |
2654 | <filename>/etc</filename>, or <filename>${bindir}</filename> rather | 2655 | For example, use <filename>${sysconfdir}</filename> rather |
2655 | than <filename>/usr/bin</filename>. | 2656 | than <filename>/etc</filename>, or |
2657 | <filename>${bindir}</filename> rather than | ||
2658 | <filename>/usr/bin</filename>. | ||
2656 | You can find a list of these variables at the top of the | 2659 | You can find a list of these variables at the top of the |
2657 | <filename>meta/conf/bitbake.conf</filename> file in the | 2660 | <filename>meta/conf/bitbake.conf</filename> file in the |
2658 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 2661 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |
2659 | </note> | 2662 | </note> |
2660 | 2663 | ||
2661 | <para> | 2664 | <para> |
2662 | If some of the files you provide with the <filename>FILES</filename> variable | 2665 | If some of the files you provide with the |
2663 | are editable and you know they should not be | 2666 | <filename>FILES</filename> variable are editable and you |
2664 | overwritten during the package update process by the Package Management | 2667 | know they should not be overwritten during the package |
2665 | System (PMS), you can identify these files so that the PMS will not | 2668 | update process by the Package Management System (PMS), you |
2669 | can identify these files so that the PMS will not | ||
2666 | overwrite them. | 2670 | overwrite them. |
2667 | See the <filename><link linkend='var-CONFFILES'>CONFFILES</link></filename> | 2671 | See the |
2668 | variable for information on how to identify these files to the PMS. | 2672 | <link linkend='var-CONFFILES'><filename>CONFFILES</filename></link> |
2673 | variable for information on how to identify these files to | ||
2674 | the PMS. | ||
2669 | </para> | 2675 | </para> |
2670 | 2676 | ||
2671 | </glossdef> | 2677 | </glossdef> |