bake-toolkit 2.20.4 → 2.21.0

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

@@ -1,50 +1,50 @@
-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.
+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,9 +1,9 @@
-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.
-
-* Issue: Lint output not shown during linting (has to be refactored)
+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.
+
+* Issue: Lint output not shown during linting (has to be refactored)

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

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

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

@@ -1,104 +1,104 @@
-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
+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 +1,70 @@
-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.
-
+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.
+