After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 671591 - PATCH - docset creation failed - Nodes.xml with invalid format
PATCH - docset creation failed - Nodes.xml with invalid format
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.0
Other Mac OS
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2012-03-07 19:48 UTC by H.Abraham
Modified: 2012-05-19 12:26 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Sample to reproduce the bug and a patch to fix the bug (1.89 KB, application/x-gzip)
2012-03-07 19:48 UTC, H.Abraham 		Details
DocSet-Bug UnitTest and a patch to solve the bug (2.54 KB, application/x-gzip)
2012-03-11 11:46 UTC, H.Abraham 		Details
3 new UnitTests and a patch to fix the bug (2.54 KB, application/x-gzip)
2012-03-11 11:52 UTC, H.Abraham 		Details

Description H.Abraham 2012-03-07 19:48:04 UTC 
Created attachment 209203 [details]
Sample to reproduce the bug and a patch to fix the bug

General:
- Mac OS X 10.7.2
- Xcode 4.3 (installed from App Store, installed under /Applications/Xcode.app)
- Doxygen 1.8.0 (24. Feb 2012)


Steps to reproduce the bug:
- see simple Demo-Project (attached)
- start "make clean && make"
  - Makefile create simple own doxygen.cfg
  - Makefile create (successful) html help
  - Makefile switch into "html" folder to create docset
  - creation of docset failed, error message:
    docsetutil[6376:403] Error converting XML to CoreData: Error Domain=NSXMLParserErrorDomain 
    Code=76 "Line 76: Opening and ending tag mismatch: Subnodes line 0 and Node


Bug-Description:
- Same sample project works well with doxygen-1.7.5
- Bug is located in "html/Nodes.xml" - the xml-Tags are missmatched sorted, in detail:
  <?xml version="1.0" encoding="UTF-8"?>
    <DocSetNodes version="1.0">
      <TOC>
        ...
          </Subnodes>
         </Node>  <-------- INVALID TAG
        </Subnodes>
      </Node>    
    </TOC>
  </DocSetNodes>
  
- The bug is located in the source "src/docset.cpp void DocSets::finalize()"
  
  

Patch:
- I append a patch for this bug:
  docset_xml_tag_patch.patch
Comment 1 Dimitri van Heesch 2012-03-07 20:43:10 UTC 
Thanks, I'll include the patch in the next subversion update.
Comment 2 H.Abraham 2012-03-11 11:46:42 UTC 
Created attachment 209427 [details]
DocSet-Bug UnitTest and a patch to solve the bug

I attach 3 UnitTest and a new patch. The path works well with all 3 test scenarios. To start the UnitTest a shipped a makefile.
Comment 3 H.Abraham 2012-03-11 11:52:32 UTC 
Created attachment 209428 [details]
3 new UnitTests and a patch to fix the bug
Comment 4 H.Abraham 2012-03-11 11:58:01 UTC 
Additional information to the last commit message: 
- the first patch (2012-03-07) works only well, if the page not contains a "related page" section.

- I add 3 small UnitTest
  - one with a small page, like the bug description from (2012-03-07)
  - one with a project, that contains a "related page" section
  - one with a project, that contains a "modules page"
- The new path (2012-03-11 12:52) works well with all 3 tests. The old patch works only well with the first
Comment 5 Dimitri van Heesch 2012-05-19 12:26:59 UTC 
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.1. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.