bake-toolkit 2.29.4 → 2.30.0

data/documentation/_build/html/_sources/tips_and_tricks/the_bakery.txt

@@ -1,72 +0,0 @@
-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
-        }
-
-

data/documentation/_build/html/_sources/tips_and_tricks/the_clang.txt

@@ -1,43 +0,0 @@
-Clang Analyze
-*************
-
-bake can be easily used to analyze source files with Clang. It works simliar to regular compiling, but instead of
-invoking the compiler, the Clang Analyzer will be called.
-
-Imagine you have a workspace with the following "main" project:
-
-    .. code-block:: console
-
-		Project {
-          ...
-          ExecutableConfig Debug {
-            ...
-            DefaultToolchain GCC
-          }
-        }
-
-Either edit this Project.meta or create a new "analyze" project:
-
-    .. code-block:: console
-
-        Project {
-          CustomConfig Analyze {
-            Dependency main, config: Debug
-            DefaultToolchain CLANG_ANALYZE {
-              Compiler CPP {
-                Flags "-analyzer-checker=deadcode,security,alpha,unix,cplusplus"
-              }
-              Compiler C {
-                Flags "-analyzer-checker=deadcode,security,alpha,unix"
-              }
-            }
-          }
-        }
-
-As you can see the DefaultToolchain GCC is replaced with CLANG_ANALYZE. Call bake like this:
-
-    .. code-block:: console
-
-        bake Analyze -f .
-
-"-f" means that only the compilation step will take place. The "." means files with a "." in the name will be compiled (= all files). If you want to analyze only C++ files, you can write "-f .cpp"

data/documentation/_build/html/_sources/tips_and_tricks/tips_and_tricks.txt

@@ -1,35 +0,0 @@
-Additional features
-===================
-
-.. toctree::
-    :maxdepth: 1
-
-    the_bakery
-    how_to_use_bake_with_cygwin
-    the_clang
-    dot
-    qac
-    bakeclean
-
-
-Unnecessary includes
-********************
-
-If a library or executable is successfully build with "-v", unnecessary includes are printed out:
-
-.. code-block:: console
-
-    Info: Include to ../sub1/include/ seems to be unnecessary
-    Info: Include to ../sub2/include/ seems to be unnecessary
-
-This features depends on the compiler dependency files. For projects with assembler files, the list might be incorrect.
-However, remove the IncludeDir statements from the Project.meta and check it out.
-
-Symlinks and junctions
-**********************
-
-It is possible to use symlinks (Linux) or junctions (Windows) when working with git. Best practice:
-    * Link all used projects into _one_ directory (e.g. from application repository and basis software repository).
-    * Use this directory when working with bake, Eclipse, etc.
-    * Specify "-w <absolute_path_to_working_dir>.
-    * To sync/commit from/to svn, use the original directories created by git.

data/documentation/_build/html/_sources/why_bake/why_bake.txt

@@ -1,40 +0,0 @@
-Why you should use bake
-========================
-
-Whether you should use bake is entirely up to you,
-just take 2 minutes and have a look at our design goals and see if they fit what you are looking for.
-
-bake desgin goals
-******************
-
-=================================================================           ===============================================================================================
-Goal                                                                        Reasoning
-=================================================================           ===============================================================================================
-* It must be only a built tool                                              We want to focus your energy in providing a good and fast build tool.
-
-* It must be a command line tool                                            Sticking to the unix and single purpose phisolophy, we think proving a command line tool
-                                                                            is the easiest way to be easily used and integrated with other tools. **IDE independence!**
-
-* It must be easy to configure                                              We want the developer to be able to focus on coding and testing not on reading and searching
-                                                                            hours through the build tool documentation.
-                                                                            **A build tool should be easy to use and not hard to maintain!**
-
-* The configuration must not be a meta language                             We want our configurations to be WYSIWYG (What You See Is What You Get).
-                                                                            We don't want developers to spent hours in searching for a configuration error
-                                                                            where are multiple other config and script generation steps are in beteween.
-
-* It must be easy to understand configurations of large project             In large projects build configurations usually get pretty complex and big, therefore
-                                                                            generally just a few people understand the build process. This makes the maintance
-                                                                            dependend on those people. This is a single point of failure and
-                                                                            it should be avoided in our opinion.
-
-* It must be fast                                                           We personaly aren't fans waiting for the built, we rather build, test and then do a kicker
-                                                                            break!
-
-* It should be lightweight                                                  Lightweight here means, less depencies because depencies can hinder people to get their
-                                                                            setup up and running.
-
-* It must be easy to use different versions of the build tool               Sometimes it is necessary to break compatability to embrace progress, even though
-                                                                            it should be easy to switch between different version of the tool.
-=================================================================           ===============================================================================================
-

data/documentation/_build/html/_static/Lib.meta

@@ -1,8 +0,0 @@
-Project {
-
-    LibraryConfig Lib {
-        Files "**/*.cpp"
-        IncludeDir "include"
-    }
-
-}

data/documentation/_build/html/_static/Main.meta

@@ -1,26 +0,0 @@
-Project {
-
-    ExecutableConfig Debug {
-        Dependency Sub, config: Lib
-        Files "**/*.cpp"
-        IncludeDir "include"
-        DefaultToolchain GCC {
-            Compiler CPP {
-                Flags "... whatever -debug_info"
-                Define "DEBUG"
-            }
-        }
-    }
-
-    ExecutableConfig Release {
-        Dependency Sub, config: Lib
-        Files "**/*.cpp"
-        IncludeDir "include"
-        DefaultToolchain GCC {
-            Compiler CPP {
-                Flags "... whatever -optimize"
-                Define "NDEBUG"
-            }
-        }
-    }
-}

data/documentation/_build/html/_static/PMetaMain.meta

@@ -1,15 +0,0 @@
-Project {
-    ExecutableConfig Debug {
-        Dependency Sub, config: Debug
-        Files "**/*.cpp"
-        IncludeDir "include"
-        DefaultToolchain GCC {
-            Compiler CPP {
-                Flags "-Wall"
-            }
-        }
-        PostSteps {
-            CommandLine "echo $(ArtifactName) built."
-        }
-    }
-}

data/documentation/_build/html/_static/PMetaSub.meta

@@ -1,15 +0,0 @@
-Project {
-    LibraryConfig Debug {
-        Files "**/*.cpp"
-        IncludeDir "include"
-        IncludeDir "Main/include"
-        ExternalLibrarySearchPath "lib"
-        ExternalLibrary "a"
-        ExternalLibrary "b"
-        Toolchain {
-            Compiler CPP {
-                Flags add: "-g3"
-            }
-        }
-    }
-}

data/documentation/_build/html/_static/basic.css

@@ -1,599 +0,0 @@
-/*
- * basic.css
- * ~~~~~~~~~
- *
- * Sphinx stylesheet -- basic theme.
- *
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
- */
-
-/* -- main layout ----------------------------------------------------------- */
-
-div.clearer {
-    clear: both;
-}
-
-/* -- relbar ---------------------------------------------------------------- */
-
-div.related {
-    width: 100%;
-    font-size: 90%;
-}
-
-div.related h3 {
-    display: none;
-}
-
-div.related ul {
-    margin: 0;
-    padding: 0 0 0 10px;
-    list-style: none;
-}
-
-div.related li {
-    display: inline;
-}
-
-div.related li.right {
-    float: right;
-    margin-right: 5px;
-}
-
-/* -- sidebar --------------------------------------------------------------- */
-
-div.sphinxsidebarwrapper {
-    padding: 10px 5px 0 10px;
-}
-
-div.sphinxsidebar {
-    float: left;
-    width: 230px;
-    margin-left: -100%;
-    font-size: 90%;
-}
-
-div.sphinxsidebar ul {
-    list-style: none;
-}
-
-div.sphinxsidebar ul ul,
-div.sphinxsidebar ul.want-points {
-    margin-left: 20px;
-    list-style: square;
-}
-
-div.sphinxsidebar ul ul {
-    margin-top: 0;
-    margin-bottom: 0;
-}
-
-div.sphinxsidebar form {
-    margin-top: 10px;
-}
-
-div.sphinxsidebar input {
-    border: 1px solid #98dbcc;
-    font-family: sans-serif;
-    font-size: 1em;
-}
-
-div.sphinxsidebar #searchbox input[type="text"] {
-    width: 170px;
-}
-
-div.sphinxsidebar #searchbox input[type="submit"] {
-    width: 30px;
-}
-
-img {
-    border: 0;
-    max-width: 100%;
-}
-
-/* -- search page ----------------------------------------------------------- */
-
-ul.search {
-    margin: 10px 0 0 20px;
-    padding: 0;
-}
-
-ul.search li {
-    padding: 5px 0 5px 20px;
-    background-image: url(file.png);
-    background-repeat: no-repeat;
-    background-position: 0 7px;
-}
-
-ul.search li a {
-    font-weight: bold;
-}
-
-ul.search li div.context {
-    color: #888;
-    margin: 2px 0 0 30px;
-    text-align: left;
-}
-
-ul.keywordmatches li.goodmatch a {
-    font-weight: bold;
-}
-
-/* -- index page ------------------------------------------------------------ */
-
-table.contentstable {
-    width: 90%;
-}
-
-table.contentstable p.biglink {
-    line-height: 150%;
-}
-
-a.biglink {
-    font-size: 1.3em;
-}
-
-span.linkdescr {
-    font-style: italic;
-    padding-top: 5px;
-    font-size: 90%;
-}
-
-/* -- general index --------------------------------------------------------- */
-
-table.indextable {
-    width: 100%;
-}
-
-table.indextable td {
-    text-align: left;
-    vertical-align: top;
-}
-
-table.indextable dl, table.indextable dd {
-    margin-top: 0;
-    margin-bottom: 0;
-}
-
-table.indextable tr.pcap {
-    height: 10px;
-}
-
-table.indextable tr.cap {
-    margin-top: 10px;
-    background-color: #f2f2f2;
-}
-
-img.toggler {
-    margin-right: 3px;
-    margin-top: 3px;
-    cursor: pointer;
-}
-
-div.modindex-jumpbox {
-    border-top: 1px solid #ddd;
-    border-bottom: 1px solid #ddd;
-    margin: 1em 0 1em 0;
-    padding: 0.4em;
-}
-
-div.genindex-jumpbox {
-    border-top: 1px solid #ddd;
-    border-bottom: 1px solid #ddd;
-    margin: 1em 0 1em 0;
-    padding: 0.4em;
-}
-
-/* -- general body styles --------------------------------------------------- */
-
-a.headerlink {
-    visibility: hidden;
-}
-
-h1:hover > a.headerlink,
-h2:hover > a.headerlink,
-h3:hover > a.headerlink,
-h4:hover > a.headerlink,
-h5:hover > a.headerlink,
-h6:hover > a.headerlink,
-dt:hover > a.headerlink,
-caption:hover > a.headerlink,
-p.caption:hover > a.headerlink,
-div.code-block-caption:hover > a.headerlink {
-    visibility: visible;
-}
-
-div.body p.caption {
-    text-align: inherit;
-}
-
-div.body td {
-    text-align: left;
-}
-
-.field-list ul {
-    padding-left: 1em;
-}
-
-.first {
-    margin-top: 0 !important;
-}
-
-p.rubric {
-    margin-top: 30px;
-    font-weight: bold;
-}
-
-img.align-left, .figure.align-left, object.align-left {
-    clear: left;
-    float: left;
-    margin-right: 1em;
-}
-
-img.align-right, .figure.align-right, object.align-right {
-    clear: right;
-    float: right;
-    margin-left: 1em;
-}
-
-img.align-center, .figure.align-center, object.align-center {
-  display: block;
-  margin-left: auto;
-  margin-right: auto;
-}
-
-.align-left {
-    text-align: left;
-}
-
-.align-center {
-    text-align: center;
-}
-
-.align-right {
-    text-align: right;
-}
-
-/* -- sidebars -------------------------------------------------------------- */
-
-div.sidebar {
-    margin: 0 0 0.5em 1em;
-    border: 1px solid #ddb;
-    padding: 7px 7px 0 7px;
-    background-color: #ffe;
-    width: 40%;
-    float: right;
-}
-
-p.sidebar-title {
-    font-weight: bold;
-}
-
-/* -- topics ---------------------------------------------------------------- */
-
-div.topic {
-    border: 1px solid #ccc;
-    padding: 7px 7px 0 7px;
-    margin: 10px 0 10px 0;
-}
-
-p.topic-title {
-    font-size: 1.1em;
-    font-weight: bold;
-    margin-top: 10px;
-}
-
-/* -- admonitions ----------------------------------------------------------- */
-
-div.admonition {
-    margin-top: 10px;
-    margin-bottom: 10px;
-    padding: 7px;
-}
-
-div.admonition dt {
-    font-weight: bold;
-}
-
-div.admonition dl {
-    margin-bottom: 0;
-}
-
-p.admonition-title {
-    margin: 0px 10px 5px 0px;
-    font-weight: bold;
-}
-
-div.body p.centered {
-    text-align: center;
-    margin-top: 25px;
-}
-
-/* -- tables ---------------------------------------------------------------- */
-
-table.docutils {
-    border: 0;
-    border-collapse: collapse;
-}
-
-table caption span.caption-number {
-    font-style: italic;
-}
-
-table caption span.caption-text {
-}
-
-table.docutils td, table.docutils th {
-    padding: 1px 8px 1px 5px;
-    border-top: 0;
-    border-left: 0;
-    border-right: 0;
-    border-bottom: 1px solid #aaa;
-}
-
-table.field-list td, table.field-list th {
-    border: 0 !important;
-}
-
-table.footnote td, table.footnote th {
-    border: 0 !important;
-}
-
-th {
-    text-align: left;
-    padding-right: 5px;
-}
-
-table.citation {
-    border-left: solid 1px gray;
-    margin-left: 1px;
-}
-
-table.citation td {
-    border-bottom: none;
-}
-
-/* -- figures --------------------------------------------------------------- */
-
-div.figure {
-    margin: 0.5em;
-    padding: 0.5em;
-}
-
-div.figure p.caption {
-    padding: 0.3em;
-}
-
-div.figure p.caption span.caption-number {
-    font-style: italic;
-}
-
-div.figure p.caption span.caption-text {
-}
-
-
-/* -- other body styles ----------------------------------------------------- */
-
-ol.arabic {
-    list-style: decimal;
-}
-
-ol.loweralpha {
-    list-style: lower-alpha;
-}
-
-ol.upperalpha {
-    list-style: upper-alpha;
-}
-
-ol.lowerroman {
-    list-style: lower-roman;
-}
-
-ol.upperroman {
-    list-style: upper-roman;
-}
-
-dl {
-    margin-bottom: 15px;
-}
-
-dd p {
-    margin-top: 0px;
-}
-
-dd ul, dd table {
-    margin-bottom: 10px;
-}
-
-dd {
-    margin-top: 3px;
-    margin-bottom: 10px;
-    margin-left: 30px;
-}
-
-dt:target, .highlighted {
-    background-color: #fbe54e;
-}
-
-dl.glossary dt {
-    font-weight: bold;
-    font-size: 1.1em;
-}
-
-.field-list ul {
-    margin: 0;
-    padding-left: 1em;
-}
-
-.field-list p {
-    margin: 0;
-}
-
-.optional {
-    font-size: 1.3em;
-}
-
-.sig-paren {
-    font-size: larger;
-}
-
-.versionmodified {
-    font-style: italic;
-}
-
-.system-message {
-    background-color: #fda;
-    padding: 5px;
-    border: 3px solid red;
-}
-
-.footnote:target  {
-    background-color: #ffa;
-}
-
-.line-block {
-    display: block;
-    margin-top: 1em;
-    margin-bottom: 1em;
-}
-
-.line-block .line-block {
-    margin-top: 0;
-    margin-bottom: 0;
-    margin-left: 1.5em;
-}
-
-.guilabel, .menuselection {
-    font-family: sans-serif;
-}
-
-.accelerator {
-    text-decoration: underline;
-}
-
-.classifier {
-    font-style: oblique;
-}
-
-abbr, acronym {
-    border-bottom: dotted 1px;
-    cursor: help;
-}
-
-/* -- code displays --------------------------------------------------------- */
-
-pre {
-    overflow: auto;
-    overflow-y: hidden;  /* fixes display issues on Chrome browsers */
-}
-
-td.linenos pre {
-    padding: 5px 0px;
-    border: 0;
-    background-color: transparent;
-    color: #aaa;
-}
-
-table.highlighttable {
-    margin-left: 0.5em;
-}
-
-table.highlighttable td {
-    padding: 0 0.5em 0 0.5em;
-}
-
-div.code-block-caption {
-    padding: 2px 5px;
-    font-size: small;
-}
-
-div.code-block-caption code {
-    background-color: transparent;
-}
-
-div.code-block-caption + div > div.highlight > pre {
-    margin-top: 0;
-}
-
-div.code-block-caption span.caption-number {
-    padding: 0.1em 0.3em;
-    font-style: italic;
-}
-
-div.code-block-caption span.caption-text {
-}
-
-div.literal-block-wrapper {
-    padding: 1em 1em 0;
-}
-
-div.literal-block-wrapper div.highlight {
-    margin: 0;
-}
-
-code.descname {
-    background-color: transparent;
-    font-weight: bold;
-    font-size: 1.2em;
-}
-
-code.descclassname {
-    background-color: transparent;
-}
-
-code.xref, a code {
-    background-color: transparent;
-    font-weight: bold;
-}
-
-h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
-    background-color: transparent;
-}
-
-.viewcode-link {
-    float: right;
-}
-
-.viewcode-back {
-    float: right;
-    font-family: sans-serif;
-}
-
-div.viewcode-block:target {
-    margin: -1px -10px;
-    padding: 0 10px;
-}
-
-/* -- math display ---------------------------------------------------------- */
-
-img.math {
-    vertical-align: middle;
-}
-
-div.body div.math p {
-    text-align: center;
-}
-
-span.eqno {
-    float: right;
-}
-
-/* -- printout stylesheet --------------------------------------------------- */
-
-@media print {
-    div.document,
-    div.documentwrapper,
-    div.bodywrapper {
-        margin: 0 !important;
-        width: 100%;
-    }
-
-    div.sphinxsidebar,
-    div.related,
-    div.footer,
-    #top-link {
-        display: none;
-    }
-}