bitbake/doc/manual/usermanual.xml:
authorHolger Hans Peter Freyther <zecke@selfish.org>
Sat, 30 Jul 2005 12:20:27 +0000 (12:20 +0000)
committerHolger Hans Peter Freyther <zecke@selfish.org>
Sat, 30 Jul 2005 12:20:27 +0000 (12:20 +0000)
    -Update the result of bitbake --help
    -Add note of the removal of bbread and its replacement with bitbake -e

doc/manual/usermanual.xml

index d54300b..b96863c 100644 (file)
@@ -227,6 +227,8 @@ of the event and the content of the <varname>FILE</varname> variable.</para>
         <section>
             <title>bbread</title>
             <para>bbread is a command for displaying BitBake metadata.  When run with no arguments, it has the core parse 'conf/bitbake.conf', as located in BBPATH, and displays that.  If you supply a file on the commandline, such as a .bb, then it parses that afterwards, using the aforementioned configuration metadata.</para>
+        <para><emphasis>NOTE: the stand a lone bbread command was removed. Instead of bbread use bitbake -e.
+        </emphasis></para>
         </section>
         <section>
             <title>bitbake</title>
@@ -248,23 +250,32 @@ 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
-  -bBUILDFILE, --buildfile=BUILDFILE
+  -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.
+                        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
-  -cCMD, --cmd=CMD      Specify task to execute
-  -rFILE, --read=FILE   read the specified file before bitbake.conf
+  -i, --interactive     drop into the interactive mode.
+  -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)
+  -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
   -n, --dry-run         don't execute, just go through the motions
   -p, --parse-only      quit after parsing the BB files (developers only)
   -d, --disable-psyco   disable using the psyco just-in-time compiler (not
                         recommended)
-  -s, --show-versions   show current and preferred versions of all packages</screen>
+  -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)
+
+</screen>
                 </para>
                 <para>
                 <example>