Images added to "building with cmake" article
authoribs <ibs@opencascade.com>
Fri, 21 Aug 2015 10:30:17 +0000 (13:30 +0300)
committerski <ski@opencascade.com>
Fri, 21 Aug 2015 10:30:51 +0000 (13:30 +0300)
dox/dev_guides/building/cmake/cmake.md
dox/dev_guides/building/cmake/images/cmake_image000.png [new file with mode: 0644]
dox/dev_guides/building/cmake/images/cmake_image001.png
dox/dev_guides/building/cmake/images/cmake_image002.png
dox/dev_guides/building/cmake/images/cmake_image003.png
dox/dev_guides/building/cmake/images/cmake_image004.png
dox/dev_guides/building/cmake/images/cmake_image005.png [deleted file]
dox/dev_guides/building/cmake/images/cmake_image007.png [deleted file]

index 9e267ff..3fc2d5b 100644 (file)
@@ -11,25 +11,25 @@ This article describes **CMake**-based build process which is now suggested as a
 
 All the examples in the article will be based on Windows x64 platform and Visual Studio 2010 solution will be the target IDE. The solution will be generated by CMake from the OCCT sources, the one will be built by an user and ready-to-go OCCT binaries will be deployed into a user specified directory by building *INSTALL* project.
 
-You can get all the required 3-rd party products visiting the official download page [**insert link**]; see @ref occt_dev_guides__building for more detailed information also.
+You can get all the required 3-rd party products visiting [the official download page](http://www.opencascade.org/getocc/download/loadocc); see @ref occt_dev_guides__building for more detailed information also.
 
 ## Get sources
 
-The sources of OCCT can be obtained from the official development web-site [**insert link**] by either downloading the universal source package (available at official download page [**insert link**]) or by cloning the Git repository:
+The sources of OCCT can be obtained from [the official development web-site](http://dev.opencascade.org) by either downloading the universal source package (available at [the official download page](http://www.opencascade.org/getocc/download/loadocc)) or by cloning the Git repository:
 
     git clone ssh://gitolite@git.dev.opencascade.org/occt occt
 
-As a result, you obtain the following directory structure in your filesystem (*workbench* name is used for example):
+As a result, you obtain the following directory structure in your filesystem (d:\ name is used for example):
     
-    workbench\occt\adm
-                  \data
-                  \dox
-                  \samples
-                  \src
-                  \tests
-                  ...
+    d:\occt\adm
+           \data
+           \dox
+           \samples
+           \src
+           \tests
+           ...
 
-The bare sources distribution contains not only the sources of Open CASCADE Technology, but also documentation, samples and non-regression test scripts. The official manual [**insert link**] is refered for details on the distribution contents.
+The bare sources distribution contains not only the sources of Open CASCADE Technology, but also documentation, samples and non-regression test scripts.
 
 ## The usage of CMake
 
@@ -40,25 +40,25 @@ It is recommended to use *cmake-gui* - cross-platform GUI tool provided by CMake
 CMake deals with three directories: source, build or binary and install.
 
 * The source directory is where the sources of OCCT are located in your filesystem
-* The build or binary directory is where all the files created during CMake configuration [**insert link**] and generation [**insert link**] process will be located. The mentioned process will be described below.
+* The build or binary directory is where all the files created during CMake configuration and generation process will be located. The mentioned process will be described below.
 * The installation directory is where binaries will be installed after build the *INSTALL* project that is created by CMake generation process, along with header files and resources required for OCCT use in applications. 
 
 **Note**: It is possible to choose one installation directory for several configurations of OCCT (differentiated by platform, bitness, compiler and build type).
 
-**Note**: The good practice is not to mix up different build configurations [**insert link**] in a single directory and not to use the source directory as a build one, for example:
+**Note**: The good practice is not to mix up different build configurations in a single directory and not to use the source directory as a build one, for example:
       
-    workbench/occt/                   - the source directory
-    workbench/tmp/occt-build-vc10-x64 - the build directory with the generated
-                                        solution and other intermediate files created during a CMake tool working
-    workbench/occt-install            - the installation directory that is
-                                        able to contain several OCCT configuratoion
+    d:/occt/                   - the source directory
+    d:/tmp/occt-build-vc10-x64 - the build directory with the generated
+                                 solution and other intermediate files created during a CMake tool working
+    d:/occt-install            - the installation directory that is
+                                 able to contain several OCCT configuratoion
 
 ## Configuration process
 
-If the command-line tool is used, run the tool from the source directory with a single argument indicating the build (binary) (relative or absolute path) directory:
+If the command-line tool is used, run the tool from the build directory with a single argument indicating the source (relative or absolute path) directory:
 
-    cd <the source directory>
-    ccmake <the build directory>
+    cd d:/tmp/occt-build-vc10-x64
+    ccmake d:/occt
 
 @figure{/dev_guides/building/cmake/images/cmake_image000.png}
 
@@ -78,6 +78,8 @@ Once the source and build directories are selected, "Configure" button should be
 
 Once "Finish" button is pressed, the first pass the configuration process is executed. At the end of the process, CMake outputs the list of environment variables which have to be properly specified for successful configuration. 
 
+@figure{/dev_guides/building/cmake/images/cmake_image003.png}
+
 The error message provides an information about these variables. This message will appear after each pass of the process until all required variables are specified correctly.
 
 The change of the state of some variables can lead to a new variable appearance. The new variables appeared after the pass of the configuration process is notified with red color by CMake GUI tool.
@@ -92,7 +94,7 @@ The following table enumerates the full list of environment variables used at co
 | USE_FREEIMAGE | Boolean flag | Indicates whether Freeimage product should be used in OCCT visualization module for support of popular graphics image formats (PNG, BMP etc) |
 | USE_GL2PS | Boolean flag | Indicates whether GL2PS product should be used in OCCT visualization module for support of vector image formats (PS, EPS etc) |
 | USE_TBB | Boolean flag | Indicates whether TBB 3-rd party is used or not. TBB stands for Threading Building Blocks, the technology of Intel Corp, which comes with different mechanisms and patterns for injecting parallelism into your application. OCCT remains parallel even without TBB product |
-| USE_VTK | Boolean flag | Indicates whether VTK 3-rd party is used or not. VTK stands for Visualization ToolKit, the technology of Kitware Inc intended for general-purpose scientific visualization. OCCT comes with a bridge between CAD data representation and VTK by means of its dedicated VIS component (VTK Integration Services). You may skip this 3-rd party unless you are planning to use VTK visualization for OCCT geometry. The official documentation [**insert link**] \("VTK Integration Services" user's guide\) for the details on VIS |
+| USE_VTK | Boolean flag | Indicates whether VTK 3-rd party is used or not. VTK stands for Visualization ToolKit, the technology of Kitware Inc intended for general-purpose scientific visualization. OCCT comes with a bridge between CAD data representation and VTK by means of its dedicated VIS component (VTK Integration Services). You may skip this 3-rd party unless you are planning to use VTK visualization for OCCT geometry. The official documentation @ref occt_user_guides__vis for the details on VIS |
 | 3RDPARTY_DIR | Path | Defines the root directory where all required 3-rd party products will be searched. Once you define this path it is very convenient to click "Configure" button in order to let CMake automatically detect all necessary products|
 | 3RDPARTY_FREETYPE_* | Path | Path to Freetype binaries |
 | 3RDPARTY_TCL_* 3RDPARTY_TK_* | Path | Path to Tcl/Tk binaries |
@@ -100,7 +102,7 @@ The following table enumerates the full list of environment variables used at co
 | 3RDPARTY_GL2PS_* | Path | Path to GL2PS binaries |
 | 3RDPARTY_TBB* | Path | Path to TBB binaries |
 | 3RDPARTY_VTK_* | Path | Path to VTK binaries |
-| BUILD_MODULE_<MODULE>| Boolean flag | Indicates whether the corresponding OCCT module should be built or not. It should be noted that some toolkits of a module can be built even if this module is not checked (this happens if some other modules depend on these toolkits). The main modules and their descriptions can be found in [**insert link**] \("User Guides" chapter\) and partially in [**insert link**] |
+| BUILD_MODULE_<MODULE>| Boolean flag | Indicates whether the corresponding OCCT module should be built or not. It should be noted that some toolkits of a module can be built even if this module is not checked (this happens if some other modules depend on these toolkits). The main modules and their descriptions can be found in @ref occt_user_guides |
 | BUILD_LIBRARY_TYPE | String |  Specifies the type of library to be created. "Shared" libraries are linked dynamically and loaded at runtime. "Static" libraries are archives of object files for use when linking other targets |
 | BUILD_ADDITIONAL_TOOLKITS | String | Semicolon-separated individual toolkits to include into build process. If you want to build some particular libraries (toolkits) only, then you may uncheck all modules in the corresponding *BUILD_MODUE_\<MODULE\>* options and provide the list of necessary libraries here. Of course, all dependencies will be resolved automatically |
 | REBUILD_PLATFORM_DEPENDENT_CODE | Boolean flag | Enables Flex/Bison lexical analyzers. OCCT source files relating to STEP reader and ExprIntrp functionality are generated automatically with Flex/Bison. Checking this options leads to automatic search of Flex/Bison binaries and regeneration of the mentioned files |
@@ -151,13 +153,13 @@ If a search result (include path, or library path, or dll path) does not meet yo
 At this time the search will be performed in the newly identified directory 
 and the result will be recorded to corresponding variables (replace old value if it is necessary).
 
-For example, (Linux case) *3RDPARTY_FREETYPE_DIR* variable 
+For example, *3RDPARTY_FREETYPE_DIR* variable 
 
-    /PRODUCTS/maintenance/Mandriva2010/freetype-2.4.10
+    d:/3rdparty/freetype-2.4.10
 
 can be changed to 
 
-    /PRODUCTS/maintenance/Mandriva2010/freetype-2.5.3
+    d:/3rdparty/freetype-2.5.3
 
 During the configuration process the related variables (*3RDPARTY_FREETYPE_DLL_DIR*, *3RDPARTY_FREETYPE_INCLUDE_DIR* and *3RDPARTY_FREETYPE_LIBRARY_DIR*) will be filled with new found values
 
@@ -171,11 +173,13 @@ Once the configuration process is done, "Generate" button is used to prepare pro
 
 Go to the build folder, start the Visual Studio solution *OCCT.sln* and build it by clicking **Build -> Build Solution**.
 
+@figure{/dev_guides/building/cmake/images/cmake_image004.png}
+
 By default the build solution process skips the building of the INSTALL and Overview project.
 
 When the building process is finished build:
 * Overview project to generate OCCT overview documentation (if BUILD_DOC_OcctOverview variable is checked)
-* the *INSTALL* project to run **the installation process** [**insert link**].
+* the *INSTALL* project to run **the installation process**
 
 For this, right-click on the *Overview/INSTALL* project and select **Project Only -> Build Only** -> *Overview/INSTALL* in the solution explorer. 
 
diff --git a/dox/dev_guides/building/cmake/images/cmake_image000.png b/dox/dev_guides/building/cmake/images/cmake_image000.png
new file mode 100644 (file)
index 0000000..efe9a6d
Binary files /dev/null and b/dox/dev_guides/building/cmake/images/cmake_image000.png differ
index b237346..a4f234d 100644 (file)
Binary files a/dox/dev_guides/building/cmake/images/cmake_image001.png and b/dox/dev_guides/building/cmake/images/cmake_image001.png differ
index e37ddbc..5ebc0b3 100644 (file)
Binary files a/dox/dev_guides/building/cmake/images/cmake_image002.png and b/dox/dev_guides/building/cmake/images/cmake_image002.png differ
index c442f9d..3e39569 100644 (file)
Binary files a/dox/dev_guides/building/cmake/images/cmake_image003.png and b/dox/dev_guides/building/cmake/images/cmake_image003.png differ
index bb889d9..81b11ce 100644 (file)
Binary files a/dox/dev_guides/building/cmake/images/cmake_image004.png and b/dox/dev_guides/building/cmake/images/cmake_image004.png differ
diff --git a/dox/dev_guides/building/cmake/images/cmake_image005.png b/dox/dev_guides/building/cmake/images/cmake_image005.png
deleted file mode 100644 (file)
index ee1a512..0000000
Binary files a/dox/dev_guides/building/cmake/images/cmake_image005.png and /dev/null differ
diff --git a/dox/dev_guides/building/cmake/images/cmake_image007.png b/dox/dev_guides/building/cmake/images/cmake_image007.png
deleted file mode 100644 (file)
index 541a052..0000000
Binary files a/dox/dev_guides/building/cmake/images/cmake_image007.png and /dev/null differ