Sha256: 826f40480d58c2b2175d4a4ee4cba4f8f9a6b247adb6cf054be9bda80626f7de

Contents?: true

Size: 1.92 KB

Versions: 17

Compression:

Stored size: 1.92 KB

Contents

The Bakery
==========

What is the Bakery
******************
bakery is part of the bake-toolkit distribution and it is used to build several independent projects at once.
It's very useful for e.g. compiling and running all unit tests.
The collections are specified in Collection.meta files.

How to use the Bakery on the commandline
****************************************
Call *bakery -h* to display the command line options.
The most important options are the collection name (*-b*) and the collection directory (*-m*, default is current directory).

Examples:

    Build all unittests:

    .. code-block:: console

        bakery -b AllUnitTests
        
    It is possible to omit *-b*:

    .. code-block:: console

        bakery AllUnitTests

    Clean all unittests:
    
    .. code-block:: console

        bakery -b AllUnitTests -c

    Build all unittests, workspace checked out into two roots, console supports colors, stop on first error, run the unittests after build:

    .. code-block:: console

        bakery -b AllUnitTests -m w:/root1/mainProj -w w:/root2 -r -a black --do run


Syntax of Collection.meta
*************************
Move the mouse cursor over the blue elements to display more information.

.. raw:: html
    :file: ../_static/syntax_collection_meta.html

.. note::

    * Use double quotes (") if the strings have wildcards
    * Use hash marks (#) for comments.

Example:

    .. code-block:: text

        Collection AllUnitTests {
            Project "*", config: UnitTest
        }
        Collection UnitTestLibsWithoutBsp {
            Project "*", config: "UnitTestLib*"
            Exclude "bsp*", config: "*"
        }
        Collection MySpecialCollection {
            Project Main1, config: Debug
            Project Main2, config: Release
            Project Sub3, config: Debug
            SubCollection UnitTestLibsWithoutBsp
        }


Version data entries

17 entries across 17 versions & 1 rubygems

Version Path
bake-toolkit-2.20.4 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.20.3 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.20.2 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.20.1 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.19.2 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.19.1 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.19.0 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.18.0 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.17.4 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.17.3 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.17.2 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.17.1 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.16.1 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.15.0 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.14.0 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.13.1 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt
bake-toolkit-2.13.0 documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt