bake-toolkit 2.29.4 → 2.30.0

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

@@ -1,25 +0,0 @@
-Eclipse
-=======
-
-.. toctree::
-    :maxdepth: 1
-
-    how_to_install_eclipse_plugin
-    how_to_use_bake_in_eclipse
-    how_to_convert_existing_cdt_workspace
-    how_to_create_a_workspace_in_eclipse
-    how_to_create_a_new_project_in_eclipse
-    how_to_debug_in_eclipse
-
-Syntax highlighting
-*******************
-
-To enable syntax highlighting for the Project.meta files in Eclipse, install the "rtext_eclipse_plugin" (Help->Install New Software...) and associate ".meta" files with the rtext editor (Window->Preferences, File Associations page).
-An update site for Eclipse (needed for installation) will be provided soon. For now, you can download it manually at github.
-
-Key bindings
-************
-
-It is possible to bind the bake commands to keys:
-
-.. image:: ../../_static/keys.png

data/documentation/_build/html/_sources/ide/eclipse/how_to_convert_existing_cdt_workspace.txt

@@ -1,31 +0,0 @@
-How to convert existing CDT workspaces
-======================================
-You only need to convert your workspace if CDT is still used to build your projects and the `Project.meta` files do not exist yet.
-Only one developer in a team has to convert the workspace only once!
-Conversion means, that Project.meta files are generated and filled with the informationen from the `.project` and `.cproject`
-files. bake does not read the `.project` and `.cproject` files, only the `Project.meta` files.
-
-The converter is an export wizard, which can be found under `File->Export` or in the context menu of the Project Explorer
-
-=========================================           =======================================
-.. image:: ../../_static/SelectExport.png           .. image:: ../../_static/Script.png
-=========================================           =======================================
-
-.. note::
-
-    * The conversion is not a 1:1 conversion. That means, that the tool can only be 99% perfect. There might by some small issues, which have to be adapted manually. You can find it out by simply trying to build your project with bake.
-
-    * It is possible to specify a ruby script in the wizard window, which can do these manual adaptions. This can make sense, if you want to convert the workspace several times before completely switching to bake.
-
-    * To convert only a subset of projects instead of the whole workspace, select the appropriate projects in the Project Explorer before starting the export wizard. Ensure that the checkbox shown above is marked.
-
-    * If you are satisfied with the results, replace the .cproject and .project files in your repository. (Steps to do with .cproject and .project files)
-        * Delete the files
-        * Remove the projects from your workspace in Eclipse (but do not delete the contents from your disk)
-        * Import the projects again via the bake import wizard to generate wrapper files for Eclipse
-        * Commit the change to your source control system
-
-.. warning::
-    Do not commit these `.projec`t and `.cproject` files anymore. Instead, commit the changes in `Project.meta` files.
-    You still need `.cproject` and `.project` files for working under Eclipse,
-    that's why you have to import the projects again via the bake import wizard.

data/documentation/_build/html/_sources/ide/eclipse/how_to_create_a_new_project_in_eclipse.txt

@@ -1,18 +0,0 @@
-How to create a new project in Eclipse
-======================================
-This is very easy. Navigate to `File->New->Other` and choose bake Project.
-
-=========================================           =======================================
-.. image:: ../../_static/SelectNew.png              .. image:: ../../_static/New.png
-=========================================           =======================================
-
-Choose a name. If you have more than one workspace root, you can also choose a location.
-
-
-
-=========================================           ===========================================================================
-.. image:: ../../_static/Result.png                 A new folder with three files will be created. `.cproject` and `.project`
-                                                    wrapper files for Eclipse and an almost.
-                                                    empty `Project.meta` which can be filled with build configurations.
-=========================================           ===========================================================================
-

data/documentation/_build/html/_sources/ide/eclipse/how_to_create_a_workspace_in_eclipse.txt

@@ -1,27 +0,0 @@
-How to create a workspace in Eclipse
-====================================
-
-Using bake in Eclipse is very similar compared to the :any:`CDT build mechanism <how_to_convert_existing_cdt_workspace>`.
-
-.. warning::
-    One major difference is, that `.cproject` and `.project` files are just wrappers. Do not use the standard property pages,
-    they will be simply ignored! Edit only the `Project.meta` files.
-    The `.cprojec`t and `.project` files shall not be committed to your source control.
-
-Import
-******
-
-If you have a workspace with no `.cproject` and `.project` files, but `Project.meta` files, you can import them to Eclipse.
-You can also use the importer to import single projects.
-The importer can be found unter `File->Import` or in the context menu of the Project Explorer.
-All (sub)directories with a `Project.meta` are listed here. Choose the projects to import and press Finish.
-
-=========================================           =======================================
-.. image:: ../../_static/SelectImport.png           .. image:: ../../_static/Import.png
-=========================================           =======================================
-
-.. note::
-    Note, that `.cproject` and `.project` files will not be overwritten per default. If e.g. a project is not a c-project,
-    some bake features will not available. In this case, enable the recreate option.
-    This is also a good idea, if you want to get rid of old configurations.
-

data/documentation/_build/html/_sources/ide/eclipse/how_to_debug_in_eclipse.txt

@@ -1,38 +0,0 @@
-How to debug in Eclipse
-=======================
-
-The following example is made with Eclipse Mars, **Cygwin**, **gcc** and **gdb**. However, the same applies to all other compilers and
-environments, too.
-
-1. Compile with debug information
-*********************************
-
-Don't forget this. Otherwise sources symbols cannot not mapped.
-
-.. image:: ../../_static/debug_flag.png
-
-2. Create a debug configuration for a C++ application
-*****************************************************
-
-This options can be found under Run->Debug Configurations... or click on the arrow next to the green spider.
-
-.. image:: ../../_static/debug_app.png
-
-|  Choose a suitable name and the executable.
-
-3. Add path mapping
-*******************
-
-.. image:: ../../_static/debug_path.png
-
-.. image:: ../../_static/debug_map.png
-
-|  Note that this must be done if the compiler uses different paths than Eclipse. In this example I have used gcc under Cygwin,
-|  which typically uses "/cygdrive/c" for "c:\\". I always mount "c:\\" to "/c".
-|
-|  Also note, that my Eclipse changes "/c" to "\\c" in the dialog box automatically, but it works nevertheless.
-
-4. Now you can debug your code
-******************************
-
-.. image:: ../../_static/debug_debug.png

data/documentation/_build/html/_sources/ide/eclipse/how_to_install_eclipse_plugin.txt

@@ -1,44 +0,0 @@
-How to install bake Eclipse integration
-=======================================
-
-The bake Eclipse integration plugin is available on a E.S.R.Labs update site. Please follow the steps below to install the plugin.
-
-#. Go to "Help" -> "Install New Software"
-
-    .. image:: ../../_static/InstallNewSoftware.png
-        :width: 100 %
-        :scale: 50 %
-
-#. Setup the update site
-
-    `<http://www.esrlabs.com/eclipse-plugins/com.esrlabs.eclipse.bake.updatesite/>`_
-
-    .. image:: ../../_static/AddRepository.png
-        :width: 100 %
-        :scale: 50 %
-
-#. Select the bake Feature
-
-    .. image:: ../../_static/AvailableSoftware.png
-        :width: 100 %
-        :scale: 50 %
-
-
-#. Accept the license after reading it
-
-    .. image:: ../../_static/Licenses.png
-        :width: 100 %
-        :scale: 50 %
-
-#. Ignore the security warning - you can trust the software
-
-    .. image:: ../../_static/TrustMe.png
-        :width: 100 %
-        :scale: 50 %
-
-#. After successfull installation, restart Eclipse
-
-    .. image:: ../../_static/Restart.png
-        :width: 100 %
-        :scale: 50 %
-

data/documentation/_build/html/_sources/ide/eclipse/how_to_use_bake_in_eclipse.txt

@@ -1,86 +0,0 @@
-How to use bake in Eclipse
-==========================
-
-Choose the C/C++ perspective
-****************************
-
-The menu items described on this page only appear in the C/C++ perspective.
-
-Select a build configuration of the main project
-************************************************
-
-#. Right click on the main project and select a bake build configuration.
-
-    .. image:: ../../_static/FirstSelect.png
-        :width: 100 %
-        :scale: 50 %
-
-    .. note::
-
-        * That only configurations with a DefaultToolchain will be displayed.
-
-#. If no Project.meta or configuration with a DefaultToolchain exist, an error item will be displayed like this
-
-    .. image:: ../../_static/WrongSelect.png
-        :width: 100 %
-        :scale: 50 %
-
-#. The chosen config is marked with a filled circle before the config name.You can also see it directly in the project explorer
-
-    .. image:: ../../_static/SecondSelect.png
-        :width: 100 %
-        :scale: 50 %
-
-    .. note::
-
-        * This label decoration can be switched off and on via Window->Preferences->General->Appearance->Label Decoration
-
-Adjust includes and defines for CDT
-***********************************
-s you might have already seen, a new menu item for the main project is enabled now: Adjust includes and defines for CDT.
-All CDT features work out-of-the-box except those about the `#include` and `#define` statements e.g. auto-completion of includes.
-To import the includes and defines into the CDT .cproject files, simply click on this menu item.
-
-Compiler internal includes and defines must be specified in InternalInclude and InternalDefine files.
-See "Syntax" help page how to set the name of these files. Note, that the variables CPPPath, CPath, ASMPath,
-ArchiverPath and LinkerPath can be used in these files.
-
-Adjusting can take between a few seconds and a minute depending on the size of the workspace and the number of
-project settings which have to be written.
-
-Build/Clean Projects/Files
-**************************
-Now you can build or clean a project by clicking on the appropriate menu items.
-
-=========================================           =======================================
-Project                                             File
-=========================================           =======================================
-.. image:: ../../_static/buildMain.png              .. image:: ../../_static/buildFile.png
-=========================================           =======================================
-
-.. note::
-    * Build File always rebuilds the file
-
-Result
-******
-
-The result of the build will be shown in the Console and Problems View as usual
-
-.. image:: ../../_static/console.png
-    :width: 100 %
-    :scale: 50 %
-
-.. image:: ../../_static/problem.png
-    :width: 100 %
-    :scale: 50 %
-
-
-Preferences
-***********
-
-Via `Window->Preferences->bake` some settings can be changed and the bake command line can be extended
-
-.. image:: ../../_static/pref.png
-    :width: 100 %
-    :scale: 50 %
-

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

@@ -1,40 +0,0 @@
-IDE Support
-===========
-
-.. toctree::
-    :maxdepth: 1
-
-    eclipse/eclipse
-    vs/vs
-
-The integrations for eclipse and visual studio are the ones that are
-most used and best documented.
-
-.. image:: ../_static/eclipse.png
-   :target: eclipse/eclipse.html
-
-.. image:: ../_static/visualstudio-pro.png
-   :target: vs/vs.html
-
-
-Basic integrations
-******************
-
-The following integrations lack in features, documentation and
-maturity compared to the above integrations. Still they provide you
-with a starting point.
-
-.. image:: ../_static/emacs.png
-   :target: http://github.com/gizmomogwai/bake-mode
-
-.. image:: ../_static/notepad.png
-   :target: https://github.com/sanastasiou/RTextNpp/releases
-
-.. image:: ../_static/vim.png
-   :target: https://github.com/flxo/bake.vim
-
-The beautiful IDE icons are designed by `Kat On`_ and used under the
-`creative commons license v3.0`_.
-
-.. _Kat On: https://www.squirrelmuffins.com
-.. _creative commons license v3.0: https://creativecommons.org/licenses/by/3.0

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

@@ -1,15 +0,0 @@
-How to create VS-Projects using bake
-====================================
-
-bake projects are Makefile projects (NMake). When creating a new project, you can just create a new Makefile project and add a Project.meta.
-The recommended way is to use a script which comes with bake-toolkit:
-
-    .. image:: ../../_static/cvsp.png
-        :width: 100 %
-        :scale: 50 %
-
-Example:
-
-.. code-block:: console
-
-    C:\MyProj>  createVSProjects --version 2012 --rewrite

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

@@ -1,35 +0,0 @@
-How to Debug in Visual Studio
-=============================
-
-Natively you can only debug the output from the Microsoft VC compiler with Visual Studio. There are some plugins available for e.g. debugging gcc output. Another option is to use the MSVC toolchain from bake, which is described on this help page.
-Add debug flags to the MSVC toolchain:
-
-
-.. code-block:: text
-
-    DefaultToolchain MSVC {
-
-        Compiler CPP {
-            Flags "-Zi"
-        }
-        Linker {
-            Flags "-Debug"
-        }
-    }
-
-Start Visual Studio with e.g. a batch file shown below and choose the appropriate solution. If you don't have a solution yet, check out How to create a solution / projects in Visual Studio.
-
-.. code-block:: console
-
-    set PATH=%PATH%;C:\tools\Microsoft Visual Studio 11.0\VC\bin
-    call "C:\tools\Microsoft Visual Studio 11.0\VC\vcvarsall.bat"
-    "C:\tools\Microsoft Visual Studio 11.0\Common7\IDE\devenv.exe"
-
-This adds the compiler, linker, etc. to the path. vcvarsall.bat setups the environment and the last line starts Visual Studio. As a test, just execute the first two lines and check if "cl.exe" can be executed without any errors. In Visual Studio, you have to define the executable you like to debug. Add the executable in the project properties:
-
-.. image:: ../../_static/vs_debug.png
-    :width: 100 %
-    :scale: 50 %
-
-You can also define command line arguments here.
-Start debugging as usual...

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

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

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

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