Archived issue #0031985
Documentation - description of TDocStd_FormatVersion is excessive
Description
Description of TDocStd_FormatVersion integrated within #0029217 is excessive, see attached image. Please consider removing irrelevant parts of text, such as questions "Does it mean that an application based on an old version of Open CASCADE Technology cannot read an OCAF document saved by an application using a newer version of Open CASCADE Technology?". Please keep only the information necessary for the OCCT user to recognize what are the format version numbers and how to trigger them as needed for his application.
If it was intended to give also indication on how to add new version numbers, this needs to be clearly separated, and formulated as list of requirements / conventions, not as an example.
If it was intended to give also indication on how to add new version numbers, this needs to be clearly separated, and formulated as list of requirements / conventions, not as an example.
Steps to reproduce
Could you review the updated documentation, please?:
http://vm-jenkins-test-12.nnov.opencascade.com:8080/view/CR31985-master-VRO/view/COMPARE/
Branch: [archived branch]
http://vm-jenkins-test-12.nnov.opencascade.com:8080/view/CR31985-master-VRO/view/COMPARE/
Branch: [archived branch]
Public activity
5 archived notes
Participants are labeled by their role within this record.
Branch [archived branch] has been created by Commenter 3.
[revision removed]
Detailed log of new commits:
Author: Vlad Romashko
Date: Wed Dec 9 12:08:40 2020 +0300
0031985: Documentation - description of TDocStd_FormatVersion is excessive
// No compilation, no testing is needed. Just a comment to the file is improved.
[revision removed]
Detailed log of new commits:
Author: Vlad Romashko
Date: Wed Dec 9 12:08:40 2020 +0300
0031985: Documentation - description of TDocStd_FormatVersion is excessive
// No compilation, no testing is needed. Just a comment to the file is improved.
Branch [archived branch] has been updated forcibly by Author.
[revision removed]
[revision removed]
Reviewed with minor amendments (formatting), please integrate.
OCCT branch CR31985
OCCT branch CR31985
Combination -
OCCT branch : [archived branch]
master SHA - [revision removed]
[revision removed]
Products branch : [archived branch] SHA - [revision removed]
was compiled on Linux, MacOS and Windows platforms and tested in optimize mode.
Number of compiler warnings:
No new/fixed warnings
Regressions/Differences/Improvements:
No regressions/differences
CPU differences:
Debian80-64:
OCCT
Total CPU difference: 17756.510000000126 / 18090.92999999998 [-1.85%]
Products
Total CPU difference: 12330.210000000125 / 12342.950000000128 [-0.10%]
Windows-64-VC14:
OCCT
Total CPU difference: 19429.09375 / 19751.71875 [-1.63%]
Products
Total CPU difference: 13755.5 / 13772.515625 [-0.12%]
Image differences :
No differences that require special attention
Memory differences :
No differences that require special attention
OCCT branch : [archived branch]
master SHA - [revision removed]
[revision removed]
Products branch : [archived branch] SHA - [revision removed]
was compiled on Linux, MacOS and Windows platforms and tested in optimize mode.
Number of compiler warnings:
No new/fixed warnings
Regressions/Differences/Improvements:
No regressions/differences
CPU differences:
Debian80-64:
OCCT
Total CPU difference: 17756.510000000126 / 18090.92999999998 [-1.85%]
Products
Total CPU difference: 12330.210000000125 / 12342.950000000128 [-0.10%]
Windows-64-VC14:
OCCT
Total CPU difference: 19429.09375 / 19751.71875 [-1.63%]
Products
Total CPU difference: 13755.5 / 13772.515625 [-0.12%]
Image differences :
No differences that require special attention
Memory differences :
No differences that require special attention
Branch [archived branch] has been deleted by Participant.
[revision removed]
[revision removed]
Related records