bake-toolkit 2.20.4 → 2.21.0

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

@@ -1,122 +1,122 @@
-Static Code Analysis
-====================
-
-Static code analysis often is part or a pre step of the build, even though bake provides presteps which can be used to 
-add customized steps, we choose to add explicit support for static code analysis due to the fact that the analysis often
-depends on information well known by the build system (include pahts, compiler flags, etc.). Currently bake has  built in
-support for *Pc-Lint*. 
-
-Lint
-****
-
-With bake you can lint LibraryConfigs, ExecutableConfigs, single files and the complete workspace (in this case the projects are linted separately). 
-The CPP Toolchain settings of the project are used regardless of the file type and file specific options. 
-It is possible to specify lnt-files with LintPolicy, but you can add every other lint command line option as well.
-
-Basic Setup
------------
-
-#. Install `lint  <http://www.gimpel.com/html/products.htm>`_.
-#. Make sure the The lint executable 'lint-nt.exe' is in the path.
-
-.. attention::
-
-    even though there is a unix version of pc-lint the asscoated binary name must be lint-nt.exe otherwise
-    it won't be recorgnized by the bake build system.
-
-After doing this steps you are able to lint your build configurations (LibraryConfigs and ExecutableConfigs) using the *--lint* flag on the command line.
-
-Example
-+++++++
-.. code-block:: console
-
-    User@Host:~$ bake Debug -p MyLibraryProject --lint
-
-
-Configuring Lint
-----------------
-
-In order to configure lint in the Project.meta file, just use the *LintPolicy* command, which forwards the supplied
-the parameters to lint.
-
-.. code-block:: text
-
-    DefaultToolchain GCC {
-        ...
-        LintPolicy "$(ProjectDir)/lint/misra.lnt"
-        LintPolicy "$(ProjectDir)/lint/suppressions.lnt"
-    }
-
-Example
-+++++++
-
-This example shows how to redirect the output to single xml files placed into the main project folder.
-
-.. code-block:: text
-
-    DefaultToolchain GCC {
-        LintPolicy "-os($(MainProjectDir)/$(ProjectName)_$(ConfigName)_lintout.xml)"
-        LintPolicy "-v"
-        LintPolicy "+xml(doc)"
-        LintPolicy "-format=%f %l %t %n %m"
-        LintPolicy "-format_specific= "
-        LintPolicy "-pragma(message)"
-        ...
-    }
-
-
-Known Issues
-------------
-bake only searches for lint-nt.exe
-+++++++++++++++++++++++++++++++++++
-    **Issue:**
-    bake currently does not search for all possible names of the lint application, it only searches for a file called *lint-nt.exe*.
-
-    **Solution:**
-    If you have another lint command (e.g. because you are using flexe lint on unix)
-    just create an symlink/alias which is called *lint-nt.exe*.
-
-Lint fails due to missing compiler includes and defines 
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++
-    **Issue:**
-    Lint will fail if compiler internal includes and defines are missing. 
-
-    **Solution:**
-       
-    Lint comes with some helper files, handle this issue. In order to get a list of all needed
-    helper files e.g. for GCC, use the following command. 
-
-    .. code-block:: console
-
-        User@Host:~$ make -f .../PcLint/../lnt/co-gcc.mak
-
-    You will get a output like this:
-
-    .. code-block:: text
-
-        gcc-include-path.lnt, lint_cmac.h, lint_cppmac.h and size-options.lnt.
-
-    You can now add the needed includes and LintPolicies (.lnt files) to your bake 
-    configuration.
-
-Lint error due to too many includes
-+++++++++++++++++++++++++++++++++++
-
-    **Issue:**
-    In rare cases lint has problems if it has to open too many (include) files. 
-
-    **Solution:**
-    You can use the *--lint-max* and the *--lint-min* options to get around this issue.
-
-    Example:
-
-    .. code-block:: console
-
-        User@Host:~$ bake Debug -p MyLibraryProject --lint --lint-max 50                 #(lints the first 51 files)
-        User@Host:~$ bake Debug -p MyLibraryProject --lint --lint-min 51 --lint-max 100  #(lints the next 50 files)
-        User@Host:~$ bake Debug -p MyLibraryProject --lint --lint-min 101                #(lints the rest of the files)
-
-
-.. Clang Analyze
-.. *************
-
+Static Code Analysis
+====================
+
+Static code analysis often is part or a pre step of the build, even though bake provides presteps which can be used to
+add customized steps, we choose to add explicit support for static code analysis due to the fact that the analysis often
+depends on information well known by the build system (include pahts, compiler flags, etc.). Currently bake has  built in
+support for *Pc-Lint*.
+
+Lint
+****
+
+With bake you can lint LibraryConfigs, ExecutableConfigs, single files and the complete workspace (in this case the projects are linted separately).
+The CPP Toolchain settings of the project are used regardless of the file type and file specific options.
+It is possible to specify lnt-files with LintPolicy, but you can add every other lint command line option as well.
+
+Basic Setup
+-----------
+
+#. Install `lint  <http://www.gimpel.com/html/products.htm>`_.
+#. Make sure the The lint executable 'lint-nt.exe' is in the path.
+
+.. attention::
+
+    even though there is a unix version of pc-lint the asscoated binary name must be lint-nt.exe otherwise
+    it won't be recorgnized by the bake build system.
+
+After doing this steps you are able to lint your build configurations (LibraryConfigs and ExecutableConfigs) using the *--lint* flag on the command line.
+
+Example
++++++++
+.. code-block:: console
+
+    User@Host:~$ bake Debug -p MyLibraryProject --lint
+
+
+Configuring Lint
+----------------
+
+In order to configure lint in the Project.meta file, just use the *LintPolicy* command, which forwards the supplied
+the parameters to lint.
+
+.. code-block:: text
+
+    DefaultToolchain GCC {
+        ...
+        LintPolicy "$(ProjectDir)/lint/misra.lnt"
+        LintPolicy "$(ProjectDir)/lint/suppressions.lnt"
+    }
+
+Example
++++++++
+
+This example shows how to redirect the output to single xml files placed into the main project folder.
+
+.. code-block:: text
+
+    DefaultToolchain GCC {
+        LintPolicy "-os($(MainProjectDir)/$(ProjectName)_$(ConfigName)_lintout.xml)"
+        LintPolicy "-v"
+        LintPolicy "+xml(doc)"
+        LintPolicy "-format=%f %l %t %n %m"
+        LintPolicy "-format_specific= "
+        LintPolicy "-pragma(message)"
+        ...
+    }
+
+
+Known Issues
+------------
+bake only searches for lint-nt.exe
++++++++++++++++++++++++++++++++++++
+    **Issue:**
+    bake currently does not search for all possible names of the lint application, it only searches for a file called *lint-nt.exe*.
+
+    **Solution:**
+    If you have another lint command (e.g. because you are using flexe lint on unix)
+    just create an symlink/alias which is called *lint-nt.exe*.
+
+Lint fails due to missing compiler includes and defines
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+    **Issue:**
+    Lint will fail if compiler internal includes and defines are missing.
+
+    **Solution:**
+
+    Lint comes with some helper files, handle this issue. In order to get a list of all needed
+    helper files e.g. for GCC, use the following command.
+
+    .. code-block:: console
+
+        User@Host:~$ make -f .../PcLint/../lnt/co-gcc.mak
+
+    You will get a output like this:
+
+    .. code-block:: text
+
+        gcc-include-path.lnt, lint_cmac.h, lint_cppmac.h and size-options.lnt.
+
+    You can now add the needed includes and LintPolicies (.lnt files) to your bake
+    configuration.
+
+Lint error due to too many includes
++++++++++++++++++++++++++++++++++++
+
+    **Issue:**
+    In rare cases lint has problems if it has to open too many (include) files.
+
+    **Solution:**
+    You can use the *--lint-max* and the *--lint-min* options to get around this issue.
+
+    Example:
+
+    .. code-block:: console
+
+        User@Host:~$ bake Debug -p MyLibraryProject --lint --lint-max 50                 #(lints the first 51 files)
+        User@Host:~$ bake Debug -p MyLibraryProject --lint --lint-min 51 --lint-max 100  #(lints the next 50 files)
+        User@Host:~$ bake Debug -p MyLibraryProject --lint --lint-min 101                #(lints the rest of the files)
+
+
+.. Clang Analyze
+.. *************
+

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

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