From e2e6f6fe07049f33cb6348780fa975162752e421 Mon Sep 17 00:00:00 2001 From: Adrian Dudau Date: Thu, 12 Dec 2013 13:38:32 +0100 Subject: initial commit of Enea Linux 3.1 Migrated from the internal git server on the dora-enea branch Signed-off-by: Adrian Dudau --- bitbake/doc/COPYING.GPL | 339 +++++++++++++++++++++ bitbake/doc/COPYING.MIT | 17 ++ bitbake/doc/bitbake.1 | 142 +++++++++ bitbake/doc/manual/Makefile | 56 ++++ bitbake/doc/manual/html.css | 281 +++++++++++++++++ bitbake/doc/manual/usermanual.xml | 627 ++++++++++++++++++++++++++++++++++++++ 6 files changed, 1462 insertions(+) create mode 100644 bitbake/doc/COPYING.GPL create mode 100644 bitbake/doc/COPYING.MIT create mode 100644 bitbake/doc/bitbake.1 create mode 100644 bitbake/doc/manual/Makefile create mode 100644 bitbake/doc/manual/html.css create mode 100644 bitbake/doc/manual/usermanual.xml (limited to 'bitbake/doc') diff --git a/bitbake/doc/COPYING.GPL b/bitbake/doc/COPYING.GPL new file mode 100644 index 0000000000..d511905c16 --- /dev/null +++ b/bitbake/doc/COPYING.GPL @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/bitbake/doc/COPYING.MIT b/bitbake/doc/COPYING.MIT new file mode 100644 index 0000000000..7e7d57413d --- /dev/null +++ b/bitbake/doc/COPYING.MIT @@ -0,0 +1,17 @@ +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/bitbake/doc/bitbake.1 b/bitbake/doc/bitbake.1 new file mode 100644 index 0000000000..15a7f205aa --- /dev/null +++ b/bitbake/doc/bitbake.1 @@ -0,0 +1,142 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH BITBAKE 1 "November 19, 2006" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +BitBake \- simple tool for the execution of tasks +.SH SYNOPSIS +.B bitbake +.RI [ options ] " packagenames" +.br +.SH DESCRIPTION +This manual page documents briefly the +.B bitbake +command. +.PP +.\" TeX users may be more comfortable with the \fB\fP and +.\" \fI\fP escape sequences to invode bold face and italics, +.\" respectively. +\fBbitbake\fP is a program that executes the specified task (default is 'build') +for a given set of BitBake files. +.br +It expects that BBFILES is defined, which is a space separated list of files to +be executed. BBFILES does support wildcards. +.br +Default BBFILES are the .bb files in the current directory. +.SH OPTIONS +This program follow the usual GNU command line syntax, with long +options starting with two dashes (`-'). +.TP +.B \-h, \-\-help +Show summary of options. +.TP +.B \-\-version +Show version of program. +.TP +.B \-bBUILDFILE, \-\-buildfile=BUILDFILE +execute the task against this .bb file, rather than a package from BBFILES. +.TP +.B \-k, \-\-continue +continue as much as possible after an error. While the target that failed, and +those that depend on it, cannot be remade, the other dependencies of these +targets can be processed all the same. +.TP +.B \-a, \-\-tryaltconfigs +continue with builds by trying to use alternative providers where possible. +.TP +.B \-f, \-\-force +force run of specified cmd, regardless of stamp status +.TP +.B \-i, \-\-interactive +drop into the interactive mode also called the BitBake shell. +.TP +.B \-cCMD, \-\-cmd=CMD +Specify task to execute. Note that this only executes the specified task for +the providee and the packages it depends on, i.e. 'compile' does not implicitly +call stage for the dependencies (IOW: use only if you know what you are doing). +Depending on the base.bbclass a listtasks task is defined and will show +available tasks. +.TP +.B \-rFILE, \-\-read=FILE +read the specified file before bitbake.conf +.TP +.B \-v, \-\-verbose +output more chit-chat to the terminal +.TP +.B \-D, \-\-debug +Increase the debug level. You can specify this more than once. +.TP +.B \-n, \-\-dry-run +don't execute, just go through the motions +.TP +.B \-p, \-\-parse-only +quit after parsing the BB files (developers only) +.TP +.B \-s, \-\-show-versions +show current and preferred versions of all packages +.TP +.B \-e, \-\-environment +show the global or per-package environment (this is what used to be bbread) +.TP +.B \-g, \-\-graphviz +emit the dependency trees of the specified packages in the dot syntax +.TP +.B \-IIGNORED\_DOT\_DEPS, \-\-ignore-deps=IGNORED_DOT_DEPS +Stop processing at the given list of dependencies when generating dependency +graphs. This can help to make the graph more appealing +.TP +.B \-lDEBUG_DOMAINS, \-\-log-domains=DEBUG_DOMAINS +Show debug logging for the specified logging domains +.TP +.B \-P, \-\-profile +profile the command and print a report +.TP +.B \-uUI, \-\-ui=UI +User interface to use. Currently, hob, depexp, goggle or ncurses can be specified as UI. +.TP +.B \-tSERVERTYPE, \-\-servertype=SERVERTYPE +Choose which server to use, none, process or xmlrpc. +.TP +.B \-\-revisions-changed +Set the exit code depending on whether upstream floating revisions have changed or not. +.TP +.B \-\-server-only +Run bitbake without UI, the frontend can connect with bitbake server itself. +.TP +.B \-BBIND, \-\-bind=BIND +The name/address for the bitbake server to bind to. +.TP +.B \-\-no\-setscene +Do not run any setscene tasks, forces builds. + +.SH ENVIRONMENT VARIABLES +bitbake uses the following environment variables to control its +operation: +.TP +.B BITBAKE_UI +The bitbake user interface; overridden by the \fB-u\fP commandline option. + +.SH AUTHORS +BitBake was written by +Phil Blundell, +Holger Freyther, +Chris Larson, +Mickey Lauer, +Richard Purdie, +Holger Schurig +.PP +This manual page was written by Marcin Juszkiewicz +for the Debian project (but may be used by others). diff --git a/bitbake/doc/manual/Makefile b/bitbake/doc/manual/Makefile new file mode 100644 index 0000000000..341ab55e2c --- /dev/null +++ b/bitbake/doc/manual/Makefile @@ -0,0 +1,56 @@ +topdir = . +manual = $(topdir)/usermanual.xml +# types = pdf txt rtf ps xhtml html man tex texi dvi +# types = pdf txt +types = $(xmltotypes) $(htmltypes) +xmltotypes = pdf txt +htmltypes = html xhtml +htmlxsl = $(if $(filter $@,$(foreach type,$(htmltypes),$(type)-nochunks)),http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl,http://docbook.sourceforge.net/release/xsl/current/$@/chunk.xsl) +htmlcssfile = docbook.css +htmlcss = $(topdir)/html.css +# htmlcssfile = +# htmlcss = +cleanfiles = $(foreach i,$(types),$(topdir)/$(i)) + +ifdef DEBUG +define command + $(1) +endef +else +define command + @echo $(2) $(3) $(4) + @$(1) >/dev/null +endef +endif + +all: $(types) + +lint: $(manual) FORCE + $(call command,xmllint --xinclude --postvalid --noout $(manual),XMLLINT $(manual)) + +$(types) $(foreach type,$(htmltypes),$(type)-nochunks): lint FORCE + +$(foreach type,$(htmltypes),$(type)-nochunks): $(if $(htmlcss),$(htmlcss)) $(manual) + @mkdir -p $@ +ifdef htmlcss + $(call command,install -m 0644 $(htmlcss) $@/$(htmlcssfile),CP $(htmlcss) $@/$(htmlcssfile)) +endif + $(call command,xsltproc --stringparam base.dir $@/ $(if $(htmlcssfile),--stringparam html.stylesheet $(htmlcssfile)) $(htmlxsl) $(manual) > $@/index.$(patsubst %-nochunks,%,$@),XSLTPROC $@ $(manual)) + +$(htmltypes): $(if $(htmlcss),$(htmlcss)) $(manual) + @mkdir -p $@ +ifdef htmlcss + $(call command,install -m 0644 $(htmlcss) $@/$(htmlcssfile),CP $(htmlcss) $@/$(htmlcssfile)) +endif + $(call command,xsltproc --stringparam base.dir $@/ $(if $(htmlcssfile),--stringparam html.stylesheet $(htmlcssfile)) $(htmlxsl) $(manual),XSLTPROC $@ $(manual)) + +$(xmltotypes): $(manual) + $(call command,xmlto --with-dblatex --extensions -o $(topdir)/$@ $@ $(manual),XMLTO $@ $(manual)) + +clean: + rm -rf $(cleanfiles) + +$(foreach i,$(types) $(foreach type,$(htmltypes),$(type)-nochunks),clean-$(i)): + rm -rf $(patsubst clean-%,%,$@) + +FORCE: diff --git a/bitbake/doc/manual/html.css b/bitbake/doc/manual/html.css new file mode 100644 index 0000000000..6eedfd3189 --- /dev/null +++ b/bitbake/doc/manual/html.css @@ -0,0 +1,281 @@ +/* Feuille de style DocBook du projet Traduc.org */ +/* DocBook CSS stylesheet of the Traduc.org project */ + +/* (c) Jean-Philippe Guérard - 14 août 2004 */ +/* (c) Jean-Philippe Guérard - 14 August 2004 */ + +/* Cette feuille de style est libre, vous pouvez la */ +/* redistribuer et la modifier selon les termes de la Licence */ +/* Art Libre. Vous trouverez un exemplaire de cette Licence sur */ +/* http://tigreraye.org/Petit-guide-du-traducteur.html#licence-art-libre */ + +/* This work of art is free, you can redistribute it and/or */ +/* modify it according to terms of the Free Art license. You */ +/* will find a specimen of this license on the Copyleft */ +/* Attitude web site: http://artlibre.org as well as on other */ +/* sites. */ +/* Please note that the French version of this licence as shown */ +/* on http://tigreraye.org/Petit-guide-du-traducteur.html#licence-art-libre */ +/* is only official licence of this document. The English */ +/* is only provided to help you understand this licence. */ + +/* La dernière version de cette feuille de style est toujours */ +/* disponible sur : http://tigreraye.org/style.css */ +/* Elle est également disponible sur : */ +/* http://www.traduc.org/docs/HOWTO/lecture/style.css */ + +/* The latest version of this stylesheet is available from: */ +/* http://tigreraye.org/style.css */ +/* It is also available on: */ +/* http://www.traduc.org/docs/HOWTO/lecture/style.css */ + +/* N'hésitez pas à envoyer vos commentaires et corrections à */ +/* Jean-Philippe Guérard */ + +/* Please send feedback and bug reports to */ +/* Jean-Philippe Guérard */ + +/* $Id: style.css,v 1.14 2004/09/10 20:12:09 fevrier Exp fevrier $ */ + +/* Présentation générale du document */ +/* Overall document presentation */ + +body { + /* + font-family: Apolline, "URW Palladio L", Garamond, jGaramond, + "Bitstream Cyberbit", "Palatino Linotype", serif; + */ + margin: 7%; + background-color: white; +} + +/* Taille du texte */ +/* Text size */ + +* { font-size: 100%; } + +/* Gestion des textes mis en relief imbriqués */ +/* Embedded emphasis */ + +em { font-style: italic; } +em em { font-style: normal; } +em em em { font-style: italic; } + +/* Titres */ +/* Titles */ + +h1 { font-size: 200%; font-weight: 900; } +h2 { font-size: 160%; font-weight: 900; } +h3 { font-size: 130%; font-weight: bold; } +h4 { font-size: 115%; font-weight: bold; } +h5 { font-size: 108%; font-weight: bold; } +h6 { font-weight: bold; } + +/* Nom de famille en petites majuscules (uniquement en français) */ +/* Last names in small caps (for French only) */ + +*[class~="surname"]:lang(fr) { font-variant: small-caps; } + +/* Blocs de citation */ +/* Quotation blocs */ + +div[class~="blockquote"] { + border: solid 2px #AAA; + padding: 5px; + margin: 5px; +} + +div[class~="blockquote"] > table { + border: none; +} + +/* Blocs litéraux : fond gris clair */ +/* Literal blocs: light gray background */ + +*[class~="literallayout"] { + background: #f0f0f0; + padding: 5px; + margin: 5px; +} + +/* Programmes et captures texte : fond bleu clair */ +/* Listing and text screen snapshots: light blue background */ + +*[class~="programlisting"], *[class~="screen"] { + background: #f0f0ff; + padding: 5px; + margin: 5px; +} + +/* Les textes à remplacer sont surlignés en vert pâle */ +/* Replaceable text in highlighted in pale green */ + +*[class~="replaceable"] { + background-color: #98fb98; + font-style: normal; } + +/* Tables : fonds gris clair & bords simples */ +/* Tables: light gray background and solid borders */ + +*[class~="table"] *[class~="title"] { width:100%; border: 0px; } + +table { + border: 1px solid #aaa; + border-collapse: collapse; + padding: 2px; + margin: 5px; +} + +/* Listes simples en style table */ +/* Simples lists in table presentation */ + +table[class~="simplelist"] { + background-color: #F0F0F0; + margin: 5px; + border: solid 1px #AAA; +} + +table[class~="simplelist"] td { + border: solid 1px #AAA; +} + +/* Les tables */ +/* Tables */ + +*[class~="table"] table { + background-color: #F0F0F0; + border: solid 1px #AAA; +} +*[class~="informaltable"] table { background-color: #F0F0F0; } + +th,td { + vertical-align: baseline; + text-align: left; + padding: 0.1em 0.3em; + empty-cells: show; +} + +/* Alignement des colonnes */ +/* Colunms alignment */ + +td[align=center] , th[align=center] { text-align: center; } +td[align=right] , th[align=right] { text-align: right; } +td[align=left] , th[align=left] { text-align: left; } +td[align=justify] , th[align=justify] { text-align: justify; } + +/* Pas de marge autour des images */ +/* No inside margins for images */ + +img { border: 0; } + +/* Les liens ne sont pas soulignés */ +/* No underlines for links */ + +:link , :visited , :active { text-decoration: none; } + +/* Prudence : cadre jaune et fond jaune clair */ +/* Caution: yellow border and light yellow background */ + +*[class~="caution"] { + border: solid 2px yellow; + background-color: #ffffe0; + padding: 1em 6px 1em ; + margin: 5px; +} + +*[class~="caution"] th { + vertical-align: middle +} + +*[class~="caution"] table { + background-color: #ffffe0; + border: none; +} + +/* Note importante : cadre jaune et fond jaune clair */ +/* Important: yellow border and light yellow background */ + +*[class~="important"] { + border: solid 2px yellow; + background-color: #ffffe0; + padding: 1em 6px 1em; + margin: 5px; +} + +*[class~="important"] th { + vertical-align: middle +} + +*[class~="important"] table { + background-color: #ffffe0; + border: none; +} + +/* Mise en évidence : texte légèrement plus grand */ +/* Highlights: slightly larger texts */ + +*[class~="highlights"] { + font-size: 110%; +} + +/* Note : cadre bleu et fond bleu clair */ +/* Notes: blue border and light blue background */ + +*[class~="note"] { + border: solid 2px #7099C5; + background-color: #f0f0ff; + padding: 1em 6px 1em ; + margin: 5px; +} + +*[class~="note"] th { + vertical-align: middle +} + +*[class~="note"] table { + background-color: #f0f0ff; + border: none; +} + +/* Astuce : cadre vert et fond vert clair */ +/* Tip: green border and light green background */ + +*[class~="tip"] { + border: solid 2px #00ff00; + background-color: #f0ffff; + padding: 1em 6px 1em ; + margin: 5px; +} + +*[class~="tip"] th { + vertical-align: middle; +} + +*[class~="tip"] table { + background-color: #f0ffff; + border: none; +} + +/* Avertissement : cadre rouge et fond rouge clair */ +/* Warning: red border and light red background */ + +*[class~="warning"] { + border: solid 2px #ff0000; + background-color: #fff0f0; + padding: 1em 6px 1em ; + margin: 5px; +} + +*[class~="warning"] th { + vertical-align: middle; +} + + +*[class~="warning"] table { + background-color: #fff0f0; + border: none; +} + +/* Fin */ +/* The End */ + diff --git a/bitbake/doc/manual/usermanual.xml b/bitbake/doc/manual/usermanual.xml new file mode 100644 index 0000000000..6781a71a62 --- /dev/null +++ b/bitbake/doc/manual/usermanual.xml @@ -0,0 +1,627 @@ + + + + + + BitBake User Manual + + BitBake Team + + + 2004, 2005, 2006, 2011 + Chris Larson + Phil Blundell + Richard Purdie + + + This work is licensed under the Creative Commons Attribution License. To view a copy of this license, visit http://creativecommons.org/licenses/by/2.5/ or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA. + + + + Introduction +
+ Overview + BitBake is, at its simplest, a tool for executing +tasks and managing metadata. As such, its similarities to GNU make and other +build tools are readily apparent. It was inspired by Portage, the package management system used by the Gentoo Linux distribution. BitBake is the basis of the OpenEmbedded project, which is being used to build and maintain a number of embedded Linux distributions/projects such as Angstrom and the Yocto project. +
+
+ Background and goals + Prior to BitBake, no other build tool adequately met +the needs of an aspiring embedded Linux distribution. All of the +buildsystems used by traditional desktop Linux distributions lacked +important functionality, and none of the ad-hoc +buildroot systems, prevalent in the +embedded space, were scalable or maintainable. + + Some important original goals for BitBake were: + + Handle crosscompilation. + Handle interpackage dependencies (build time on target architecture, build time on native architecture, and runtime). + Support running any number of tasks within a given package, including, but not limited to, fetching upstream sources, unpacking them, patching them, configuring them, et cetera. + Must be Linux distribution agnostic (both build and target). + Must be architecture agnostic + Must support multiple build and target operating systems (including Cygwin, the BSDs, etc). + Must be able to be self contained, rather than tightly integrated into the build machine's root filesystem. + There must be a way to handle conditional metadata (on target architecture, operating system, distribution, machine). + It must be easy for the person using the tools to supply their own local metadata and packages to operate against. + Must make it easy to collaborate +between multiple projects using BitBake for their +builds. + Should provide an inheritance mechanism to +share common metadata between many packages. + + + Over time it has become apparent that some further requirements were necessary: + + Handle variants of a base recipe (native, sdk, multilib). + Able to split metadata into layers and allow layers to override each other. + Allow representation of a given set of input variables to a task as a checksum. + based on that checksum, allow acceleration of builds with prebuilt components. + + + + BitBake satisfies all the original requirements and many more with extensions being made to the basic functionality to reflect the additionl requirements. Flexibility and power have always been the priorities. It is highly extensible, supporting embedded Python code and execution of any arbitrary tasks. +
+ + + Metadata +
+ Description + + BitBake metadata can be classified into 3 major areas: + + Configuration Files + + + .bb Files + + + Classes + + + What follows are a large number of examples of BitBake metadata. Any syntax which isn't supported in any of the aforementioned areas will be documented as such. +
+ Basic variable setting + VARIABLE = "value" + In this example, VARIABLE is value. +
+
+ Variable expansion + BitBake supports variables referencing one another's contents using a syntax which is similar to shell scripting + A = "aval" +B = "pre${A}post" + This results in A containing aval and B containing preavalpost. +
+
+ Setting a default value (?=) + A ?= "aval" + If A is set before the above is called, it will retain its previous value. If A is unset prior to the above call, A will be set to aval. Note that this assignment is immediate, so if there are multiple ?= assignments to a single variable, the first of those will be used. +
+
+ Setting a weak default value (??=) + A ??= "somevalue" +A ??= "someothervalue" + If A is set before the above, it will retain that value. If A is unset prior to the above, A will be set to someothervalue. This is a lazy/weak assignment in that the assignment does not occur until the end of the parsing process, so that the last, rather than the first, ??= assignment to a given variable will be used. Any other setting of A using = or ?= will however override the value set with ??= +
+
+ Immediate variable expansion (:=) + := results in a variable's contents being expanded immediately, rather than when the variable is actually used. + T = "123" +A := "${B} ${A} test ${T}" +T = "456" +B = "${T} bval" + +C = "cval" +C := "${C}append" + In that example, A would contain test 123, B would contain 456 bval, and C would be cvalappend. +
+
+ Appending (+=) and prepending (=+) + B = "bval" +B += "additionaldata" +C = "cval" +C =+ "test" + In this example, B is now bval additionaldata and C is test cval. +
+
+ Appending (.=) and prepending (=.) without spaces + B = "bval" +B .= "additionaldata" +C = "cval" +C =. "test" + In this example, B is now bvaladditionaldata and C is testcval. In contrast to the above appending and prepending operators, no additional space +will be introduced. +
+
+ Appending and Prepending (override style syntax) + B = "bval" +B_append = " additional data" +C = "cval" +C_prepend = "additional data " + This example results in B becoming bval additional data +and C becoming additional data cval. Note the spaces in the append. +Unlike the += operator, additional space is not automatically added. You must take steps to add space +yourself. +
+
+ Removing (override style syntax) + FOO = "123 456 789 123456 123 456 123 456" +FOO_remove = "123" +FOO_remove = "456" + In this example, FOO is now 789 123456. +
+
+ Conditional metadata set + OVERRIDES is a : separated variable containing each item you want to satisfy conditions. So, if you have a variable which is conditional on arm, and arm is in OVERRIDES, then the arm specific version of the variable is used rather than the non-conditional version. Example: + OVERRIDES = "architecture:os:machine" +TEST = "defaultvalue" +TEST_os = "osspecificvalue" +TEST_condnotinoverrides = "othercondvalue" + In this example, TEST would be osspecificvalue, due to the condition os being in OVERRIDES. +
+
+ Conditional appending + BitBake also supports appending and prepending to variables based on whether something is in OVERRIDES. Example: + DEPENDS = "glibc ncurses" +OVERRIDES = "machine:local" +DEPENDS_append_machine = " libmad" + In this example, DEPENDS is set to glibc ncurses libmad. +
+
+ Inclusion + Next, there is the include directive, which causes BitBake to parse whatever file you specify, and insert it at that location, which is not unlike make. However, if the path specified on the include line is a relative path, BitBake will locate the first one it can find within BBPATH. +
+
+ Requiring inclusion + In contrast to the include directive, require will +raise an ParseError if the file to be included cannot be found. Otherwise it will behave just like the +include directive. +
+
+ Python variable expansion + DATE = "${@time.strftime('%Y%m%d',time.gmtime())}" + This would result in the DATE variable containing today's date. +
+
+ Defining executable metadata + NOTE: This is only supported in .bb and .bbclass files. + do_mytask () { + echo "Hello, world!" +} + This is essentially identical to setting a variable, except that this variable happens to be executable shell code. + python do_printdate () { + import time + print time.strftime('%Y%m%d', time.gmtime()) +} + This is the similar to the previous, but flags it as Python so that BitBake knows it is Python code. +
+
+ Defining Python functions into the global Python namespace + NOTE: This is only supported in .bb and .bbclass files. + def get_depends(bb, d): + if d.getVar('SOMECONDITION', True): + return "dependencywithcond" + else: + return "dependency" + +SOMECONDITION = "1" +DEPENDS = "${@get_depends(bb, d)}" + This would result in DEPENDS containing dependencywithcond. +
+
+ Variable flags + Variables can have associated flags which provide a way of tagging extra information onto a variable. Several flags are used internally by BitBake but they can be used externally too if needed. The standard operations mentioned above also work on flags. + VARIABLE[SOMEFLAG] = "value" + In this example, VARIABLE has a flag, SOMEFLAG which is set to value. +
+
+ Inheritance + NOTE: This is only supported in .bb and .bbclass files. + The inherit directive is a means of specifying what classes of functionality your .bb requires. It is a rudimentary form of inheritance. For example, you can easily abstract out the tasks involved in building a package that uses autoconf and automake, and put that into a bbclass for your packages to make use of. A given bbclass is located by searching for classes/filename.bbclass in BBPATH, where filename is what you inherited. +
+
+ Tasks + NOTE: This is only supported in .bb and .bbclass files. + In BitBake, each step that needs to be run for a given .bb is known as a task. There is a command addtask to add new tasks (must be a defined Python executable metadata and must start with do_) and describe intertask dependencies. + python do_printdate () { + import time + print time.strftime('%Y%m%d', time.gmtime()) +} + +addtask printdate before do_build + This defines the necessary Python function and adds it as a task which is now a dependency of do_build, the default task. If anyone executes the do_build task, that will result in do_printdate being run first. +
+ +
+ Task Flags + Tasks support a number of flags which control various functionality of the task. These are as follows: + 'dirs' - directories which should be created before the task runs + 'cleandirs' - directories which should created before the task runs but should be empty + 'noexec' - marks the tasks as being empty and no execution required. These are used as dependency placeholders or used when added tasks need to be subsequently disabled. + 'nostamp' - don't generate a stamp file for a task. This means the task is always rexecuted. + 'fakeroot' - this task needs to be run in a fakeroot environment, obtained by adding the variables in FAKEROOTENV to the environment. + 'umask' - the umask to run the task under. + For the 'deptask', 'rdeptask', 'depends', 'rdepends' and 'recrdeptask' flags please see the dependencies section. +
+ +
+ Events + NOTE: This is only supported in .bb and .bbclass files. + BitBake allows installation of event handlers. Events are triggered at certain points during operation, such as the beginning of operation against a given .bb, the start of a given task, task failure, task success, et cetera. The intent is to make it easy to do things like email notification on build failure. + addhandler myclass_eventhandler +python myclass_eventhandler() { + from bb.event import getName + from bb import data + + print("The name of the Event is %s" % getName(e)) + print("The file we run for is %s" % data.getVar('FILE', e.data, True)) +} + +This event handler gets called every time an event is triggered. A global variable e is defined. e.data contains an instance of bb.data. With the getName(e) +method one can get the name of the triggered event.The above event handler prints the name +of the event and the content of the FILE variable. +
+
+ Variants + Two BitBake features exist to facilitate the creation of multiple buildable incarnations from a single recipe file. + The first is BBCLASSEXTEND. This variable is a space separated list of classes used to "extend" the recipe for each variant. As an example, setting BBCLASSEXTEND = "native" results in a second incarnation of the current recipe being available. This second incarnation will have the "native" class inherited. + The second feature is BBVERSIONS. This variable allows a single recipe to build multiple versions of a project from a single recipe file, and allows you to specify conditional metadata (using the OVERRIDES mechanism) for a single version, or an optionally named range of versions: + BBVERSIONS = "1.0 2.0 git" +SRC_URI_git = "git://someurl/somepath.git" + BBVERSIONS = "1.0.[0-6]:1.0.0+ \ + 1.0.[7-9]:1.0.7+" +SRC_URI_append_1.0.7+ = "file://some_patch_which_the_new_versions_need.patch;patch=1" + Note that the name of the range will default to the original version of the recipe, so given OE, a recipe file of foo_1.0.0+.bb will default the name of its versions to 1.0.0+. This is useful, as the range name is not only placed into overrides; it's also made available for the metadata to use in the form of the BPV variable, for use in file:// search paths (FILESPATH). +
+
+ +
+ Variable interaction: Worked Examples + Despite the documentation of the different forms of variable definition above, it can be hard to work out what happens when variable operators are combined. This section documents some common questions people have regarding the way variables interact. + +
+ Override and append ordering + + There is often confusion about which order overrides and the various append operators take effect. + + OVERRIDES = "foo" +A_foo_append = "X" + In this case, X is unconditionally appended to the variable A_foo. Since foo is an override, A_foo would then replace A. + + OVERRIDES = "foo" +A = "X" +A_append_foo = "Y" + In this case, only when foo is in OVERRIDES, Y is appended to the variable A so the value of A would become XY (NB: no spaces are appended). + + OVERRIDES = "foo" +A_foo_append = "X" +A_foo_append += "Y" + This behaves as per the first case above, but the value of A would be "X Y" instead of just "X". + + A = "1" +A_append = "2" +A_append = "3" +A += "4" +A .= "5" + + Would ultimately result in A taking the value "1 4523" since the _append operator executes at the same time as the expansion of other overrides. + +
+
+ Key Expansion + + Key expansion happens at the data store finalisation time just before overrides are expanded. + + A${B} = "X" +B = "2" +A2 = "Y" + So in this case A2 would take the value of "X". +
+ +
+
+ Dependency handling + BitBake handles dependencies at the task level since to allow for efficient operation with multiple processed executing in parallel. A robust method of specifying task dependencies is therefore needed. +
+ Dependencies internal to the .bb file + Where the dependencies are internal to a given .bb file, the dependencies are handled by the previously detailed addtask directive. +
+ +
+ Build Dependencies + DEPENDS lists build time dependencies. The 'deptask' flag for tasks is used to signify the task of each item listed in DEPENDS which must have completed before that task can be executed. + do_configure[deptask] = "do_populate_staging" + means the do_populate_staging task of each item in DEPENDS must have completed before do_configure can execute. +
+
+ Runtime Dependencies + The PACKAGES variable lists runtime packages and each of these can have RDEPENDS and RRECOMMENDS runtime dependencies. The 'rdeptask' flag for tasks is used to signify the task of each item runtime dependency which must have completed before that task can be executed. + do_package_write[rdeptask] = "do_package" + means the do_package task of each item in RDEPENDS must have completed before do_package_write can execute. +
+
+ Recursive Dependencies + These are specified with the 'recrdeptask' flag which is used signify the task(s) of dependencies which must have completed before that task can be executed. It works by looking though the build and runtime dependencies of the current recipe as well as any inter-task dependencies the task has, then adding a dependency on the listed task. It will then recurse through the dependencies of those tasks and so on. + It may be desireable to recurse not just through the dependencies of those tasks but through the build and runtime dependencies of dependent tasks too. If that is the case, the taskname itself should be referenced in the task list, e.g. do_a[recrdeptask] = "do_a do_b". +
+
+ Inter task + The 'depends' flag for tasks is a more generic form of which allows an interdependency on specific tasks rather than specifying the data in DEPENDS. + do_patch[depends] = "quilt-native:do_populate_staging" + means the do_populate_staging task of the target quilt-native must have completed before the do_patch can execute. + The 'rdepends' flag works in a similar way but takes targets in the runtime namespace instead of the build time dependency namespace. +
+
+ +
+ Parsing +
+ Configuration files + The first kind of metadata in BitBake is configuration metadata. This metadata is global, and therefore affects all packages and tasks which are executed. + BitBake will first search the current working directory for an optional "conf/bblayers.conf" configuration file. This file is expected to contain a BBLAYERS variable which is a space delimited list of 'layer' directories. For each directory in this list, a "conf/layer.conf" file will be searched for and parsed with the LAYERDIR variable being set to the directory where the layer was found. The idea is these files will setup BBPATH and other variables correctly for a given build directory automatically for the user. + BitBake will then expect to find 'conf/bitbake.conf' somewhere in the user specified BBPATH. That configuration file generally has include directives to pull in any other metadata (generally files specific to architecture, machine, local and so on). + Only variable definitions and include directives are allowed in .conf files. +
+
+ Classes + BitBake classes are our rudimentary inheritance mechanism. As briefly mentioned in the metadata introduction, they're parsed when an inherit directive is encountered, and they are located in classes/ relative to the directories in BBPATH. +
+
+ .bb files + A BitBake (.bb) file is a logical unit of tasks to be executed. Normally this is a package to be built. Inter-.bb dependencies are obeyed. The files themselves are located via the BBFILES variable, which is set to a space separated list of .bb files, and does handle wildcards. +
+
+ + + + File download support +
+ Overview + BitBake provides support to download files this procedure is called fetching and it handled by the fetch and fetch2 modules. At this point the original fetch code is considered to be replaced by fetch2 and this manual only related to the fetch2 codebase. + + The SRC_URI is normally used to tell BitBake which files to fetch. The next sections will describe the available fetchers and their options. Each fetcher honors a set of variables and per URI parameters separated by a ; consisting of a key and a value. The semantics of the variables and parameters are defined by the fetcher. BitBake tries to have consistent semantics between the different fetchers. + + + The overall fetch process is that first, fetches are attempted from PREMIRRORS. If those don't work, the original SRC_URI is attempted and if that fails, BitBake will fall back to MIRRORS. Cross urls are supported, so its possible to mirror a git repository on an http server as a tarball for example. Some example commonly used mirror definitions are: + + PREMIRRORS ?= "\ +bzr://.*/.* http://somemirror.org/sources/ \n \ +cvs://.*/.* http://somemirror.org/sources/ \n \ +git://.*/.* http://somemirror.org/sources/ \n \ +hg://.*/.* http://somemirror.org/sources/ \n \ +osc://.*/.* http://somemirror.org/sources/ \n \ +p4://.*/.* http://somemirror.org/sources/ \n \ +svk://.*/.* http://somemirror.org/sources/ \n \ +svn://.*/.* http://somemirror.org/sources/ \n" + +MIRRORS =+ "\ +ftp://.*/.* http://somemirror.org/sources/ \n \ +http://.*/.* http://somemirror.org/sources/ \n \ +https://.*/.* http://somemirror.org/sources/ \n" + + Non-local downloaded output is placed into the directory specified by the DL_DIR. For non local archive downloads the code can verify sha256 and md5 checksums for the download to ensure the file has been downloaded correctly. These may be specified either in the form SRC_URI[md5sum] for the md5 checksum and SRC_URI[sha256sum] for the sha256 checksum or as parameters on the SRC_URI such as SRC_URI="http://example.com/foobar.tar.bz2;md5sum=4a8e0f237e961fd7785d19d07fdb994d". If BB_STRICT_CHECKSUM is set, any download without a checksum will trigger an error message. In cases where multiple files are listed in SRC_URI, the name parameter is used assign names to the urls and these are then specified in the checksums in the form SRC_URI[name.sha256sum]. + +
+ +
+ Local file fetcher + The URN for the local file fetcher is file. The filename can be either absolute or relative. If the filename is relative, FILESPATH and failing that FILESDIR will be used to find the appropriate relative file. The metadata usually extend these variables to include variations of the values in OVERRIDES. Single files and complete directories can be specified. +SRC_URI= "file://relativefile.patch" +SRC_URI= "file://relativefile.patch;this=ignored" +SRC_URI= "file:///Users/ich/very_important_software" + + +
+ +
+ CVS fetcher + The URN for the CVS fetcher is cvs. This fetcher honors the variables CVSDIR, SRCDATE, FETCHCOMMAND_cvs, UPDATECOMMAND_cvs. DL_DIR specifies where a temporary checkout is saved. SRCDATE specifies which date to use when doing the fetching (the special value of "now" will cause the checkout to be updated on every build). FETCHCOMMAND and UPDATECOMMAND specify which executables to use for the CVS checkout or update. + + The supported parameters are module, tag, date, method, localdir, rsh and scmdata. The module specifies which module to check out, the tag describes which CVS TAG should be used for the checkout. By default the TAG is empty. A date can be specified to override the SRCDATE of the configuration to checkout a specific date. The special value of "now" will cause the checkout to be updated on every build.method is by default pserver. If ext is used the rsh parameter will be evaluated and CVS_RSH will be set. Finally, localdir is used to checkout into a special directory relative to CVSDIR. + +SRC_URI = "cvs://CVSROOT;module=mymodule;tag=some-version;method=ext" +SRC_URI = "cvs://CVSROOT;module=mymodule;date=20060126;localdir=usethat" + + +
+ +
+ HTTP/FTP fetcher + The URNs for the HTTP/FTP fetcher are http, https and ftp. This fetcher honors the variables FETCHCOMMAND_wget. FETCHCOMMAND contains the command used for fetching. ${URI} and ${FILES} will be replaced by the URI and basename of the file to be fetched. + + SRC_URI = "http://oe.handhelds.org/not_there.aac" +SRC_URI = "ftp://oe.handhelds.org/not_there_as_well.aac" +SRC_URI = "ftp://you@oe.handheld.sorg/home/you/secret.plan" + +
+ +
+ SVN fetcher + The URN for the SVN fetcher is svn. + + This fetcher honors the variables FETCHCOMMAND_svn, SVNDIR, SRCREV. FETCHCOMMAND contains the subversion command. SRCREV specifies which revision to use when doing the fetching. + + The supported parameters are proto, rev and scmdata. proto is the Subversion protocol, rev is the Subversion revision. If scmdata is set to keep, the .svn directories will be available during compile-time. + + SRC_URI = "svn://svn.oe.handhelds.org/svn;module=vip;proto=http;rev=667" +SRC_URI = "svn://svn.oe.handhelds.org/svn/;module=opie;proto=svn+ssh;date=20060126" + +
+ +
+ GIT fetcher + The URN for the GIT Fetcher is git. + + The variable GITDIR will be used as the base directory where the git tree is cloned to. + + The parameters are tag, protocol and scmdata. tag is a Git tag, the default is master. protocol is the Git protocol to use and defaults to git if a hostname is set, otherwise its file. If scmdata is set to keep, the .git directory will be available during compile-time. + + SRC_URI = "git://git.oe.handhelds.org/git/vip.git;tag=version-1" +SRC_URI = "git://git.oe.handhelds.org/git/vip.git;protocol=http" + +
+ + + + + + The BitBake command +
+ Introduction + bitbake is the primary command in the system. It facilitates executing tasks in a single .bb file, or executing a given task on a set of multiple .bb files, accounting for interdependencies amongst them. +
+
+ Usage and syntax + + $ bitbake --help +usage: bitbake [options] [package ...] + +Executes the specified task (default is 'build') for a given set of BitBake files. +It expects that BBFILES is defined, which is a space separated list of files to +be executed. BBFILES does support wildcards. +Default BBFILES are the .bb files in the current directory. + +options: + --version show program's version number and exit + -h, --help show this help message and exit + -b BUILDFILE, --buildfile=BUILDFILE + execute the task against this .bb file, rather than a + package from BBFILES. + -k, --continue continue as much as possible after an error. While the + target that failed, and those that depend on it, + cannot be remade, the other dependencies of these + targets can be processed all the same. + -f, --force force run of specified cmd, regardless of stamp status + -i, --interactive drop into the interactive mode also called the BitBake + shell. + -c CMD, --cmd=CMD Specify task to execute. Note that this only executes + the specified task for the providee and the packages + it depends on, i.e. 'compile' does not implicitly call + stage for the dependencies (IOW: use only if you know + what you are doing). Depending on the base.bbclass a + listtasks task is defined and will show available + tasks + -r FILE, --read=FILE read the specified file before bitbake.conf + -v, --verbose output more chit-chat to the terminal + -D, --debug Increase the debug level. You can specify this more + than once. + -n, --dry-run don't execute, just go through the motions + -p, --parse-only quit after parsing the BB files (developers only) + -s, --show-versions show current and preferred versions of all packages + -e, --environment show the global or per-package environment (this is + what used to be bbread) + -g, --graphviz emit the dependency trees of the specified packages in + the dot syntax + -I IGNORED_DOT_DEPS, --ignore-deps=IGNORED_DOT_DEPS + Stop processing at the given list of dependencies when + generating dependency graphs. This can help to make + the graph more appealing + -l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS + Show debug logging for the specified logging domains + -P, --profile profile the command and print a report + + + + + + + Executing a task against a single .bb + Executing tasks for a single file is relatively simple. You specify the file in question, and BitBake parses it and executes the specified task (or build by default). It obeys intertask dependencies when doing so. + clean task: + $ bitbake -b blah_1.0.bb -c clean + build task: + $ bitbake -b blah_1.0.bb + + + + + Executing tasks against a set of .bb files + There are a number of additional complexities introduced when one wants to manage multiple .bb files. Clearly there needs to be a way to tell BitBake what files are available, and of those, which we want to execute at this time. There also needs to be a way for each .bb to express its dependencies, both for build time and runtime. There must be a way for the user to express their preferences when multiple .bb's provide the same functionality, or when there are multiple versions of a .bb. + The next section, Metadata, outlines how to specify such things. + Note that the bitbake command, when not using --buildfile, accepts a PROVIDER, not a filename or anything else. By default, a .bb generally PROVIDES its packagename, packagename-version, and packagename-version-revision. + $ bitbake blah + $ bitbake blah-1.0 + $ bitbake blah-1.0-r0 + $ bitbake -c clean blah + $ bitbake virtual/whatever + $ bitbake -c clean virtual/whatever + + + Generating dependency graphs + BitBake is able to generate dependency graphs using the dot syntax. These graphs can be converted +to images using the dot application from Graphviz. +Two files will be written into the current working directory, depends.dot containing dependency information at the package level and task-depends.dot containing a breakdown of the dependencies at the task level. To stop depending on common depends, one can use the -I depend to omit these from the graph. This can lead to more readable graphs. This way, DEPENDS from inherited classes such as base.bbclass can be removed from the graph. + $ bitbake -g blah + $ bitbake -g -I virtual/whatever -I bloom blah + + +
+
+ Special variables + Certain variables affect BitBake operation: +
+ <varname>BB_NUMBER_THREADS</varname> + The number of threads BitBake should run at once (default: 1). +
+
+
+ Metadata + As you may have seen in the usage information, or in the information about .bb files, the BBFILES variable is how the BitBake tool locates its files. This variable is a space separated list of files that are available, and supports wildcards. + + Setting BBFILES + BBFILES = "/path/to/bbfiles/*.bb" + + With regard to dependencies, it expects the .bb to define a DEPENDS variable, which contains a space separated list of package names, which themselves are the PN variable. The PN variable is, in general, set to a component of the .bb filename by default. + + Depending on another .bb + a.bb: + PN = "package-a" +DEPENDS += "package-b" + + b.bb: + PN = "package-b" + + + + Using PROVIDES + This example shows the usage of the PROVIDES variable, which allows a given .bb to specify what functionality it provides. + package1.bb: + PROVIDES += "virtual/package" + + package2.bb: + DEPENDS += "virtual/package" + + package3.bb: + PROVIDES += "virtual/package" + + As you can see, we have two different .bb's that provide the same functionality (virtual/package). Clearly, there needs to be a way for the person running BitBake to control which of those providers gets used. There is, indeed, such a way. + The following would go into a .conf file, to select package1: + PREFERRED_PROVIDER_virtual/package = "package1" + + + + Specifying version preference + When there are multiple versions of a given package, BitBake defaults to selecting the most recent version, unless otherwise specified. If the .bb in question has a DEFAULT_PREFERENCE set lower than the other .bb's (default is 0), then it will not be selected. This allows the person or persons maintaining the repository of .bb files to specify their preference for the default selected version. In addition, the user can specify their preferred version. + If the first .bb is named a_1.1.bb, then the PN variable will be set to a, and the PV variable will be set to 1.1. + If we then have an a_1.2.bb, BitBake will choose 1.2 by default. However, if we define the following variable in a .conf that BitBake parses, we can change that. + PREFERRED_VERSION_a = "1.1" + + + + Using <quote>bbfile collections</quote> + bbfile collections exist to allow the user to have multiple repositories of bbfiles that contain the same exact package. For example, one could easily use them to make one's own local copy of an upstream repository, but with custom modifications that one does not want upstream. Usage: + BBFILES = "/stuff/openembedded/*/*.bb /stuff/openembedded.modified/*/*.bb" +BBFILE_COLLECTIONS = "upstream local" +BBFILE_PATTERN_upstream = "^/stuff/openembedded/" +BBFILE_PATTERN_local = "^/stuff/openembedded.modified/" +BBFILE_PRIORITY_upstream = "5" +BBFILE_PRIORITY_local = "10" + +
+ + -- cgit v1.2.3-54-g00ecf