bake-toolkit 2.20.4 → 2.21.0

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

@@ -1,19 +1,19 @@
-The Syntax of the Project.meta file
-===================================
-
-Instructions for the Interactive Syntax Viewer
-**********************************************
-
-* Move the mouse cursor over the blue elements to display more information.
-
-* Three config types exist: ExecutableConfig, LibraryConfig and CustomConfig. Move the mouse cursor over these elements to display the supported content.
-
-.. raw:: html
-    :file: ../_static/syntax.html
-
-.. note::
-    Specify the paths always relative to the current project root, but keep the variable substitution in Project.meta in mind.
-    
-    * Use double quotes (") if the strings have spaces or slashes.
-
-    * Use hash marks (#) for comments.
+The Syntax of the Project.meta file
+===================================
+
+Instructions for the Interactive Syntax Viewer
+**********************************************
+
+* Move the mouse cursor over the blue elements to display more information.
+
+* Three config types exist: ExecutableConfig, LibraryConfig and CustomConfig. Move the mouse cursor over these elements to display the supported content.
+
+.. raw:: html
+    :file: ../_static/syntax.html
+
+.. note::
+    Specify the paths always relative to the current project root, but keep the variable substitution in Project.meta in mind.
+
+    * Use double quotes (") if the strings have spaces or slashes.
+
+    * Use hash marks (#) for comments.

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

@@ -1,11 +1,11 @@
-Syntax
-==========
-
-.. toctree::
-    :maxdepth: 2
-
-    project_meta_syntax
-    variable_substitutions
-    derive_configs
-    adapt_configs
-    auto_adjustment
+Syntax
+==========
+
+.. toctree::
+    :maxdepth: 2
+
+    project_meta_syntax
+    variable_substitutions
+    derive_configs
+    adapt_configs
+    auto_adjustment

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

@@ -1,148 +1,148 @@
-Variables in Project.meta
-=========================
-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
-
-   $(ABC)
-
-The variable ABC will be substituted by its value, therefore a real life usage would look
-something like this:
-
-.. code-block:: console
-
-   IncludeDir "$(ABC)"
-
-User defined variables
-**********************
-
-There are two ways to create user defined variables.
-
-#. The variable is defined with the `--set` command line option:
-
-.. code-block:: console
-
-    User@Host:~$ bake ... --set MyVar="Hello world!"
-
-#. THe variable is defined directly in the Project.meta file.
-
-.. 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.
-
-Predefined bake environment variables
-*************************************
-
-========================================    ===============================================     ========================================
-Variable                                    Description                                         Example
-========================================    ===============================================     ========================================
-*$(MainConfigName)*                         Evaluates to the main config name                   Debug
-
-*$(MainProjectName)*                        Evaluates to the main project name                  bootloader
-
-*$(ConfigName)*                             Evaluates to the config name                        lib
-
-*$(ProjectName)*                            Evaluates to the project name                       canDriver
-
-*$(ProjectDir)*                             Evaluates to the full path of the project           C:/Root/MyProject
-                                            directory
-
-*$(MainProjectDir)*                         Evaluates to the full path of the root projec       C:/Root/Main
-                                            directory
-
-*$(OutputDir)*                              Evaluates to the full path of the output            build/lib_bootloader_Debug
-                                            directory of the current config
-
-*$(OutputDir,projName,confName)*            Evaluates to the output dir of a specific           build/lib_some_Debug
-                                            config
-
-*$(ArtifactName)*                           Evaluates to the artifact.                          bootloader_1.0.elf
-
-*$(ArtifactNameBase)*                       Evaluates to the base artifact name                 bootloader_1.0
-                                            (Without file exension)
-
-*$(Time)*                                   Evaluates to the current time                       2012-12-24 20:00:00 +0200
-
-*$(Hostname)*                               Evaluates to the hostname                           MY_COMPUTER
-
-*$(CPPPath)*                                Evaluates to the base path of the                   /usr/bin
-                                            c++ compiler
-
-*$(CPath)*                                  Evaluates to the base path of the                   /usr/bin
-                                            c compiler
-
-*$(ASMPath)*                                Evaluates to the base path of the                   /usr/bin
-                                            assembler
-
-*$(ArchiverPath)*                           Evaluates to the base path of the                   /usr/bin
-                                            archiver
-
-*$(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
-
-*$(:)*                                      Evaluates to the path variable seperator            Windows: ;, Other: :
-                                            of the current platform
-========================================    ===============================================     ========================================
-
-Environment variables
-*********************
-
-Usually used if system dependent stuff is needed like path to a specific tool etc.
-
-Nested variables
-****************
-It is also possible to nest variables.
-
-Example:
-
-.. code-block:: console
-
-    $(ABC$(DEF)GH)
-
-
-Complex variables
-*****************
-
-bake supports one complex variable:
-
-.. code-block:: console
-
-    $(OutputDir,$(TheProject),$(TheConfig))
-
-This will evaluate to the output directory of a specific configuration.
-
-Notes and warnings
-******************
-
-Equal variables in the main config:
-
-========================================    ========================================
-Variable                                    Is equal to
-========================================    ========================================
-$(MainConfigName)                           $(ConfigName)
-
-$(MainProjectName)                          $(ProjectName)
-========================================    ========================================
-
-.. warning::
-
+Variables in Project.meta
+=========================
+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
+
+   $(ABC)
+
+The variable ABC will be substituted by its value, therefore a real life usage would look
+something like this:
+
+.. code-block:: console
+
+   IncludeDir "$(ABC)"
+
+User defined variables
+**********************
+
+There are two ways to create user defined variables.
+
+#. The variable is defined with the `--set` command line option:
+
+.. code-block:: console
+
+    User@Host:~$ bake ... --set MyVar="Hello world!"
+
+#. THe variable is defined directly in the Project.meta file.
+
+.. 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.
+
+Predefined bake environment variables
+*************************************
+
+========================================    ===============================================     ========================================
+Variable                                    Description                                         Example
+========================================    ===============================================     ========================================
+*$(MainConfigName)*                         Evaluates to the main config name                   Debug
+
+*$(MainProjectName)*                        Evaluates to the main project name                  bootloader
+
+*$(ConfigName)*                             Evaluates to the config name                        lib
+
+*$(ProjectName)*                            Evaluates to the project name                       canDriver
+
+*$(ProjectDir)*                             Evaluates to the full path of the project           C:/Root/MyProject
+                                            directory
+
+*$(MainProjectDir)*                         Evaluates to the full path of the root projec       C:/Root/Main
+                                            directory
+
+*$(OutputDir)*                              Evaluates to the full path of the output            build/lib_bootloader_Debug
+                                            directory of the current config
+
+*$(OutputDir,projName,confName)*            Evaluates to the output dir of a specific           build/lib_some_Debug
+                                            config
+
+*$(ArtifactName)*                           Evaluates to the artifact.                          bootloader_1.0.elf
+
+*$(ArtifactNameBase)*                       Evaluates to the base artifact name                 bootloader_1.0
+                                            (Without file exension)
+
+*$(Time)*                                   Evaluates to the current time                       2012-12-24 20:00:00 +0200
+
+*$(Hostname)*                               Evaluates to the hostname                           MY_COMPUTER
+
+*$(CPPPath)*                                Evaluates to the base path of the                   /usr/bin
+                                            c++ compiler
+
+*$(CPath)*                                  Evaluates to the base path of the                   /usr/bin
+                                            c compiler
+
+*$(ASMPath)*                                Evaluates to the base path of the                   /usr/bin
+                                            assembler
+
+*$(ArchiverPath)*                           Evaluates to the base path of the                   /usr/bin
+                                            archiver
+
+*$(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
+
+*$(:)*                                      Evaluates to the path variable seperator            Windows: ;, Other: :
+                                            of the current platform
+========================================    ===============================================     ========================================
+
+Environment variables
+*********************
+
+Usually used if system dependent stuff is needed like path to a specific tool etc.
+
+Nested variables
+****************
+It is also possible to nest variables.
+
+Example:
+
+.. code-block:: console
+
+    $(ABC$(DEF)GH)
+
+
+Complex variables
+*****************
+
+bake supports one complex variable:
+
+.. code-block:: console
+
+    $(OutputDir,$(TheProject),$(TheConfig))
+
+This will evaluate to the output directory of a specific configuration.
+
+Notes and warnings
+******************
+
+Equal variables in the main config:
+
+========================================    ========================================
+Variable                                    Is equal to
+========================================    ========================================
+$(MainConfigName)                           $(ConfigName)
+
+$(MainProjectName)                          $(ProjectName)
+========================================    ========================================
+
+.. warning::
+
     Variables in Dependency definitions are not allowed!

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

@@ -1,34 +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
+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/how_to_use_bake_with_cygwin.txt

@@ -1,62 +1,62 @@
-How to use bake with cygwin
-===========================
-Why using Cygwin on Windows instead of the built-in command shell?
-There is one major reason: Cygwin supports **colored output** via ansi escape sequences.
-Note, that these steps differ depending on the Cygwin version, installed packages and configuration.
-
-#. Get rid of the cygdrive prefix
-
-    .. image:: ../_static/cygwin_mount.png
-        :width: 100 %
-        :scale: 50 %
-
-    As you see, "c:" is now "/c" and not "/cygdrive/c" anymore.
-
-    .. note::
-
-        In newer Cygwin versions, this is not permanent. To make it permanent,
-        add the following line to /etc/fstab (can be found in your Cygwin installation directory):
-
-        .. code-block:: console
-
-            none / cygdrive binary,posix=0,user 0 0
-
-#. Get rid of the Cygwin ruby
-
-    .. image:: ../_static/cygwin_ruby.png
-        :width: 100 %
-        :scale: 50 %
-
-    Easiest way is to rename the Cygwin ruby, which makes the original ruby visible.
-    This is only necessary if you have ruby installed in our Cygwin environment.
-
-#. Add tty to CYGWIN option
-
-    .. image:: ../_static/cygwin_tty.png
-        :width: 100 %
-        :scale: 70 %
-
-    "tty" must be added to the CYGWIN system variable.
-
-#. Switch to raw mode
-
-    The ctrl-c handler in Cygwin only works for programs compiled with the correct Cygwin libs. This does not apply to
-    most ruby installations. Hitting ctrl-c may interrupt the compiler, but bake does not get this signal.
-
-    You can set the Cygwin console to raw mode:
-
-    .. code-block:: console
-
-        stty raw
-
-    Now bake can read ctrl-c as raw character on stdin. Bake will abort after all subprocesses - like the running compilation steps - have returned.
-
-#. Start the build
-
-    Use the parameter "-a black" or "-a white" depending on the background color of your shell.
-    Depending on your Cygwin installation, you have to call "bake.bat" instead of "bake". To avoid this, create an alias, e.g:
-
-    .. code-block:: console
-
-        alias bake=/c/Programme/_dev/Ruby192/bin/bake.bat
-
+How to use bake with cygwin
+===========================
+Why using Cygwin on Windows instead of the built-in command shell?
+There is one major reason: Cygwin supports **colored output** via ansi escape sequences.
+Note, that these steps differ depending on the Cygwin version, installed packages and configuration.
+
+#. Get rid of the cygdrive prefix
+
+    .. image:: ../_static/cygwin_mount.png
+        :width: 100 %
+        :scale: 50 %
+
+    As you see, "c:" is now "/c" and not "/cygdrive/c" anymore.
+
+    .. note::
+
+        In newer Cygwin versions, this is not permanent. To make it permanent,
+        add the following line to /etc/fstab (can be found in your Cygwin installation directory):
+
+        .. code-block:: console
+
+            none / cygdrive binary,posix=0,user 0 0
+
+#. Get rid of the Cygwin ruby
+
+    .. image:: ../_static/cygwin_ruby.png
+        :width: 100 %
+        :scale: 50 %
+
+    Easiest way is to rename the Cygwin ruby, which makes the original ruby visible.
+    This is only necessary if you have ruby installed in our Cygwin environment.
+
+#. Add tty to CYGWIN option
+
+    .. image:: ../_static/cygwin_tty.png
+        :width: 100 %
+        :scale: 70 %
+
+    "tty" must be added to the CYGWIN system variable.
+
+#. Switch to raw mode
+
+    The ctrl-c handler in Cygwin only works for programs compiled with the correct Cygwin libs. This does not apply to
+    most ruby installations. Hitting ctrl-c may interrupt the compiler, but bake does not get this signal.
+
+    You can set the Cygwin console to raw mode:
+
+    .. code-block:: console
+
+        stty raw
+
+    Now bake can read ctrl-c as raw character on stdin. Bake will abort after all subprocesses - like the running compilation steps - have returned.
+
+#. Start the build
+
+    Use the parameter "-a black" or "-a white" depending on the background color of your shell.
+    Depending on your Cygwin installation, you have to call "bake.bat" instead of "bake". To avoid this, create an alias, e.g:
+
+    .. code-block:: console
+
+        alias bake=/c/Programme/_dev/Ruby192/bin/bake.bat
+