summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml150
1 files changed, 75 insertions, 75 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 3148d0f154..2414d3b036 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -493,6 +493,14 @@
493 </glossdef> 493 </glossdef>
494 </glossentry> 494 </glossentry>
495 495
496 <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm>
497 <glossdef>
498 <para>The maximum number of tasks BitBake should run in parallel at any one time.
499 If your host development system supports multiple cores a good rule of thumb
500 is to set this variable to twice the number of cores.</para>
501 </glossdef>
502 </glossentry>
503
496 <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm> 504 <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm>
497 <glossdef> 505 <glossdef>
498 <para> 506 <para>
@@ -517,74 +525,6 @@
517 </glossdef> 525 </glossdef>
518 </glossentry> 526 </glossentry>
519 527
520 <glossentry id='var-BBMASK'><glossterm>BBMASK</glossterm>
521 <glossdef>
522 <para>
523 Prevents BitBake from processing recipes and recipe
524 append files.
525 Use the <filename>BBMASK</filename> variable from within the
526 <filename>conf/local.conf</filename> file found
527 in the
528 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
529 </para>
530
531 <para>
532 You can use the <filename>BBMASK</filename> variable
533 to "hide" these <filename>.bb</filename> and
534 <filename>.bbappend</filename> files.
535 BitBake ignores any recipe or recipe append files that
536 match the expression.
537 It is as if BitBake does not see them at all.
538 Consequently, matching files are not parsed or otherwise
539 used by BitBake.</para>
540 <para>
541 The value you provide is passed to Python's regular
542 expression compiler.
543 The expression is compared against the full paths to
544 the files.
545 For complete syntax information, see Python's
546 documentation at
547 <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>.
548 </para>
549
550 <para>
551 The following example uses a complete regular expression
552 to tell BitBake to ignore all recipe and recipe append
553 files in the <filename>/meta-ti/recipes-misc/</filename>
554 directory:
555 <literallayout class='monospaced'>
556 BBMASK = "/meta-ti/recipes-misc/"
557 </literallayout>
558 If you want to mask out multiple directories or recipes,
559 use the vertical bar to separate the regular expression
560 fragments.
561 This next example masks out multiple directories and
562 individual recipes:
563 <literallayout class='monospaced'>
564 BBMASK = "meta-ti/recipes-misc/|meta-ti/recipes-ti/packagegroup/"
565 BBMASK .= "|.*meta-oe/recipes-support/"
566 BBMASK .= "|.*openldap"
567 BBMASK .= "|.*opencv"
568 BBMASK .= "|.*lzma"
569 </literallayout>
570 Notice how the vertical bar is used to append the fragments.
571 <note>
572 When specifying a directory name, use the trailing
573 slash character to ensure you match just that directory
574 name.
575 </note>
576 </para>
577 </glossdef>
578 </glossentry>
579
580 <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm>
581 <glossdef>
582 <para>The maximum number of tasks BitBake should run in parallel at any one time.
583 If your host development system supports multiple cores a good rule of thumb
584 is to set this variable to twice the number of cores.</para>
585 </glossdef>
586 </glossentry>
587
588 <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm> 528 <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm>
589 <glossdef> 529 <glossdef>
590 <para>Lists the names of configured layers. 530 <para>Lists the names of configured layers.
@@ -644,13 +584,6 @@
644 </glossdef> 584 </glossdef>
645 </glossentry> 585 </glossentry>
646 586
647 <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm>
648 <glossdef>
649 <para>Used by BitBake to locate <filename>.bbclass</filename> and configuration files.
650 This variable is analogous to the <filename>PATH</filename> variable.</para>
651 </glossdef>
652 </glossentry>
653
654 <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm> 587 <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm>
655 <glossdef> 588 <glossdef>
656 <para>Variable that controls how BitBake displays logs on build failure.</para> 589 <para>Variable that controls how BitBake displays logs on build failure.</para>
@@ -710,6 +643,73 @@ Core layer for images cannot be removed
710 </glossdef> 643 </glossdef>
711 </glossentry> 644 </glossentry>
712 645
646 <glossentry id='var-BBMASK'><glossterm>BBMASK</glossterm>
647 <glossdef>
648 <para>
649 Prevents BitBake from processing recipes and recipe
650 append files.
651 Use the <filename>BBMASK</filename> variable from within the
652 <filename>conf/local.conf</filename> file found
653 in the
654 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
655 </para>
656
657 <para>
658 You can use the <filename>BBMASK</filename> variable
659 to "hide" these <filename>.bb</filename> and
660 <filename>.bbappend</filename> files.
661 BitBake ignores any recipe or recipe append files that
662 match the expression.
663 It is as if BitBake does not see them at all.
664 Consequently, matching files are not parsed or otherwise
665 used by BitBake.</para>
666 <para>
667 The value you provide is passed to Python's regular
668 expression compiler.
669 The expression is compared against the full paths to
670 the files.
671 For complete syntax information, see Python's
672 documentation at
673 <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>.
674 </para>
675
676 <para>
677 The following example uses a complete regular expression
678 to tell BitBake to ignore all recipe and recipe append
679 files in the <filename>/meta-ti/recipes-misc/</filename>
680 directory:
681 <literallayout class='monospaced'>
682 BBMASK = "/meta-ti/recipes-misc/"
683 </literallayout>
684 If you want to mask out multiple directories or recipes,
685 use the vertical bar to separate the regular expression
686 fragments.
687 This next example masks out multiple directories and
688 individual recipes:
689 <literallayout class='monospaced'>
690 BBMASK = "meta-ti/recipes-misc/|meta-ti/recipes-ti/packagegroup/"
691 BBMASK .= "|.*meta-oe/recipes-support/"
692 BBMASK .= "|.*openldap"
693 BBMASK .= "|.*opencv"
694 BBMASK .= "|.*lzma"
695 </literallayout>
696 Notice how the vertical bar is used to append the fragments.
697 <note>
698 When specifying a directory name, use the trailing
699 slash character to ensure you match just that directory
700 name.
701 </note>
702 </para>
703 </glossdef>
704 </glossentry>
705
706 <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm>
707 <glossdef>
708 <para>Used by BitBake to locate <filename>.bbclass</filename> and configuration files.
709 This variable is analogous to the <filename>PATH</filename> variable.</para>
710 </glossdef>
711 </glossentry>
712
713 <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm> 713 <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm>
714 <glossdef> 714 <glossdef>
715 <para> 715 <para>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-17 18:43:38 +0000