bake-toolkit 2.29.4 → 2.30.0

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

@@ -1,33 +0,0 @@
-bake 2.29.4
-==========================================
-bake, building software **fast** and **easy**!
-
-=======================================            =======================================
-\                                                  \
-=======================================            =======================================
-.. image:: _static/bake_tagcloud.png               **Start to bake**
-
-                                                   .. toctree::
-                                                        :maxdepth: 2
-
-                                                        why_bake/why_bake
-                                                        install/install_bake
-                                                        quickstart/quickstart
-                                                        concepts/concepts
-                                                        syntax/syntax
-                                                        commandline/commandline
-                                                        ide/ide_integrations
-                                                        tips_and_tricks/tips_and_tricks
-                                                        performance/performance
-                                                        known_issues
-                                                        changelog
-                                                        license
-
-                                                   .. toctree::
-                                                        :maxdepth: 1
-
-                                                        internal
-=======================================            =======================================
-
-
-

data/documentation/_build/html/_sources/install/install_bake.txt

@@ -1,112 +0,0 @@
-Install bake
-============
-
-bake is a `ruby gem <https://rubygems.org/>`_. It runs with `Ruby <https://www.ruby-lang.org/en/>`_ **>= 1.9**.
-bake and its depedencies can be found on `rubygems <https://rubygems.org/gems/bake-toolkit/>`_, which is configured as ruby source per default.
-
-.. attention::
-
-    The actual name of the bake gem is `bake-toolkit <https://rubygems.org/gems/bake-toolkit/>`_.
-
-How to install bake
-*******************
-Installing bake is very easy!
-
-#. Make sure you have installed `Ruby <https://www.ruby-lang.org/en/>`_ **>= 1.9**.
-
-#. Istall the bake gem.
-
-    .. code-block:: console
-
-        User@Host:~$ gem install bake-toolkit
-
-Example
--------
-
-.. code-block:: console
-
-    User@Host:~$ ruby -v                    # (Check if an apropriate ruby version is installed)
-    ruby 2.1.2p95 (2014-05-08 revision 45877) [x86_64-darwin13.0]
-
-    User@Host:~$ gem install bake-toolkit   # (Install the bake gem)
-    Fetching: highline-1.6.15.gem (100%)
-    Fetching: colored-1.2.gem (100%)
-    Fetching: progressbar-0.11.0.gem (100%)
-    Fetching: rgen-0.6.0.gem (100%)
-    Fetching: rtext-0.2.0.gem (100%)
-    Fetching: bake-toolkit-1.0.2.gem (100%)
-    Successfully installed highline-1.6.15
-    Successfully installed colored-1.2
-    Successfully installed progressbar-0.11.0
-    Successfully installed rgen-0.6.0
-    Successfully installed rtext-0.2.0
-    Successfully installed bake-toolkit-1.0.2
-    7 gems installed
-    Installing ri documentation for highline-1.6.15...
-    Installing ri documentation for colored-1.2...
-    Installing ri documentation for progressbar-0.11.0...
-    Installing ri documentation for rgen-0.6.0...
-    Installing ri documentation for rtext-0.2.0...
-    Installing ri documentation for bake-toolkit-1.0.2...
-    Installing RDoc documentation for highline-1.6.15...
-    Installing RDoc documentation for colored-1.2...
-    Installing RDoc documentation for progressbar-0.11.0...
-    Installing RDoc documentation for rgen-0.6.0...
-    Installing RDoc documentation for rtext-0.2.0...
-    Installing RDoc documentation for bake-toolkit-1.0.2...
-
-
-Known Issues
-************
-
-The installation does not start
--------------------------------
-**Issue:**
-The installation of the bake gem does not start.
-(This is often caused by a password protected internat proxy.)
-
-
-**Solution:**
-
-* Check your network connection.
-* Unlock the password protected proxy by opening an external webpage (e.g. `google <https://www.google.com>`_) using your web browser.
-
-
-Invalid Language Settings
--------------------------
-*Issue:**
-The error parsers in bake assume English language.
-
-**Solution:**
-
-Adjust your language settings e.g by setting the environment variable **LC_ALL**.
-
-Example:
-
-    ..  code-block:: console
-
-        LC_ALL=en_US
-
-.. note::
-
-    Depending on the system and the compiler the way how to change the language might be different.
-
-Error Message During the installation
--------------------------------------
-**Issue:**
-Ruby throws an error during the installation.
-
-**Solution:**
-Usualy you will see an error like this:
-
-    .. code-block:: console
-
-        ERROR:  While generating documentation for ...
-        ... MESSAGE:   Error while evaluating ...
-           undefined method `gsub' for nil:NilClass ...
-
-This is a ruby bug. However, the gems were installed correctly. You can avoid building the documentation by installing bake like this:
-
-    .. code-block:: console
-
-        User@Host:~$ gem install bake-toolkit --no-rdoc --no-ri

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

@@ -1,50 +0,0 @@
-Internal developing notes
-*************************
-
-Socket
-======
-
-If command line option --socket is used, bake tries to connect to the given port on localhost.
-
-send
-----
-
-Header
-^^^^^^
-
-    .. code-block:: console
-
-        1 Byte: Type
-        4 Byte: Length (used to discard the paket if type is unknown to the listening application)
-
-Error packet (type 0x01)
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-    .. code-block:: console
-
-        4 Byte: Length filename, project name
-        x Byte: filename, project name
-        4 Byte: line number (can be 0)
-        1 Byte: severity (0x00 = info, 0x01 = warning, 0x02 = error, 0xFF = ok)
-        x Byte: message (length = rest of packet)
-
-Starting build packet (type 0x0A)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-    .. code-block:: console
-
-        4 Byte: Length project name
-        x Byte: project name
-        4 Byte: Length config name
-        x Byte: config name
-        4 Byte: number of projects in this build (greater than 0)
-
-Building project packet
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Same as Starting build packet, except number of projects = 0
-
-receive
--------
-
-If a byte is received, the build will be aborted.

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

@@ -1,7 +0,0 @@
-Known Issues
-============
-
-* Issue: If an archive or executable has been built successfully and one source file will be deleted without changing anything else, bake will leave the archive/executable unchanged when rebuilding.
-    * Workaround 1: Clean the project.
-    * Workaround 2: Delete the archive/executable manually.
-    * Workaround 3: Touch, edit, create another source file.

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

@@ -1,4 +0,0 @@
-License
-=======
-
-.. include:: ../license.txt

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

@@ -1,104 +0,0 @@
-Performance
-===========
-
-Eclipse vs. bake
-****************
-
-Test Environement
------------------
-=====================       ==============   ================================================================
-Test-System                 *CPU:*           Intel Xeon W3520 (4x 2.67 GHz)
-
-                            *RAM:*           4 GB
-
-                            *OS :*           Windows XP
-
-                            *HDD:*           Raid
-
-Test-Application            ~200 projects
----------------------       ---------------------------------------------------------------------------------
-Ruby-Version                ruby 1.9.2
----------------------       ---------------------------------------------------------------------------------
-Tests-Runs                  30
-=====================       ==============   ================================================================
-
-Test Results
-------------
-
-=================================       =================================       =====================================
-Test                                    Eclipse 3.6.1, CDT 6                    bake
-=================================       =================================       =====================================
-Build whole workspace                   13:01 min                               7:19 min
-
-Rebuild without clean                   3:05 min                                0:50 min
-
-Clean whole workspace                   0:41 min                                0:08 min
-
-Clean the cleaned workspace             0:35 min                                0:02 min
-=================================       =================================       =====================================
-
-.. note::
-    For the build `Eclipse` needs additional `300 MB of RAM`, in contrast `bake` takes up `35 MB` of RAM at it's peak.
-
-CMake with Unix makefiles vs. bake
-**********************************
-
-Test Environement
------------------
-=====================       ==============   ================================================================
-Test-System                 *CPU:*           Intel Xeon W3520 (4x 2.67 GHz)
-
-                            *RAM:*           4 GB
-
-                            *OS :*           Windows XP
-
-                            *HDD:*           Raid
-
-Test-Application            ~100 projects
----------------------       ---------------------------------------------------------------------------------
-Ruby-Version                \-
----------------------       ---------------------------------------------------------------------------------
-Tests-Runs                  \-
-=====================       ==============   ================================================================
-
-Test Results
-------------
-
-* Build whole workspace: bake is `~10%` faster
-* Build again without clean: bake is `~50%` faster
-* Clean whole workspace: bake is `~80%` faster
-
-
-Performance using different rubies
-**********************************
-
-Test Environement
------------------
-=====================       ==============   ================================================================
-Test-System                 *CPU:*           Intel Xeon W3520 (4x 2.67 GHz)
-
-                            *RAM:*           4 GB
-
-                            *OS :*           Windows XP
-
-                            *HDD:*           Raid
-
-Test-Application            ~200 projects
----------------------       ---------------------------------------------------------------------------------
-Tests-Runs                  30
-=====================       ==============   ================================================================
-
-Test Results
-------------
-
-=====================   ==================  ==================  ==================  ==================
-\                       ruby 1.8.6p398      ruby 1.8.7p352      ruby 1.9.2p180      ruby 1.9.3p0
-=====================   ==================  ==================  ==================  ==================
-Build whole workspace   13:58 min           8:07 min            7:19 min            7:28 min
-
-Build single file       1,20 sec            1,87 sec            2,38 sec            1,29 sec
-=====================   ==================  ==================  ==================  ==================
-
-.. note::
-    * ruby 1.8.6 uses only ONE native thread for multiple ruby threads.
-    * ruby 1.9.2 for Windows needs very long to startup for complex applications, which is fixed in 1.9.3

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

@@ -1,70 +0,0 @@
-Quickstart
-==========
-
-#. Create a project directory.
-    .. code-block:: console
-
-        User@Host:~$ mkdir my_project
-
-
-#. Switch to the project directory.
-    .. code-block:: console
-
-        User@Host:~$ cd my_project
-
-
-#. Use the bake --create option to auto generate a basic project.
-    .. code-block:: console
-
-        User@Host:~/my_project$ bake --create exe
-        -- bake 2.10.3, ruby 2.1.2p95, platform x86_64-darwin13.0 --
-        Project created.
-
-        Time: 00:00 minutes
-
-    This will provide you with the follwing basic project structure which is ready to use
-
-    .. code-block:: console
-
-       my_project
-       |
-       |-- Project.meta
-       |-- include
-       `-- src
-            `-- main.cpp
-
-
-#. Build the project.
-    .. code-block:: console
-
-        User@Host:~/my_project$ bake
-        -- bake 2.10.3, ruby 2.1.2p95, platform x86_64-darwin13.0 --
-        Info: cache not found, reloading meta information
-        Loading /Users/NiCoretti/my_project/Project.meta
-        **** Building 1 of 1: my_project (main) ****
-        Compiling src/main.cpp
-        Linking build/main/my_project.exe
-
-        Building done.
-
-        Time: 00:00 minutes
-
-    If you want a more detailed and colored output use the following command:
-
-    .. code-block:: console
-
-        User@Host:~/my_project$ bake -v2 -a black
-        -- bake 2.10.3, ruby 2.1.2p95, platform x86_64-darwin13.0 --
-        **** Building 1 of 1: my_project (main) ****
-
-        g++ -c -MD -MF build/main/src/main.d -Iinclude -o build/main/src/main.o src/main.cpp
-
-        g++ -o build/main/my_project.exe build/main/src/main.o
-
-        Building done.
-
-        Time: 00:00 minutes
-
-    .. note::
-        The default main.cpp which is created by bake does nothing except returning the exit code 0.
-

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

@@ -1,254 +0,0 @@
-.. _adapt_reference:
-
-Adapt configs
-=============
-
-Introduction
-------------
-
-There are two major use cases:
-
-- Changing the configs from outside, e.g. injecting a toolchain.
-- Changing the configs depending on variables like the operating system.
-
-Both is possible with the *Adapt* feature.
-
-From command line
------------------
-
-If you want to manipulate existing configs without changing them, you can "adapt" them via command line.
-
-.. code-block:: console
-
-    User@Host:~$ bake test --adapt abc
-
-bake searches for abc/Adapt.meta within the workspace roots. If found, the configs from the Adapt.meta are parsed:
-
-.. code-block:: text
-
-    Adapt {
-      ExecutableConfig ... # 0..n
-      LibraryConfig ... # 0..n
-      CustomConfig ... # 0..n
-    }
-
-Here is an example to change the DefaultToolchain (details explained below):
-
-.. code-block:: text
-
-    Adapt {
-      ExecutableConfig test, project: __MAIN__, type: replace {
-        DefaultToolchain GCC
-      }
-    }
-
-From Project.meta
------------------
-
-You can do the same within the Project.meta:
-
-.. code-block:: text
-
-    Project {
-      ...
-    }
-    Adapt {
-      ...
-    }
-    Adapt {
-      ...
-    }
-
-Conditions and effectiveness
-----------------------------
-
-Be aware, these are two different things but look very similar.
-
-Condition
-~~~~~~~~~
-
-An *Adapt* can have up to four attributes:
-
-- **toolchain**: e.g. GCC
-- **os**: can be Windows, Mac, Linux, Unix (which is != Linux)
-- **mainConfig**: name of the main config
-- **mainProject**: name of the main project
-
-The "Adapt* configs will be only applied if all these attributes are either empty or true. Example:
-
-.. code-block:: text
-
-    Adapt toolchain: GCC, os: Windows {
-      ...
-    }
-
-Here the *Adapt* configs will be applied if toolchain is GCC on Windows.
-
-Effectiveness
-~~~~~~~~~~~~~
-
-The *Adapt* configs can be applied to all configs from regular build. This can be controlled by the config names and the project attributes.
-Remember the example from the beginning?
-
-.. code-block:: text
-
-    Adapt {
-      ExecutableConfig test, project: __MAIN__, type: replace {
-        DefaultToolchain GCC
-      }
-    }
-
-This config is applied only to the config "test" of the main project.
-
-__MAIN__, __ALL__ and __THIS__ are keywords:
-
-- **__MAIN__** means the main project or main config
-- **__ALL__** means all projects or configs
-- **__THIS__** is only valid for project name, which can be used for *Adapts* within a Project.meta to restrict the adaption to the current project.
-
-If you want to apply the changes only to the top level config, write:
-
-.. code-block:: text
-
-      ExecutableConfig __MAIN__, project: __MAIN__, ...
-
-If you want to apply the changes to all configs, write:
-
-.. code-block:: text
-
-      ExecutableConfig __ALL__, project: __ALL__, ...
-
-It is possible to mix the keywords with reals project or config names.
-
-Occurrences
------------
-
-You can specify more configs in one *Adapt* and you can specify more than one Adapt.meta file:
-
-.. code-block:: text
-
-    Adapt {
-      ExecutableConfig ..., project: ..., type: ... {
-        ...
-      }
-      ExecutableConfig ..., project: ..., type: ... {
-        ...
-      }
-      LibraryConfig ..., project: ..., type: ... {
-        ...
-      }
-      ...
-    }
-
-.. code-block:: console
-
-    User@Host:~$ bake test --adapt abc --adapt xy
-
-Apply order
------------
-
-The *Adapt* configs will be applied in the order in which they were parsed. First the Adapt.metas referenced from the command line are read. Then the Project.metas are read
-one by one as usual. If an *Adapt* is found, it will be appended to the list of *Adapts*. Note, *Adapts* will be applied immediately when a Project.meta is read.
-
-If you inject a Toolchain from outside, e.g. "--adapt gcc", you can use the toolchain info for local *Adapts*:
-
-.. code-block:: text
-
-    Project {
-      ...
-    }
-    Adapt toolchain: GCC {
-      ...
-    }
-
-Types
------
-
-It is possible to specify the type of adaption:
-
-.. code-block:: text
-
-      ExecutableConfig ..., type: replace
-
-The type can be
-
-- **replace**
-- **remove**
-- **extend**
-
-Type: extend
-~~~~~~~~~~~~
-
-This works exactly like for :doc:`derive_configs`.
-
-Type: remove
-~~~~~~~~~~~~
-
-If parent elements can be found which matches to the child elements, they will be removed.
-
-Example project config:
-
-.. code-block:: text
-
-    ExecutableConfig test {
-      DefaultToolchain GCC
-    }
-
-Example *Adapt* configs:
-
-.. code-block:: text
-
-    ExecutableConfig __ALL__, project: __ALL__, type: remove {
-      DefaultToolchain # remove ok
-    }
-
-    ExecutableConfig __ALL__, project: __ALL__, type: remove {
-      DefaultToolchain GCC # remove ok
-    }
-
-    ExecutableConfig __ALL__, project: __ALL__, type: remove {
-      DefaultToolchain Diab # remove NOT ok
-    }
-
-    ExecutableConfig __ALL__, project: __ALL__, type: remove {
-      DefaultToolchain GCC, eclipseOrder: true # remove NOT ok
-    }
-
-Type: replace
-~~~~~~~~~~~~~
-
-This is for convenience. "replace" will remove all elements with the same type and extends the configs.
-
-Example:
-
-.. code-block:: text
-
-    ExecutableConfig __ALL__, project: __ALL__, type: replace {
-      Files "*.cpp"
-      DefaultToolchain GCC {
-        Linker command: "link.exe"
-      }
-    }
-
-This removes all "Files" and the "DefaultToolchain" from the original config regardless their attributes and replaces them by the elements of the *Adapt* config.
-
-Wildcards
----------
-
-The "*" wildcard is allowed:
-
-.. code-block:: text
-
-    Adapt mainProject: HERE, mainConfig: HERE ... {
-      SomeConfig HERE, project: HERE ... {
-        ....
-      }
-    }
-
-Example (the configs of the Adapt are applied if the main config name starts with "UnitTest"):
-
-.. code-block:: text
-
-    Adapt mainConfig: "UnitTest*" {
-      ...
-    }