diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2011-08-31 07:59:00 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-09-02 23:38:50 +0100 |
commit | 31acde62adef235db52a244a0b6f96c68ec968e6 (patch) | |
tree | d37de1c2cf82c689e291b39e9a0ec4bbac96fd82 /documentation | |
parent | 0d6dc5c2c0fc0ef6be102933b8b34d067c2ffc23 (diff) | |
download | poky-31acde62adef235db52a244a0b6f96c68ec968e6.tar.gz |
documentation/poky-ref-manual/usingpoky.xml: Edits per Darren Hart
Darren provided me with some feedback on the logging mechanism
section for both Python and Bash.
(From yocto-docs rev: 7dddadf8caba01d3ef1046be52a1435eeaed60a3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/poky-ref-manual/usingpoky.xml | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml index 97fb558432..fa94b1d604 100644 --- a/documentation/poky-ref-manual/usingpoky.xml +++ b/documentation/poky-ref-manual/usingpoky.xml | |||
@@ -384,14 +384,14 @@ | |||
384 | and <filename>bb.debug</filename>.</para></listitem> | 384 | and <filename>bb.debug</filename>.</para></listitem> |
385 | <listitem><para><emphasis>Bash:</emphasis> For Bash functions, the same set | 385 | <listitem><para><emphasis>Bash:</emphasis> For Bash functions, the same set |
386 | of loglevels exist and are accessed with a similar syntax: | 386 | of loglevels exist and are accessed with a similar syntax: |
387 | <filename>bb.fatal</filename>, <filename>bb.error</filename>, | 387 | <filename>bbfatal</filename>, <filename>bberror</filename>, |
388 | <filename>bb.warn</filename>, <filename>bb.note</filename>, | 388 | <filename>bbwarn</filename>, <filename>bbnote</filename>, |
389 | <filename>bb.plain</filename>, and <filename>bb.debug</filename>.</para></listitem> | 389 | <filename>bbplain</filename>, and <filename>bbdebug</filename>.</para></listitem> |
390 | </itemizedlist> | 390 | </itemizedlist> |
391 | </para> | 391 | </para> |
392 | 392 | ||
393 | <para> | 393 | <para> |
394 | For guidance on <filename>echo</filename> how logging is handled | 394 | For guidance on how logging is handled |
395 | in both Python and Bash recipes, see the | 395 | in both Python and Bash recipes, see the |
396 | <filename>logging.bbclass</filename> file in the | 396 | <filename>logging.bbclass</filename> file in the |
397 | <filename>meta/classes</filename> directory of the Yocto Project files. | 397 | <filename>meta/classes</filename> directory of the Yocto Project files. |
@@ -407,7 +407,7 @@ | |||
407 | </para> | 407 | </para> |
408 | 408 | ||
409 | <para> | 409 | <para> |
410 | Following is sample code from a recipe written in Python. | 410 | Following is an example written in Python. |
411 | The code handles logging for a function that determines the number of tasks | 411 | The code handles logging for a function that determines the number of tasks |
412 | needed to be run: | 412 | needed to be run: |
413 | <literallayout class='monospaced'> | 413 | <literallayout class='monospaced'> |
@@ -439,7 +439,7 @@ | |||
439 | </para> | 439 | </para> |
440 | 440 | ||
441 | <para> | 441 | <para> |
442 | Following is sample code from a recipe written in Bash. | 442 | Following is an example written in Bash. |
443 | The code logs the progress of the <filename>do_my_function</filename> function. | 443 | The code logs the progress of the <filename>do_my_function</filename> function. |
444 | <literallayout class='monospaced'> | 444 | <literallayout class='monospaced'> |
445 | do_my_function() { | 445 | do_my_function() { |
@@ -449,15 +449,15 @@ | |||
449 | fi | 449 | fi |
450 | bbdebug 2 "Got to point xyz" | 450 | bbdebug 2 "Got to point xyz" |
451 | if [ warning_trigger ]; then | 451 | if [ warning_trigger ]; then |
452 | warn "Detected warning_trigger, this might cause a problem later." | 452 | bbwarn "Detected warning_trigger, this might cause a problem later." |
453 | fi | 453 | fi |
454 | if [ recoverable_error ]; then | 454 | if [ recoverable_error ]; then |
455 | error "Hit recoverable_error, correcting" | 455 | bberror "Hit recoverable_error, correcting" |
456 | fi | 456 | fi |
457 | if [ fatal_error ]; then | 457 | if [ fatal_error ]; then |
458 | fatal "fatal_error detected" | 458 | bbfatal "fatal_error detected" |
459 | fi | 459 | fi |
460 | debug 2 "Completed do_my_function" | 460 | bbdebug 2 "Completed do_my_function" |
461 | } | 461 | } |
462 | </literallayout> | 462 | </literallayout> |
463 | </para> | 463 | </para> |