bake-toolkit 2.29.4 → 2.30.0

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

@@ -1,43 +0,0 @@
-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/derive_configs.txt

@@ -1,93 +0,0 @@
-Derive configs
-==============
-
-bake supports deriving configs, which allows you to put repetetive settings in a base config.
-
-Deriving a config
-*****************
-
-Derving a config in bake is pretty straight forward, and looks like this:
-
-.. code-block:: text
-
-    ExecutableConfig A
-    LibraryConfig    B, extends: A
-    CustomConfig     C, extends: B
-    ExecutableConfig D, extends: C
-
-.. note::
-
-    The config type of the parent config does not matter, but only settings which are valid in BOTH configs will be inherited.
-    In the example above D gets the dependencies from A, because "Dependency" is valid in all configs, but D does not get
-    the "Files" from A and B, because "Files" is not valid in CustomConfig.
-
-
-Inheritance implications
-************************
-
-In general it is very easy.
-
-- Elements which can exist more than once (e.g. "Files"), are simply concatenated. First the parent elements, then the client elements.
-- Elements which can exist only once:
-
-  - if it exists in EITHER child OR parent, use this one
-  - is it exists in BOTH, attributes are merged (child attributes have high priority) and sub elements are inherited recursively
-
-The following example
-
-.. code-block:: text
-
-    ExecutableConfig A {
-      Files "x.cpp"
-      Files "y.cpp"
-      ArtifactName "z.exe"
-      DefaultToolchain GCC {
-        Linker {
-          Flags "-O3"
-        }
-      }
-    }
-    ExecutableConfig B, extends: A {
-      Files "z.cpp"
-      IncludeDir "inc"
-      ArtifactName "a.exe"
-      DefaultToolchain Diab {
-        Compiler CPP {
-          Define "TEST"
-        }
-      }
-    }
-
-results implicitly in:
-
-.. code-block:: text
-
-    ExecutableConfig B {
-      Files "x.cpp"
-      Files "y.cpp"
-      Files "z.cpp"
-      IncludeDir "inc"
-      ArtifactName "a.exe"
-      DefaultToolchain Diab {
-        Compiler CPP {
-          Define "TEST"
-        }
-        Linker {
-          Flags "-O3"
-        }
-      }
-    }
-
-
-Multiple inheritance
-********************
-
-It is possible to derive from several projects:
-
-.. code-block:: text
-
-    ExecutableConfig A
-    LibraryConfig    B
-    ExecutableConfig C, extends: "A, B"
-
-"extends" defines a comma separated list. The merge will be performed with all parent configs.

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

@@ -1,19 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-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/bakeclean.txt

@@ -1,11 +0,0 @@
-bakeclean
-*********
-
-With bakeclean you can cleanup your workspace from .bake, .bake/../build and .bake/../build_* folders.
-
-Folders are searched recursively from current working directory. Call it without any parameters to start the procedure.
-
-To preview the deleted folders, use "--preview" as argument. The filesystem will not be changed in preview mode.
-
-.. warning::
-    Folders will be deleted without any warning. They will be deleted even if they are not empty.

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

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

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

@@ -1,160 +0,0 @@
-QACPP
-*****
-
-bakeqac is a convenience wrapper for QACPP with some nice features.
-
-Without bakeqac
----------------
-
-QACPP can be called directly from command line:
-
-.. code-block:: console
-
-    qacli admin --qaf-project-config --qaf-project qacdata --cct <cct> --rcf <rcf> --acf <acf>
-    qacli analyze -P qacdata -b <bake call>
-    qacli view -P qacdata -m STDOUT
-    qacli report -P qacdata -t SUR # or -t RCR. Please also note, that the "view" is not necessary to generate the reports.
-
-- The first command creates the qac project database.
-- The second command builds and analyzes the files.
-- The third command prints out the result unfiltered.
-- The forth command generates reports. You may replace the python scripts in PRQA to adapt the output.
-
-With bakeqac
-------------
-
-Instead of writing
-
-.. code-block:: console
-
-    bake <options>
-
-for regular build, simply write:
-
-.. code-block:: console
-
-    bakeqac <options>
-
-bakeqac will automatically do the first three steps mentioned above. If one of these steps fails, the consecutive steps will be dismissed.
-
-You can also choose certain steps (can be combined with "|"):
-
-.. code-block:: console
-
-    bakeqac <options> --qacstep admin|analyze|view|report
-    bakeqac <options> --qacstep admin
-    etc.
-
-Step 1: admin
--------------
-
-You have to set the environment variable QAC_HOME, e.g. to *c:\\tools\\prqa\\PRQA-Framework-2.1.0*. If not specified otherwise, cct, rcf and acf will be automatically chosen.
-
-- Configuration compiler template (cct): Only GCC is supported. bakeqac tries to get the platform and the GCC version and calculates the path to the right cct file. To overwrite this behaviour, specify one or more ccts:
-
-  .. code-block:: console
-
-      bakeqac <options> --cct <first> --cct <second>
-
-  Alternatively, you can add
-
-  .. code-block:: console
-
-      bakeqac <options> --c++11
-      bakeqac <options> --c++14
-
-  to enforce bakeqac choosing the C++11 or C++14 toolchain.
-
-  If --cct is not used, bakeqac uses a built-in cct file as mentioned above. Additionally, it searched for a file named qac.cct up to root and appends the content to the original cct file.
-  This may be used to add additional configuration parameters which are compiler independent, e.q. "-n 1234" suppresses warning 1234.
-
-- Rule configuration file (rcf): Can be specified with:
-
-  .. code-block:: console
-
-      bakeqac <options> --rcf <rcf>
-
-  If not specified, bakeqac uses $(QAC_HOME)/config/rcf/mcpp-1_5_1-en_US.rcf.
-
-- Analysis configuration file (acf): Can be specified with:
-
-  .. code-block:: console
-
-      bakeqac <options> --acf <acf>
-
-  If not specified, $(QAC_HOME)/config/acf/default.acf will be used.
-
-- You can also specify the qacdata folder, default is *.qacdata*:
-
-  .. code-block:: console
-
-      bakeqac <options> --qacdata anotherFolder
-
-
-Step 2: analyze
----------------
-
-This is the main step. Use exactly the same options for bakeqac as for bake. A few things have to be mentioned:
-
-- *--compile-only* will be automatically added
-- *--rebuild* will be automatically added
-
-The output will be filtered per default (e.g. some warnings) . To get unfiltered output, write:
-
-.. code-block:: console
-
-    bakeqac <options> --qacnofilter
-
-Step 3: view
-------------
-
-Results are also filtered in this step if not specified otherwise:
-
-- Only results from compiled bake projects will be shown (which does not apply to e.g. compiler libraries). To narrow the results, use the *-p* option.
-- Files from subfolders test and mock will be filtered out.
-- Files from projects gtest and gmock will be filtered out.
-
-bakeqac slightly reformats the output (originally the violated MISRA rule numbers are printed out incomplete). To switch back to raw format, use:
-
-.. code-block:: console
-
-    bakeqac <options> --qacrawformat
-
-To get additional links to the appropriate documentation pages use:
-
-.. code-block:: console
-
-    bakeqac <options> --qacdoc
-
-Colored output is also supported similar to bake:
-
-.. code-block:: console
-
-    bakeqac <options> -a <color_scheme>
-
-Step 4: report
---------------
-
-Reports about the warnings and suppressed warnings are be generated.
-
-
-Additional options
-------------------
-
-QACPP needs a license. If floating licenses are not available, bakeqac can retry to checkout them:
-
-.. code-block:: console
-
-    bakeqac <options> --qacretry <seconds>
-
-Steps "analyze" and "view" are retried until timeout is reached.
-
-Notes
------
-
-If "<mainConfigName>Qac" is found in main project, it will be used instead of "<mainConfigName>. This is useful if the unit test has to be built different to MISRA.
-
-Example output
---------------
-
-.. image:: ../_static/misra.png