MantisBT - Open CASCADE
View Issue Details
0028950Open CASCADE[OCCT] OCCT:Documentationpublic2017-07-25 18:532017-09-29 16:29
bugmaster 
bugmaster 
normalcrash 
closedfixed 
 
[OCCT] 7.2.0[OCCT] 7.2.0 
Not required
0028950: Generation of draw_test_harness and upgrade pdf files is crashed
Problem reproduced both Windows and Linux platforms
gendoc.bat -overview -pdf -ug=user_guides/draw_test_harness/draw_test_harness.md
No tags attached.
Issue History
2017-07-25 18:53bugmasterNew Issue
2017-07-25 18:53bugmasterAssigned To => bugmaster
2017-07-25 18:54bugmasterSummarygeneration of draw pdf is crashed => Generation of draw_test_harness pdf is crashed
2017-07-25 18:55bugmasterNote Added: 0068695
2017-07-25 19:11bugmasterDescription Updatedbug_revision_view_page.php?rev_id=17185#r17185
2017-07-25 19:14bugmasterAssigned Tobugmaster => abv
2017-07-25 19:14bugmasterStatusnew => feedback
2017-07-25 20:01apnSummaryGeneration of draw_test_harness pdf is crashed => Generation of draw_test_harness and upgrade pdf files is crashed
2017-07-25 20:16bugmasterSummaryGeneration of draw_test_harness and upgrade pdf files is crashed => Generation of draw_test_harness and occt_upgrade pdf files is crashed
2017-07-25 20:19bugmasterSummaryGeneration of draw_test_harness and occt_upgrade pdf files is crashed => Generation of draw_test_harness and upgrade pdf files is crashed
2017-07-25 20:20bugmasterNote Edited: 0068695bug_revision_view_page.php?bugnote_id=68695#r17189
2017-07-26 13:44abvStatusfeedback => assigned
2017-07-26 14:06gitNote Added: 0068722
2017-07-26 14:11abvNote Added: 0068723
2017-07-26 14:11abvAssigned Toabv => bugmaster
2017-07-26 14:11abvStatusassigned => resolved
2017-07-26 14:11abvSteps to Reproduce Updatedbug_revision_view_page.php?rev_id=17191#r17191
2017-07-26 14:12abvNote Edited: 0068723bug_revision_view_page.php?bugnote_id=68723#r17193
2017-07-26 14:31abvRelationship addedrelated to 0028882
2017-07-26 16:31bugmasterStatusresolved => reviewed
2017-07-26 16:32bugmasterNote Added: 0068736
2017-07-26 16:32bugmasterStatusreviewed => tested
2017-07-28 17:18bugmasterChangeset attached => occt master cdec5927
2017-07-28 17:18bugmasterStatustested => verified
2017-07-28 17:18bugmasterResolutionopen => fixed
2017-07-31 17:46gitNote Added: 0068962
2017-08-18 13:11bugmasterTest case number => Not required
2017-09-29 16:17aivFixed in Version => 7.2.0
2017-09-29 16:29aivStatusverified => closed

Notes
(0068695)
bugmaster   
2017-07-25 18:55   
(edited on: 2017-07-25 20:20)
OUTPUT of generation of pdf from draw_test_harness.md and upgrade.md:

Generating OCCT User Guides in PDF format...

Info: Processing file user_guides/draw_test_harness/draw_test_harness.md

2017-07-25 18:38 Generating Doxyfile...
2017-07-25 18:38 Generating PDF file...

Warning: Doxygen reported 2 messages.
See log in D:/builds/IR-2017-07-20_IR-2017-07-20/Windows-64-VC10-opt/OCCT/doc/doxygen_warnings_and_errors.log


Warning: PDFLaTeX reported 9 messages.
See log in D:/builds/IR-2017-07-20_IR-2017-07-20/Windows-64-VC10-opt/OCCT/doc/pdflatex_warnings_and_errors.log

Fatal: PDFLaTeX failed to create output file, stopping!
2017-07-25 18:38 Generation completed.

(0068722)
git   
2017-07-26 14:06   
Branch CR28950 has been created by abv.

SHA-1: d91b9e045cbaae0301d8198b3e74f468fc458cb3


Detailed log of new commits:

Author: abv
Date: Wed Jul 26 13:47:04 2017 +0300

    0028950: Generation of draw_test_harness and upgrade pdf files is crashed
    
    Template for LaTeX header used in generation of PDF manuals is corrected to avoid multiple errors during processing by LaTeX (which can eventually lead to LaTeX aborting if their count exceeds 100).
    
    Names of log files generated by gendoc command are made dependent on target format and (for PDF output) document name.
    
    Formatting bug is fixed in DRAW User Guide
(0068723)
abv   
2017-07-26 14:11   
(edited on: 2017-07-26 14:12)
The fix is pushed to branch CR28950, please test.

The problem was in absence of definition of LaTeX command "\+" which apparently has been introduced in one of recent versions of Doxygen and defined in default LaTeX header template used by it. Since OCCT uses own header template, and it has not been updated for long time, that command was absent; this cause LaTeX to generate errors and eventually abort for long documents (where count of errors exceeds 100).

See related discussion here: http://doxygen.10944.n7.nabble.com/Undefined-control-sequence-error-when-using-user-defined-Latex-header-tex-td7602.html [^]

Please note that I have revised formatting of output of command gendoc to make it more compart for PDF generation, and changed names of log files generated by it so that now they depend on target format and (for PDF output) on file name.

(0068736)
bugmaster   
2017-07-26 16:32   
draw_test_harness and upgrade pdf files are generated successfully
(0068962)
git   
2017-07-31 17:46   
Branch CR28950 has been deleted by kgv.

SHA-1: d91b9e045cbaae0301d8198b3e74f468fc458cb3