bake-toolkit 2.11.2 → 2.11.3

data/documentation/_build/html/_sources/ide/vs/how_to_used_bake_in_vs.txt

@@ -0,0 +1,35 @@
+How to use bake in Visual Studio
+================================
+
+#. Select a build configuration of the main project
+
+    Right click on the main project and select a bake build configuration. 
+
+    .. image:: ../../_static/vs_select_config.png
+        :width: 100 %
+        :scale: 50 %
+
+    .. note::
+
+        Only configurations with a DefaultToolchain will be displayed.
+
+#. You can see the selected config in the last line of the Build menu.
+
+    .. image:: ../../_static/vs_show_config.png
+        :width: 100 %
+        :scale: 50 %
+
+    If you click on this menu item, you can deselect the build config, which disables bake as long as no other config will be selected.
+
+#. You can specify additional command line parameters via the Options menu.
+
+    .. image:: ../../_static/vs_options.png
+        :width: 100 %
+        :scale: 50 %
+
+#. The build result will be shown in the Output window, errors will be shown in the Error window and annotated in the sources.
+
+    .. image:: ../../_static/vs_error.png
+        :width: 100 %
+        :scale: 50 %
+

data/documentation/_build/html/_sources/ide/vs/vs.txt

@@ -0,0 +1,10 @@
+Visual Studio
+=============
+
+.. toctree::
+    :maxdepth: 1
+
+    vs_install
+    how_to_used_bake_in_vs
+    how_to_create_vs_projects
+    how_to_debug_in_vs

data/documentation/_build/html/_sources/ide/vs/vs_install.txt

@@ -0,0 +1,43 @@
+How to install bake Visual Studio integration
+=============================================
+
+VS 2012
+*******
+The plugin is available on a E.S.R.Labs update site. Please follow the steps below to install the plugin.
+
+#. Configure the update site
+
+    `<http://www.esrlabs.com/vs-plugins/bake/atom.xml>`_
+
+    .. image:: ../../_static/vs_update_site.png
+        :width: 100 %
+        :scale: 50 %
+
+#. Now it's available via Tools->Extensions and Updates
+
+    .. image:: ../../_static/vs_install1.png
+        :width: 100 %
+        :scale: 50 %
+
+#. Check if it's installed correctly
+
+    .. image:: ../../_static/vs_installed.png
+        :width: 100 %
+        :scale: 50 %
+
+#. If an update is available, it will look like this
+
+    .. image:: ../../_static/vs_update.png
+        :width: 100 %
+        :scale: 50 %
+
+VS 2010
+*******
+
+The plugin is available on a E.S.R.Labs server.
+Download `Visual Studio 2010 bake plugin <http://www.esrlabs.com/vs-plugins/bake/bake%20Visual%20Studio%20Extension%202010.vsix>`_, 
+double click the file and install it.
+
+    .. image:: ../../_static/vs_2010_install.png
+        :width: 100 %
+        :scale: 50 %

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

@@ -0,0 +1,34 @@
+Welcome to bake's documentation!
+================================
+
+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

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

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

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

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

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

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

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

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

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

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