OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-19 13:40:49 +03:00
Code Activity

0027191: Documentation - redesign of information architecture -- revision (build)

Browse Source 
Revised documentation of building OCCT and third-parties; some related tags updated
This commit is contained in:
Vera Sdobnova
2020-10-01 14:54:01 +03:00
committed by abv
parent 6b6d06fa08
commit 06ce029fb9
51 changed files with 1063 additions and 1036 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
dox/contribution/contribution.md
View File

@@ -3,14 +3,13 @@
The following documents provide information on OCCT building, development and testing:
* @subpage occt_dev_guides__building "Building OCCT from sources"
* @subpage occt_dev_guides__documentation "Documentation system"
* @subpage occt_contribution__documentation "Documentation system"
* @subpage occt_dev_guides__coding_rules "Coding Rules"
* @subpage occt_dev_guides__contribution_workflow "Contribution Workflow"
* @subpage occt_dev_guides__git_guide "Guide to installing and using Git for OCCT development"
* @subpage occt_dev_guides__tests "Automatic Testing system"
* @subpage occt_dev_guides__debug "Debugging tools and hints"
* @subpage occt__debug "Debugging tools and hints"
The following guide provides information relevant to upgrading applications developed with previous versions of OCCT, to recent one:
* @subpage occt_dev_guides__upgrade "Upgrade from previous OCCT versions"
* @subpage occt__upgrade "Upgrade from previous OCCT versions"

2
dox/contribution/contribution_workflow/contribution_workflow.md
View File

@@ -165,7 +165,7 @@ If the change affects a functionality described in @ref user_guides "User Guides
If the change affects OCCT test system, build environment, or development tools described in @ref dev_guides "Developer Guides", the corresponding guide should be updated.
The changes that break compatibility with the previous versions of OCCT (i.e. affecting API or behavior of existing functionality in the way that may require update of existing applications based on an earlier official release of OCCT to work correctly) should be described in the document @ref occt_dev_guides__upgrade "Upgrade from previous OCCT versions".
The changes that break compatibility with the previous versions of OCCT (i.e. affecting API or behavior of existing functionality in the way that may require update of existing applications based on an earlier official release of OCCT to work correctly) should be described in the document @ref occt__upgrade "Upgrade from previous OCCT versions".
It is recommended to add a sub-section for each change described.
The description should provide the explanation of the incompatibility introduced by the change, and describe how it can be resolved (at least, in known situations).
When feasible, the automatic upgrade procedure (adm/upgrade.tcl) can be extended by a new option to perform the required upgrade of the dependent code automatically.

2
dox/contribution/documentation/documentation.md
View File

@@ -1,4 +1,4 @@
Documentation System {#occt_dev_guides__documentation}
Documentation System {#occt_contribution__documentation}
======================
@tableofcontents

2
dox/contribution/git_guide/git_guide.md
View File

@@ -143,7 +143,7 @@ The official repository contains:
- Extension: <code>.svg</code>
- External program: <code>&lt;path_to_OCCT&gt;\\adm\\svgdiff.bat %%base %%mine %%bname %%yname</code>
@figure{OCCT_GitGuide_V2_svgdiff.png,"",709}
@figure{OCCT_GitGuide_V2_svgdiff.png,"",320}
@subsection occt_gitguide_2_2 Linux platform