DiscussionsIssue archiveOCCT:Documentation

Archived issue #0032156

Documentation, gendoc.tcl - wrong processing of 'mathjax' option

CommunityOCCT:Documentationclosed7 public notes

Search issues

Description

The condition for processing the mathjax option value is inverse to the wanted behavior:

---
    } elseif {$arg_n == "mathjax"} {
      if { [ lsearch $args_names "pdf" ] != -1 } {
        set possible_mathjax_loc $args_values(mathjax)
---


This branch should be taken if there is no "pdf" option (i.e. lsearch returns -1), so it should be "== -1" instead of "!= -1".

Steps to reproduce

./gendoc -refman -html -mathjax="/usr/share/javascript/mathjax/"


outputs:
"Warning: MathJax is not used with pdf and will be ignored."


It should process and print the mathjax path.

Public activity

7 archived notes

Participants are labeled by their role within this record.

01Commenter 1
Igor, the description looks reasonable - could you please prepare a patch?

02Commenter 2
Branch [archived branch] has been created by Participant.

[revision removed]


Detailed log of new commits:

Author: Commenter 3
Date: Wed Jun 16 13:52:19 2021 +0300

    0032156: Documentation, gendoc.tcl - wrong processing of 'mathjax' option
03Commenter 3
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: 17401.600000000442 / 17450.34000000035 [-0.28%]
Products
Total CPU difference: 11508.180000000091 / 11477.640000000127 [+0.27%]
Windows-64-VC14:
OCCT
Total CPU difference: 19191.265625 / 19269.40625 [-0.41%]
Products
Total CPU difference: 12883.6875 / 12905.015625 [-0.17%]


Image differences :
No differences that require special attention

Memory differences :
No differences that require special attention
04Commenter 2
Branch [archived branch] has been deleted by Commenter 1.

[revision removed]
05Commenter 1
Patch was prepared for a another (wrong) statement in gendoc.
06Commenter 2
Branch [archived branch] has been created by Commenter 1.

[revision removed]


Detailed log of new commits:

Author: Commenter 1
Date: Mon Nov 1 09:53:12 2021 +0300

    0032156: Documentation, gendoc.tcl - wrong processing of 'mathjax' option
    
    Fixed handling of -s=<search_mode> option.
    Fixed handling of -mathjax=<path> option.
07Commenter 2
Branch [archived branch] has been deleted by Commenter 1.

[revision removed]