View Issue Details

IDProjectCategoryView StatusLast Update
0022811Open CASCADEOCCT:Documentationpublic2014-01-13 11:18
ReporterszvAssigned Tobugmaster  
PriorityhighSeverityminor 
Status closedResolutionfixed 
PlatformAOSL 
Product Version6.5.2 
Target Version6.5.4Fixed in Version6.5.4 
Summary0022811: Documentation about building 3rd-party products and OCCT is incomplete
DescriptionIt is suggested to ameliorate the on-line documentation that describes the process of building 3rd-party products and OCCT, in terms of providing complete and consistent step-by-step instruction on building the full set of components. Such instructions should be unique for Windows and Linux, but applicable to building of each individual configuration (for example, of platform (32/64), VS version, and mode (release / debug)).

The initial version of such documentation is attached as MS Word document.
TagsNo tags attached.
Test case number

Attached Files

  • OCC_Building_Guidelines_v01.doc (938,496 bytes)
  • OCC_Building_Guidelines_v02.doc (1,097,728 bytes)
  • OCC_Building_Guidelines_Windows_v03.doc (1,106,944 bytes)
  • OCCT_Build3rdParty_Linux_V2.doc (90,112 bytes)
  • OCCT_Build3rdParty_Windows_V2.doc (768,000 bytes)
  • OCCT_Build3rdParty_Windows_V3.doc (777,216 bytes)
  • OCCT_Build3rdParty_Linux_V3.doc (94,208 bytes)
  • freeimage-Makefile.osx-lion.txt (2,253 bytes)
  • OCCT_Build3rdParty_OSX_V1.doc (94,720 bytes)

Activities

szv

2011-11-23 14:19

manager  

OCC_Building_Guidelines_v01.doc (938,496 bytes)

szv

2011-11-23 14:24

manager   ~0018610

Hi Alexey,

Would you please complete the document by including the information from the existing on-line documentation (chapters "Building Modules" and "Compilation of 3rd-party products used for OCCT") and adding the missing steps to connect process of building 3rd-party products to the process of building OCCT (I mean, to receive a single consistent flow of building process, with necessary scripts and detailed instructions for each step)?

apv

2011-12-08 16:50

tester  

OCC_Building_Guidelines_v02.doc (1,097,728 bytes)

apv

2011-12-08 16:53

tester   ~0018798

Hi Sergey,

I prepared updated version of initial file and would ask you to revise last changes. Two modifications in the document are required your attention (yellow-highlighted).

szv

2011-12-26 16:15

manager   ~0019007

In the last description, it is suggested to modify names of several libraries in case of building in debug mode. However, we should minimize intervention to 3rd-party products settings. Thus, OCCT building procedure must be modified, to allow linking to 3rd-party libraries bearing their default names.

rkv

2012-03-22 16:33

developer   ~0020101

I propose to rename the document to “Additional User’s Guide for building third-party products” and move the section 2.2 from this document into a separate document because in the case of work with GIT repository the preferred order a user build OCCT (to allow WOK to automatically find third-party products) is the following:
1) check out OCCT from repository and build third-party products;
2) install/configure WOK to use built third-party products;
3) build the OCCT.

The step 2 is described in the separate document "Binary WOK Package".

rkv

2012-03-22 16:34

developer  

OCC_Building_Guidelines_Windows_v03.doc (1,106,944 bytes)

kgv

2012-03-26 22:17

developer   ~0020149

> 1) Mandatory products: Tcl 8.5, Tk 8.5, TclX 8.4, FreeType 2.3.7, Ftgl 2.1.2
TclX 8.4 is NOT mandatory product.
Some tcl procedures from this extension library were used by WOK scripts but current WOK-in-progress avoid them (TclX no more loaded / checked by WOK initialization script).
And minimal set of WOK environment required to build OCCT and generate project files is guaranteed to work without it (there are a lot of obsolete tcl scripts within WOK that may still use some of extensions but this is difficult to test).
Moreover I have no any information about dependency of OCCT itself from TclX.

> <building mode> - opt (for release) or deb (for debug)
There are actually small amount of reasons to build 3rd-parties in debug mode:
- user planned to debug these libraries (unlikely)
- coherent run-time libraries for smooth distribution (debug versions are NOT distributable in general!)
- run-time mismatch (this is known that gl2ps uses FILE structure as an interface which may cause application crash in case of debug/release mismatch of TKOpenGl and gl2ps due to different definition).

> Third-party products TBB, FreeImage and gl2ps are optional for Open CASCADE
> Technology. To define the list of the optional products you like to use,
> modify the variable CSF_DEFINES in the file <CASROOT>\env_build.bat
The whole section '2.2. Building Open CASCADE Technology' was written against current last release 6.5.2 without WOK (pre-generated project files and CDL-extracted).
I hope that next release will use updated WOK for project generation thus this section should be completely rewritten (for example there no more dedicated 'env_build.bat' script at all).

> Rename it according to the rule: freetype-<platform>-<compiler>-<building mode>, where
> <platform> - win32 or win64;
> <compiler> - vc8 or vc9 or vc10;
> <building mode> - opt (for release) or deb (for debug)
It is should be noticed in the document that these naming rules will be used by WOK configuration tool to automatically determine paths. Thus them strongly recommended if more than one configuration will be used.

szv

2012-09-17 12:51

manager   ~0021495

Hi Andrey,
I suggest you to manage further steps towards closing this issue.

abv

2012-10-24 10:21

manager   ~0021913

Igor, please add last versions of the documents (in DOC format) to this issue and publish on the site, then close the issue

bugmaster

2012-10-26 10:31

administrator  

OCCT_Build3rdParty_Linux_V2.doc (90,112 bytes)

bugmaster

2012-10-26 10:31

administrator  

OCCT_Build3rdParty_Windows_V2.doc (768,000 bytes)

bugmaster

2012-10-26 10:39

administrator   ~0021966

- last versions of the documents (in DOC format) have been added to this issue
- last versions of the documents (in PDF format) have been published on dev portal

abv

2013-02-25 16:42

manager  

OCCT_Build3rdParty_Windows_V3.doc (777,216 bytes)

abv

2013-02-27 14:37

manager  

OCCT_Build3rdParty_Linux_V3.doc (94,208 bytes)

abv

2013-02-27 14:40

manager  

freeimage-Makefile.osx-lion.txt (2,253 bytes)

abv

2013-02-27 14:44

manager  

OCCT_Build3rdParty_OSX_V1.doc (94,720 bytes)

Issue History

Date Modified Username Field Change
2011-11-23 14:19 szv New Issue
2011-11-23 14:19 szv Assigned To => apv
2011-11-23 14:19 szv File Added: OCC_Building_Guidelines_v01.doc
2011-11-23 14:20 szv Status new => assigned
2011-11-23 14:24 szv Note Added: 0018610
2011-12-08 16:50 apv File Added: OCC_Building_Guidelines_v02.doc
2011-12-08 16:53 apv Note Added: 0018798
2011-12-09 09:59 apv Status assigned => resolved
2011-12-26 16:15 szv Note Added: 0019007
2012-02-28 11:59 szv Assigned To apv => abv
2012-02-28 12:06 abv Assigned To abv => bugmaster
2012-02-28 12:06 abv Status resolved => assigned
2012-03-21 14:16 abv Assigned To bugmaster => rkv
2012-03-22 16:33 rkv Note Added: 0020101
2012-03-22 16:34 rkv File Added: OCC_Building_Guidelines_Windows_v03.doc
2012-03-22 16:35 rkv Assigned To rkv => szv
2012-03-22 16:35 rkv Status assigned => feedback
2012-03-26 22:17 kgv Note Added: 0020149
2012-09-17 12:51 szv Note Added: 0021495
2012-09-17 12:51 szv Status feedback => assigned
2012-09-17 12:52 szv Assigned To szv => abv
2012-10-24 10:21 abv Note Added: 0021913
2012-10-24 10:21 abv Assigned To abv => bugmaster
2012-10-24 10:21 abv Status assigned => feedback
2012-10-24 10:22 abv Target Version 6.5.3 => 6.5.4
2012-10-26 10:31 bugmaster File Added: OCCT_Build3rdParty_Linux_V2.doc
2012-10-26 10:31 bugmaster File Added: OCCT_Build3rdParty_Windows_V2.doc
2012-10-26 10:39 bugmaster Note Added: 0021966
2012-10-26 10:39 bugmaster Status feedback => tested
2012-10-26 10:39 bugmaster Status tested => verified
2012-10-26 10:39 bugmaster Resolution open => fixed
2012-11-16 13:14 bugmaster Fixed in Version => 6.5.4
2012-11-16 13:18 bugmaster Status verified => closed
2013-02-25 16:42 abv File Added: OCCT_Build3rdParty_Linux_V3.doc
2013-02-25 16:42 abv File Added: OCCT_Build3rdParty_Windows_V3.doc
2013-02-27 14:36 abv File Deleted: OCCT_Build3rdParty_Linux_V3.doc
2013-02-27 14:37 abv File Added: OCCT_Build3rdParty_Linux_V3.doc
2013-02-27 14:40 abv File Added: freeimage-Makefile.osx-lion.txt
2013-02-27 14:44 abv File Added: OCCT_Build3rdParty_OSX_V1.doc
2014-01-13 11:18 bugmaster Category OCCT Release:DOC => OCCT:Documentation