bake-toolkit 2.19.2 → 2.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f884a69d7227c58640b9ce9ee280e1a4df32d187
-  data.tar.gz: 8a60282cc0cc332250ad468e39a8eca781bb926a
+  metadata.gz: 4d9abca5ad68f7e5e78b4043e8a3d979dc662a73
+  data.tar.gz: c2666bd053263bbf16e86e5609541d08191ac566
 SHA512:
-  metadata.gz: e59eb35575c63eb6a3abc708ad22bc5ecda93e1e727ff4547bd66a970840249fc84127b5cc1451e91bfd0cb628bafc42557a012e372d01e850f9d16867e998f0
-  data.tar.gz: 440da1962f57b425975372251ab7fb44f8d1b5e9b89f6b0762ad2e777f32545a14e6868877e6bb8e9975081c81993cbdddc0b474089a51fa9c4ac5448ee6dfa2
+  metadata.gz: ef84a235c5295a12547daa67a456456db09f2fcb6a7e5a39b553fd0c2b9e7df9248e1eac11d407b2ab6fb50cce8d2f4d5ceb29d5a86e72b5daa24604f99177b7
+  data.tar.gz: 9fc8c950e6adc304fc009346d3fff588939c5dc68c1ea89133df3522c2283cb8f28dd8a47c66e8a16a69872dfc65a64dbe65bb4d1e39d235b87f2ad003d80c02

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

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+September 5, 2016 - bake-toolkit 2.20.1
+    * Added: inject feature for dependencies
+    * Added: option to generate a dot graph file
+    * Added: *prebuild* feature for distribution builds
+    * Added: commandline option *--build_* to enable the old outputdir behaviour: *build_* instead of *build/*
+    * Added: printing out more information when loading Project.metas in verbosity level 3
+    * Changed: circular dependency warning moved from verbosity level 1 to 3
+    * Added: ToolchainName is now a predefined variable for Project.meta
+    * Added: --compile-only option (which is equal to the workaround -f ".")
+    * Bugfix: --adapt commandline option accepts absolute paths now
+    * Changed: removed the *bundle* feature
+
 August 12, 2016 - bake-toolkit 2.19.2
     * Bugfix: fixed TI linker error parser
 

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

@@ -9,4 +9,6 @@ Concepts
     the_main_project
     build_hierarchy
     link_order
+    prebuild
+    inject
 

data/documentation/_build/html/_sources/concepts/inject.txt

@@ -0,0 +1,65 @@
+Injection and inheritance of IncludeDir and Dependency
+******************************************************
+
+It is possible to inject and inherit "includes" and inject "dependencies".
+
+Inherit IncludeDir
+==================
+
+.. code-block:: console
+
+    IncludeDir include, inherit: true
+
+This is typically used to make include directories available to upper levels, e.g.:
+
+
+.. code-block:: console
+
+    # in MyLib/Project.meta
+    LibraryConfig Lib {
+      ...
+      IncludeDir include, inherit: true
+    }
+
+    # in main/Project.meta
+    ExecutableConfig Debug {
+      ...
+      Dependency MyLib, config: Lib
+      # IncludeDir "MyLib/include" - not needed because this IncludeDir is inherited
+    }
+
+Inject IncludeDir
+=================
+
+.. code-block:: console
+
+    IncludeDir "mock/include", inject: front
+
+"front" is used for mocking IncludeDirs, e.g. if a library shall include a mocked class instead of the original one in UnitTest context.
+
+.. code-block:: console
+
+    IncludeDir include, inject: back
+
+"back" is used if the lower levels do not know by themselves what to include. So this has to be configured from the outside, typically in the main project.
+
+Inject Dependency
+=================
+
+.. code-block:: console
+
+    Dependency MyLib, inject: front # or back
+
+This is used if a component cannot have this dependency hard coded, because it shall not know the concrete implementation or the dependency is only used for unittesting.
+
+Example:
+
+.. code-block:: console
+
+    ExecutableConfig UnitTest {
+      ...
+      Dependency config: Lib
+      Dependency googleTest, inject: front
+    }
+
+In this example the config Lib depends on googleTest. If googleTest inherits an IncludeDir, this would be known by Lib.

data/documentation/_build/html/_sources/concepts/prebuild.txt

@@ -0,0 +1,56 @@
+Prebuild configurations for distributions
+*****************************************
+
+This is a useful feature if you want to make a part of workspace available for third party without changing the configuration.
+
+There are two major use cases:
+
+- Only a few projects shall be closed source (e.g. to hide some algorithms)
+- Only a few projects shall be open source (e.g. if a supplier has integrate a library)
+
+Both is possible with bake, but the current UI is optimized for the latter one.
+
+Add in the Project.meta the following code:
+
+.. code-block:: console
+
+    Prebuild {
+      Except main, config: Debug
+      Except newLib, config: Debug
+      Except setup, config: Release
+    }
+
+It is possible to specify the Prebuild tags in all configurations, not only in the main configuration. Logically they will be merged.
+
+In the example above, no configurations will be built - except those three. The prebuild output is used directly.
+
+To reference a configuration of the same project, omit the project name, e.g.:
+
+.. code-block:: console
+
+    Except config: Base
+
+To reference all configuration of a project, omit the config name, e.g.:
+
+.. code-block:: console
+
+    Except newLib
+
+
+This prebuild behaviour must be explicitly turned on by using the following the command line argument:
+
+.. code-block:: console
+
+    --prebuild
+
+
+Typical workflow
+----------------
+
+1. Compiling the workspace completely without prebuild feature.
+2. Executing a distribution script which copies all relevant files to a distribution directory.
+   Make sure to add all header files of prebuild libraries if they are needed for other non-prebuild libraries.
+   You may use the dependency files in the output directory for that script.
+3. In the distribution folder use "--prebuild" when compiling the workspace.
+
+

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

@@ -1,4 +1,4 @@
-bake 2.19.2
+bake 2.20.1
 ==========================================
 bake, building software **fast** and **easy**!
 

data/documentation/_build/html/_sources/syntax/auto_adjustment.txt

@@ -0,0 +1,43 @@
+Auto-adjustment of paths to existing projects
+=============================================
+
+If paths to other projects are needed, e.g. to "bootloaderUpdater", don't write a hard coded relative path like this:
+
+.. code-block:: text
+
+    CommandLine "../bootloaderUpdater/tools/PrimaryBootloader2Include.exe
+
+If paths to other projects are needed, e.g. to "bootloaderUpdater" just reference it starting from the project folder.
+
+Example:
+
+.. code-block:: text
+
+    CommandLine "bootloaderUpdater/tools/PrimaryBootloader2Include.exe
+
+or:
+
+.. code-block:: text
+
+    IncludeDir "myProjectName/bootloaderUpdater/whatever"
+
+
+
+bake recognizes that the first part of the path is a valid project name and calculates the relative path to the project automatically.
+If you have the special case that the referenced project is contained in an other workspace root, you can use the
+`-w` parameter or you define a `roots.bake`.
+
+.. note::
+
+    The path auto adjustment is applied for the following elements:
+
+    * IncludeDir
+
+    * ExternalLibrary
+
+    * ExternalLibrarySearchPath
+
+    * UserLibrary
+
+    * CommandLine
+

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

@@ -8,4 +8,4 @@ Syntax
     variable_substitutions
     derive_configs
     adapt_configs
-
+    auto_adjustment

data/documentation/_build/html/_sources/syntax/variable_substitutions.txt

@@ -1,18 +1,28 @@
 Variables in Project.meta
 =========================
-bake allows you to use pre defined and/or user defined variables in your Project.meta file.
-Defined variables then can be used using the following syntax:
+bake allows you to use
+
+- user defined
+- predefined
+- environment
+
+variables in your Project.meta file (in this priority). If a variable is not found, it will be evaluated to an empty string.
+
+Using variables
+***************
+
+Variables can be used using the following syntax:
 
 .. code-block:: console
 
-   $(MyIncludes)
+   $(ABC)
 
-The variable MyIncludes will be substitued by its value, therefore a real life usage would look
+The variable ABC will be substituted by its value, therefore a real life usage would look
 something like this:
 
 .. code-block:: console
 
-   IncludeDir "$(MyIncludes)"
+   IncludeDir "$(ABC)"
 
 User defined variables
 **********************
@@ -30,10 +40,12 @@ There are two ways to create user defined variables.
 .. code-block:: console
 
     Set MyVar, value: "Hello world!"
+    Set MyVar, cmd: "ruby calcVar.rb"
 
+In the latter one the variable is set to the output of the command.
 
-Pre defined bake environment variables
-**************************************
+Predefined bake environment variables
+*************************************
 
 ========================================    ===============================================     ========================================
 Variable                                    Description                                         Example
@@ -82,6 +94,8 @@ Variable                                    Description
 *$(LinkerPath)*                             Evaluates to the base path of the                   /usr/bin
                                             linker
 
+*$(ToolchainName)*                          Names of the used DefaultToolchain                  GCC
+
 *$(/)*                                      Evalutes to the directory path seperator of         Windows: \\, Other: /
                                             the current platform
 
@@ -89,33 +103,10 @@ Variable                                    Description
                                             of the current platform
 ========================================    ===============================================     ========================================
 
-.. tip::
-
-    It is also possible to retrieve arbitrary an *environment variable* using the following syntax:
-
-    .. code-block:: console
-
-        $(EnvironmentVariable)
-
-    Evaluates to the Environment with the specified name, if the specified environment variable does not exists
-    it will be substituted by an empty string.
-
-.. note::
-
-    Equal variables in the main config
-
-    ========================================    ========================================
-    Variable                                    Is equal to
-    ========================================    ========================================
-    $(MainConfigName)                           $(ConfigName)
-
-    $(MainProjectName)                          $(ProjectName)
-    ========================================    ========================================
-
-.. warning::
-
-    Variables in Dependency definitions are not allowed!
+Environment variables
+*********************
 
+Usually used if system dependent stuff is needed like path to a specific tool etc.
 
 Nested variables
 ****************
@@ -125,51 +116,33 @@ Example:
 
 .. code-block:: console
 
-    $(OutputDir,$(TheProject),$(TheConfig))
     $(ABC$(DEF)GH)
 
 
-Auto-adjustment of paths to existing projects
-*********************************************
-.. warning::
-
-    If paths to other projects are needed, e.g. to "bootloaderUpdater", don't write a hard coded relative path like this:
-
-    .. code-block:: text
-
-        CommandLine "../bootloaderUpdater/tools/PrimaryBootloader2Include.exe
-
-If paths to other projects are needed, e.g. to "bootloaderUpdater" just reference it starting from the project folder.
-
-Example:
-
-.. code-block:: text
+Complex variables
+*****************
 
-    CommandLine "bootloaderUpdater/tools/PrimaryBootloader2Include.exe
+bake supports one complex variable:
 
-or:
-
-.. code-block:: text
-
-    IncludeDir "myProjectName/bootloaderUpdater/whatever"
-
-
-
-bake recognizes that the first part of the path is a valid project name and calculates the relative path to the project automatically.
-If you have the special case that the referenced project is contained in an other workspace root, you can use the
-`-w` parameter or you define a `roots.bake`.
+.. code-block:: console
 
-.. note::
+    $(OutputDir,$(TheProject),$(TheConfig))
 
-    The path auto adjustment is applied for the following elements:
+This will evaluate to the output directory of a specific configuration.
 
-    * IncludeDir
+Notes and warnings
+******************
 
-    * ExternalLibrary
+Equal variables in the main config:
 
-    * ExternalLibrarySearchPath
+========================================    ========================================
+Variable                                    Is equal to
+========================================    ========================================
+$(MainConfigName)                           $(ConfigName)
 
-    * UserLibrary
+$(MainProjectName)                          $(ProjectName)
+========================================    ========================================
 
-    * CommandLine
+.. warning::
 
+    Variables in Dependency definitions are not allowed!

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

@@ -0,0 +1,34 @@
+Generating dot graphs
+*********************
+
+In larger workspaces it's often hard to understand the dependency structure. With bake you can generate a dot file (see http://www.graphviz.org):
+
+.. code-block:: console
+
+    bake ... --dot <dot filename>
+
+The dot file is a text file with all dependencies included. It is easy to render an image, e.g. with
+
+.. code-block:: console
+
+    tred <dot filename> | dot -Tpng -o <png image filename>
+
+.. image:: ../_static/dot.png
+
+- Projects are rectangles
+- Configs are ellipses
+- CustomConfigs are red
+- ExecutableConfigs are green
+- LibraryConfigs are cyan
+
+It's possible to generate only a part of the whole graph with -p (same as for building only a part of the code). e.g.:
+
+.. code-block:: console
+
+    bake ... --dot <dot filename> -p lib2
+    bake ... --dot <dot filename> -p lib2,testa
+
+Which results in:
+
+.. image:: ../_static/dotP.png
+.. image:: ../_static/dotPC.png

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

@@ -8,7 +8,7 @@ Tips and Tricks
     static_code_analysis
     how_to_use_bake_with_cygwin
     the_clang
-    bundle
+    dot
 
 
 Unnecessary includes

data/documentation/_build/html/_static/syntax.html

@@ -143,7 +143,12 @@ z-index: 100;
 &nbsp; &nbsp; &nbsp; }<br>
 &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showLintPolicy()" onMouseout="notip()">LintPolicy</span> &#60;policy&#62;<br>
 &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showDocu()" onMouseout="notip()">Docu</span> &#60;cmdLine&#62;<br>
+&nbsp; &nbsp; }<br>
+&nbsp; &nbsp; <span class="help" onMouseover="showPrebuild()" onMouseout="notip()">Prebuild</span> {<br>
+&nbsp; &nbsp; &nbsp; &nbsp; <span class="help" onMouseover="showExcept()" onMouseout="notip()">Except</span> &#60;project&#62;,
+              <span class="help" onMouseover="showExceptConfig()" onMouseout="notip()">config</span>: &#60;name&#62;<br>
 &nbsp; &nbsp; }<br></span><br>
+
 </span>
 
               <span id="libExe_part"><span class="show" style="background-color:#EEEEEE;">
@@ -543,6 +548,21 @@ function flagExample() {
 	"&nbsp;&nbsp; An inherited flag string \"-abc -g3 -xy\" will end up in \"-abc -xy\"."
 }
 
+function showPrebuild() {
+  str = 'If defined, all configs of the workspace will be skipped per default. Must be actived by the commandline option "--prebuild"'
+  ddrivetip("Prebuild", "No","0..1","No project/config is skipped",str)
+}
+
+function showExcept() {
+  str = 'Defines a project which shall not be skipped. If project name is omitted, the current project is used.'
+  ddrivetip("Except", "No","0..n","Every project is skipped",str)
+}
+
+function showExceptConfig() {
+  str = 'Defines a config which shall not be skipped. If omitted, all configs of the apprpriate project are not skipped.'
+  ddrivetip("Toolchain", "No","0..1","Every config is skipped",str)
+}
+
 
 function showToolchainProject() {
   str = 'Toolchain adaptions for a project.'