diff options
| author | Richard Purdie <richard@openedhand.com> | 2007-01-08 23:53:01 +0000 |
|---|---|---|
| committer | Richard Purdie <richard@openedhand.com> | 2007-01-08 23:53:01 +0000 |
| commit | f5665d5bfcfb13d01da9e4c7d5046453e80f7baf (patch) | |
| tree | b8908549afaf3006bf3763419711090ac999c2a4 /bitbake/doc | |
| parent | aec95de5f7dca2afa3a4a0bdb0d4d553c13f680d (diff) | |
| download | poky-f5665d5bfcfb13d01da9e4c7d5046453e80f7baf.tar.gz | |
bitbake: Sync with upstream.
* File licence headers were sanitised causing most of the diff.
* cooker.py was created from bin/bitbake.
* cvs fetcher port option was added
* The -f force option was fixed to work correctly
* Multiple entries in rrecrdeps are now handled correctly
(allows adding do_deploy to image depends)
git-svn-id: https://svn.o-hand.com/repos/poky/trunk@1129 311d38ba-8fff-0310-9ca6-ca027cbcb966
Diffstat (limited to 'bitbake/doc')
| -rw-r--r-- | bitbake/doc/COPYING.GPL | 27 | ||||
| -rw-r--r-- | bitbake/doc/bitbake.1 | 117 |
2 files changed, 130 insertions, 14 deletions
diff --git a/bitbake/doc/COPYING.GPL b/bitbake/doc/COPYING.GPL index d60c31a97a..d511905c16 100644 --- a/bitbake/doc/COPYING.GPL +++ b/bitbake/doc/COPYING.GPL | |||
| @@ -1,8 +1,8 @@ | |||
| 1 | GNU GENERAL PUBLIC LICENSE | 1 | GNU GENERAL PUBLIC LICENSE |
| 2 | Version 2, June 1991 | 2 | Version 2, June 1991 |
| 3 | 3 | ||
| 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc. | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., |
| 5 | 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 6 | Everyone is permitted to copy and distribute verbatim copies | 6 | Everyone is permitted to copy and distribute verbatim copies |
| 7 | of this license document, but changing it is not allowed. | 7 | of this license document, but changing it is not allowed. |
| 8 | 8 | ||
| @@ -15,7 +15,7 @@ software--to make sure the software is free for all its users. This | |||
| 15 | General Public License applies to most of the Free Software | 15 | General Public License applies to most of the Free Software |
| 16 | Foundation's software and to any other program whose authors commit to | 16 | Foundation's software and to any other program whose authors commit to |
| 17 | using it. (Some other Free Software Foundation software is covered by | 17 | using it. (Some other Free Software Foundation software is covered by |
| 18 | the GNU Library General Public License instead.) You can apply it to | 18 | the GNU Lesser General Public License instead.) You can apply it to |
| 19 | your programs, too. | 19 | your programs, too. |
| 20 | 20 | ||
| 21 | When we speak of free software, we are referring to freedom, not | 21 | When we speak of free software, we are referring to freedom, not |
| @@ -55,7 +55,7 @@ patent must be licensed for everyone's free use or not licensed at all. | |||
| 55 | 55 | ||
| 56 | The precise terms and conditions for copying, distribution and | 56 | The precise terms and conditions for copying, distribution and |
| 57 | modification follow. | 57 | modification follow. |
| 58 | 58 | ||
| 59 | GNU GENERAL PUBLIC LICENSE | 59 | GNU GENERAL PUBLIC LICENSE |
| 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION | 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION |
| 61 | 61 | ||
| @@ -110,7 +110,7 @@ above, provided that you also meet all of these conditions: | |||
| 110 | License. (Exception: if the Program itself is interactive but | 110 | License. (Exception: if the Program itself is interactive but |
| 111 | does not normally print such an announcement, your work based on | 111 | does not normally print such an announcement, your work based on |
| 112 | the Program is not required to print an announcement.) | 112 | the Program is not required to print an announcement.) |
| 113 | 113 | ||
| 114 | These requirements apply to the modified work as a whole. If | 114 | These requirements apply to the modified work as a whole. If |
| 115 | identifiable sections of that work are not derived from the Program, | 115 | identifiable sections of that work are not derived from the Program, |
| 116 | and can be reasonably considered independent and separate works in | 116 | and can be reasonably considered independent and separate works in |
| @@ -168,7 +168,7 @@ access to copy from a designated place, then offering equivalent | |||
| 168 | access to copy the source code from the same place counts as | 168 | access to copy the source code from the same place counts as |
| 169 | distribution of the source code, even though third parties are not | 169 | distribution of the source code, even though third parties are not |
| 170 | compelled to copy the source along with the object code. | 170 | compelled to copy the source along with the object code. |
| 171 | 171 | ||
| 172 | 4. You may not copy, modify, sublicense, or distribute the Program | 172 | 4. You may not copy, modify, sublicense, or distribute the Program |
| 173 | except as expressly provided under this License. Any attempt | 173 | except as expressly provided under this License. Any attempt |
| 174 | otherwise to copy, modify, sublicense or distribute the Program is | 174 | otherwise to copy, modify, sublicense or distribute the Program is |
| @@ -225,7 +225,7 @@ impose that choice. | |||
| 225 | 225 | ||
| 226 | This section is intended to make thoroughly clear what is believed to | 226 | This section is intended to make thoroughly clear what is believed to |
| 227 | be a consequence of the rest of this License. | 227 | be a consequence of the rest of this License. |
| 228 | 228 | ||
| 229 | 8. If the distribution and/or use of the Program is restricted in | 229 | 8. If the distribution and/or use of the Program is restricted in |
| 230 | certain countries either by patents or by copyrighted interfaces, the | 230 | certain countries either by patents or by copyrighted interfaces, the |
| 231 | original copyright holder who places the Program under this License | 231 | original copyright holder who places the Program under this License |
| @@ -278,7 +278,7 @@ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE | |||
| 278 | POSSIBILITY OF SUCH DAMAGES. | 278 | POSSIBILITY OF SUCH DAMAGES. |
| 279 | 279 | ||
| 280 | END OF TERMS AND CONDITIONS | 280 | END OF TERMS AND CONDITIONS |
| 281 | 281 | ||
| 282 | How to Apply These Terms to Your New Programs | 282 | How to Apply These Terms to Your New Programs |
| 283 | 283 | ||
| 284 | If you develop a new program, and you want it to be of the greatest | 284 | If you develop a new program, and you want it to be of the greatest |
| @@ -303,17 +303,16 @@ the "copyright" line and a pointer to where the full notice is found. | |||
| 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 304 | GNU General Public License for more details. | 304 | GNU General Public License for more details. |
| 305 | 305 | ||
| 306 | You should have received a copy of the GNU General Public License | 306 | You should have received a copy of the GNU General Public License along |
| 307 | along with this program; if not, write to the Free Software | 307 | with this program; if not, write to the Free Software Foundation, Inc., |
| 308 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 309 | |||
| 310 | 309 | ||
| 311 | Also add information on how to contact you by electronic and paper mail. | 310 | Also add information on how to contact you by electronic and paper mail. |
| 312 | 311 | ||
| 313 | If the program is interactive, make it output a short notice like this | 312 | If the program is interactive, make it output a short notice like this |
| 314 | when it starts in an interactive mode: | 313 | when it starts in an interactive mode: |
| 315 | 314 | ||
| 316 | Gnomovision version 69, Copyright (C) year name of author | 315 | Gnomovision version 69, Copyright (C) year name of author |
| 317 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. | 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. |
| 318 | This is free software, and you are welcome to redistribute it | 317 | This is free software, and you are welcome to redistribute it |
| 319 | under certain conditions; type `show c' for details. | 318 | under certain conditions; type `show c' for details. |
| @@ -336,5 +335,5 @@ necessary. Here is a sample; alter the names: | |||
| 336 | This General Public License does not permit incorporating your program into | 335 | This General Public License does not permit incorporating your program into |
| 337 | proprietary programs. If your program is a subroutine library, you may | 336 | proprietary programs. If your program is a subroutine library, you may |
| 338 | consider it more useful to permit linking proprietary applications with the | 337 | consider it more useful to permit linking proprietary applications with the |
| 339 | library. If this is what you want to do, use the GNU Library General | 338 | library. If this is what you want to do, use the GNU Lesser General |
| 340 | Public License instead of this License. | 339 | Public License instead of this License. |
diff --git a/bitbake/doc/bitbake.1 b/bitbake/doc/bitbake.1 new file mode 100644 index 0000000000..e6cbe7df0e --- /dev/null +++ b/bitbake/doc/bitbake.1 | |||
| @@ -0,0 +1,117 @@ | |||
| 1 | .\" Hey, EMACS: -*- nroff -*- | ||
| 2 | .\" First parameter, NAME, should be all caps | ||
| 3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection | ||
| 4 | .\" other parameters are allowed: see man(7), man(1) | ||
| 5 | .TH BITBAKE 1 "November 19, 2006" | ||
| 6 | .\" Please adjust this date whenever revising the manpage. | ||
| 7 | .\" | ||
| 8 | .\" Some roff macros, for reference: | ||
| 9 | .\" .nh disable hyphenation | ||
| 10 | .\" .hy enable hyphenation | ||
| 11 | .\" .ad l left justify | ||
| 12 | .\" .ad b justify to both left and right margins | ||
| 13 | .\" .nf disable filling | ||
| 14 | .\" .fi enable filling | ||
| 15 | .\" .br insert line break | ||
| 16 | .\" .sp <n> insert n+1 empty lines | ||
| 17 | .\" for manpage-specific macros, see man(7) | ||
| 18 | .SH NAME | ||
| 19 | BitBake \- simple tool for the execution of tasks | ||
| 20 | .SH SYNOPSIS | ||
| 21 | .B bitbake | ||
| 22 | .RI [ options ] " packagenames" | ||
| 23 | .br | ||
| 24 | .SH DESCRIPTION | ||
| 25 | This manual page documents briefly the | ||
| 26 | .B bitbake | ||
| 27 | command. | ||
| 28 | .PP | ||
| 29 | .\" TeX users may be more comfortable with the \fB<whatever>\fP and | ||
| 30 | .\" \fI<whatever>\fP escape sequences to invode bold face and italics, | ||
| 31 | .\" respectively. | ||
| 32 | \fBbitbake\fP is a program that executes the specified task (default is 'build') | ||
| 33 | for a given set of BitBake files. | ||
| 34 | .br | ||
| 35 | It expects that BBFILES is defined, which is a space seperated list of files to | ||
| 36 | be executed. BBFILES does support wildcards. | ||
| 37 | .br | ||
| 38 | Default BBFILES are the .bb files in the current directory. | ||
| 39 | .SH OPTIONS | ||
| 40 | This program follow the usual GNU command line syntax, with long | ||
| 41 | options starting with two dashes (`-'). | ||
| 42 | .TP | ||
| 43 | .B \-h, \-\-help | ||
| 44 | Show summary of options. | ||
| 45 | .TP | ||
| 46 | .B \-\-version | ||
| 47 | Show version of program. | ||
| 48 | .TP | ||
| 49 | .B \-bBUILDFILE, \-\-buildfile=BUILDFILE | ||
| 50 | execute the task against this .bb file, rather than a package from BBFILES. | ||
| 51 | .TP | ||
| 52 | .B \-k, \-\-continue | ||
| 53 | continue as much as possible after an error. While the target that failed, and | ||
| 54 | those that depend on it, cannot be remade, the other dependencies of these | ||
| 55 | targets can be processed all the same. | ||
| 56 | .TP | ||
| 57 | .B \-f, \-\-force | ||
| 58 | force run of specified cmd, regardless of stamp status | ||
| 59 | .TP | ||
| 60 | .B \-i, \-\-interactive | ||
| 61 | drop into the interactive mode also called the BitBake shell. | ||
| 62 | .TP | ||
| 63 | .B \-cCMD, \-\-cmd=CMD | ||
| 64 | Specify task to execute. Note that this only executes the specified task for | ||
| 65 | the providee and the packages it depends on, i.e. 'compile' does not implicitly | ||
| 66 | call stage for the dependencies (IOW: use only if you know what you are doing). | ||
| 67 | Depending on the base.bbclass a listtaks tasks is defined and will show | ||
| 68 | available tasks. | ||
| 69 | .TP | ||
| 70 | .B \-rFILE, \-\-read=FILE | ||
| 71 | read the specified file before bitbake.conf | ||
| 72 | .TP | ||
| 73 | .B \-v, \-\-verbose | ||
| 74 | output more chit-chat to the terminal | ||
| 75 | .TP | ||
| 76 | .B \-D, \-\-debug | ||
| 77 | Increase the debug level. You can specify this more than once. | ||
| 78 | .TP | ||
| 79 | .B \-n, \-\-dry-run | ||
| 80 | don't execute, just go through the motions | ||
| 81 | .TP | ||
| 82 | .B \-p, \-\-parse-only | ||
| 83 | quit after parsing the BB files (developers only) | ||
| 84 | .TP | ||
| 85 | .B \-d, \-\-disable-psyco | ||
| 86 | disable using the psyco just-in-time compiler (not recommended) | ||
| 87 | .TP | ||
| 88 | .B \-s, \-\-show-versions | ||
| 89 | show current and preferred versions of all packages | ||
| 90 | .TP | ||
| 91 | .B \-e, \-\-environment | ||
| 92 | show the global or per-package environment (this is what used to be bbread) | ||
| 93 | .TP | ||
| 94 | .B \-g, \-\-graphviz | ||
| 95 | emit the dependency trees of the specified packages in the dot syntax | ||
| 96 | .TP | ||
| 97 | .B \-IIGNORED\_DOT\_DEPS, \-\-ignore-deps=IGNORED_DOT_DEPS | ||
| 98 | Stop processing at the given list of dependencies when generating dependency | ||
| 99 | graphs. This can help to make the graph more appealing | ||
| 100 | .\" | ||
| 101 | .\" Next option is only in BitBake 1.7.x (trunk) | ||
| 102 | .\" | ||
| 103 | .\".TP | ||
| 104 | .\".B \-lDEBUG_DOMAINS, \-\-log-domains=DEBUG_DOMAINS | ||
| 105 | .\"Show debug logging for the specified logging domains | ||
| 106 | |||
| 107 | .SH AUTHORS | ||
| 108 | BitBake was written by | ||
| 109 | Phil Blundell, | ||
| 110 | Holger Freyther, | ||
| 111 | Chris Larson, | ||
| 112 | Mickey Lauer, | ||
| 113 | Richard Purdie, | ||
| 114 | Holger Schurig | ||
| 115 | .PP | ||
| 116 | This manual page was written by Marcin Juszkiewicz <marcin@hrw.one.pl> | ||
| 117 | for the Debian project (but may be used by others). | ||
