Bug 1305739

Summary: Unescaped percent sign in doxygen output
Product: [Fedora] Fedora Reporter: Jerry James <loganjerry>
Component: doxygenAssignee: Than Ngo <than>
Status: CLOSED RAWHIDE QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 24CC: than
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-03-07 10:12:27 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Jerry James 2016-02-09 04:39:25 UTC
Description of problem:
I'm having a problem building documentation for the apron package in Rawhide.  With doxygen 1.8.10-6.fc23.x86_64, documentation for a certain operator% looks like this:

\subsubsection[{operator\%(const texpr1\+::builder \&a, const texpr1\+::builder \&b)}]{\setlength{\rightskip}{0pt plus 5cm}texpr1\+::builder operator\% (
\begin{DoxyParamCaption}
\item[{const texpr1\+::builder \&}]{a, }
\item[{const texpr1\+::builder \&}]{b}
\end{DoxyParamCaption}

That works fine.  However, in Rawhide, this is produced:

\subsubsection[{\texorpdfstring{operator\%(const texpr1\+::builder \&a, const texpr1\+::builder \&b)}{operator%(const texpr1::builder &a, const texpr1::builder &b)}}]{\setlength{\rightskip}{0pt plus 5cm}texpr1\+::builder operator\% (
\begin{DoxyParamCaption}
\item[{const texpr1\+::builder \&}]{a, }
\item[{const texpr1\+::builder \&}]{b}
\end{DoxyParamCaption}

The unescaped percent sign in the second argument to \texorpdfstring turns the rest of the line into a comment, leading to a LaTeX error.

Version-Release number of selected component (if applicable):
doxygen-1.8.11-1.fc24.x86_64

How reproducible:
Always

Steps to Reproduce:
1. svn co svn://scm.gforge.inria.fr/svnroot/apron/apron/trunk apron
2. cd apron
3. make && make doc

Actual results:
Runaway argument?
{\texorpdfstring {operator\%(const texpr0\+::builder \&a, const texpr\ETC.
! Paragraph ended before \@sect was complete.
<to be read again> 
                   \par 
l.1954 
       
? 
! Emergency stop.
<to be read again> 
                   \par 
l.1954 
       
!  ==> Fatal error occurred, no output PDF file produced!


Expected results:
Successful build of the documentation.

Additional info:

Comment 1 Than Ngo 2016-02-12 17:19:11 UTC
i'm looking at this. thanks for the report

Comment 2 Than Ngo 2016-02-22 12:37:51 UTC
it should be fixed in http://koji.fedoraproject.org/koji/taskinfo?taskID=13092247

Comment 3 Jerry James 2016-02-22 15:06:54 UTC
Excellent!  I will try it out tonight.  Thanks for the quick action on this bug.

Comment 4 Jerry James 2016-02-23 04:17:25 UTC
That does not appear to have fixed the problem.  I built apron in mock without the workaround for this bug, and got the same unescaped %.  root.log shows that the build root contains doxygen-1.8.11-3.fc24, which is the version in the link from comment 2.

Comment 5 Jan Kurik 2016-02-24 15:39:30 UTC
This bug appears to have been reported against 'rawhide' during the Fedora 24 development cycle.
Changing version to '24'.

More information and reason for this action is here:
https://fedoraproject.org/wiki/Fedora_Program_Management/HouseKeeping/Fedora24#Rawhide_Rebase

Comment 6 Than Ngo 2016-02-29 09:35:48 UTC
(In reply to Jerry James from comment #4)
> That does not appear to have fixed the problem.  I built apron in mock
> without the workaround for this bug, and got the same unescaped %.  root.log
> shows that the build root contains doxygen-1.8.11-3.fc24, which is the
> version in the link from comment 2.

thanks for your feedback, i'm investigating why the fix doesn't work.

Comment 7 Than Ngo 2016-03-06 13:51:05 UTC
this issue is fixed in doxygen-1.8.11-4. I removed your workaround in apron package and built it against doxygen-1.8.11-4 in rawhide without any problem.

http://koji.fedoraproject.org/koji/taskinfo?taskID=13249998

Comment 8 Jerry James 2016-03-06 18:10:54 UTC
Thanks so much.  I appreciate your work on this issue.