Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-26880

Unable to generate documentation

    XMLWordPrintable

Details

    • Bug
    • Resolution: Cannot Reproduce
    • P0: Blocker
    • None
    • 5.0.0 Beta 1
    • Documentation
    • None

    Description

      Documentation generation fails during source packaging using mksrc.sh script. Below is the part that is used to do this:
      CUR_DIR = working dir for the script
      PACKAGE_NAME = 'qt-everywhere..'
      if [ $DOCS = generate ]; then

      1. Make a copy of the source tree
        DOC_BUILD=$CUR_DIR/doc-build
        mkdir -p $DOC_BUILD
        cp -R $CUR_DIR/$PACKAGE_NAME $DOC_BUILD
        cd $DOC_BUILD/$PACKAGE_NAME
      2. Build bootstrapped qdoc
        ./configure -developer-build -opensource -confirm-license -nomake examples -nomake tests -release
        (cd qtbase && make -j30 sub-tools-bootstrap && make -j30 sub-qdoc)
      3. Run qmake in each module, as this generates the .pri files that tell qdoc what docs to generate
        QMAKE=$PWD/qtbase/bin/qmake
        for i in `cat $MODULES` ; do if [ -d $i -a -e $i/.pro ] ; then (cd $i ; $QMAKE ; cp module-paths/modules/.pri ../qtbase/module-paths/modules ) ; fi ; done
      4. Build libQtHelp.so and qhelpgenerator
        (cd qtbase && make -j30)
        (cd qtxmlpatterns ; make -j30)
        (cd qttools ; make -j30)
        (cd qttools/src/assistant/help ; make -j30)
        (cd qttools/src/assistant/qhelpgenerator ; make -j30)
      5. Generate the offline docs and qt.qch
        (cd qtdoc ; LD_LIBRARY_PATH=$PWD/../qttools/lib make -j30 qch_docs)
      6. Put the generated docs back into the clean source directory
        mv $DOC_BUILD/$PACKAGE_NAME/qtdoc/doc/html $CUR_DIR/$PACKAGE_NAME/qtdoc/doc
        mv $DOC_BUILD/$PACKAGE_NAME/qtdoc/doc/qch $CUR_DIR/$PACKAGE_NAME/qtdoc/qch
      7. Cleanup
        cd $CUR_DIR/$PACKAGE_NAME/
        #rm -rf $DOC_BUILD
        else
        echo " – Creating src files without generated offline documentation --"
        fi

      During the compilation of the sources, there are debug prints saying that it can't find most of the modules:
      Project MESSAGE: activeqt not found.
      Project MESSAGE: core : /data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qtbase/src/corelib
      Project MESSAGE: declarative not found.
      Project MESSAGE: doc : /data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qtdoc
      Project MESSAGE: clucene : /data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qttools/src/assistant/clucene
      Project MESSAGE: location not found.
      Project MESSAGE: multimedia not found.
      Project MESSAGE: phonon not found.
      Project MESSAGE: publishsubscribe not found.
      Project MESSAGE: 3d not found.
      Project MESSAGE: qml not found.
      Project MESSAGE: quick not found.
      Project MESSAGE: script not found.
      Project MESSAGE: sensors not found.
      Project MESSAGE: serviceframework not found.
      Project MESSAGE: systeminfo not found.
      Project MESSAGE: svg not found.
      Project MESSAGE: webkit not found.
      Project MESSAGE: webkit-examples-and-demos not found.
      Project MESSAGE: xmlpatterns : /data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qtxmlpatterns/src/xmlpatterns
      Project MESSAGE: contacts not found.
      Project MESSAGE: organizer not found.
      Project MESSAGE: versit not found.
      Project MESSAGE: bluetooth not found.

      And finally the compilations stops with following:
      /data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qtxmlpatterns/tools/xmlpatterns/qapplicationargumentparser.cpp:306: Cannot tie this documentation to anything
      [I found a /*! ... */ comment, but there was no topic command (e.g., '\fn', '\page') in the comment and no function definition following the comment.]
      /bin/sh: line 1: 18669 Segmentation fault QT_CORE_SOURCES=/data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qtbase/src/corelib QT_DOC_SOURCES=/data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qtdoc QT_CLUCENE_SOURCES=/data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qttools/src/assistant/clucene QT_XMLPATTERNS_SOURCES=/data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qtxmlpatterns/src/xmlpatterns QT_ACTIVEQT_QDOCCONF=modules/missing.qdocconf QT_CORE_QDOCCONF=modules/qtcore.qdocconf QT_DECLARATIVE_QDOCCONF=modules/missing.qdocconf QT_DOC_QDOCCONF=modules/qtdoc.qdocconf QT_CLUCENE_QDOCCONF=modules/qtclucene.qdocconf QT_LOCATION_QDOCCONF=modules/missing.qdocconf QT_MULTIMEDIA_QDOCCONF=modules/missing.qdocconf QT_PHONON_QDOCCONF=modules/missing.qdocconf QT_PUBLISHSUBSCRIBE_QDOCCONF=modules/missing.qdocconf QT_3D_QDOCCONF=modules/missing.qdocconf QT_QML_QDOCCONF=modules/missing.qdocconf QT_QUICK_QDOCCONF=modules/missing.qdocconf QT_SCRIPT_QDOCCONF=modules/missing.qdocconf QT_SENSORS_QDOCCONF=modules/missing.qdocconf QT_SERVICEFRAMEWORK_QDOCCONF=modules/missing.qdocconf QT_SYSTEMINFO_QDOCCONF=modules/missing.qdocconf QT_SVG_QDOCCONF=modules/missing.qdocconf QT_WEBKIT_QDOCCONF=modules/missing.qdocconf QT_WEBKIT_EXAMPLES_AND_DEMOS_QDOCCONF=modules/missing.qdocconf QT_XMLPATTERNS_QDOCCONF=modules/qtxmlpatterns.qdocconf QT_CONTACTS_QDOCCONF=modules/missing.qdocconf QT_ORGANIZER_QDOCCONF=modules/missing.qdocconf QT_VERSIT_QDOCCONF=modules/missing.qdocconf QT_BLUETOOTH_QDOCCONF=modules/missing.qdocconf MODULE_SOURCE_TREE=/data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qtdoc MODULE_BUILD_TREE=/data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qtdoc /data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qtbase/bin/qdoc /data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qtdoc/doc/config/qt-build-docs.qdocconf
      make[1]: *** [qch_docs] Error 139
      make[1]: Leaving directory `/data/bamboo/xml-data/build-dir/DQTC-RELBUILDQT500SRCPACK-SRCPKG/doc-build/qt-everywhere-commercial-src-5.0.0/qtdoc/doc'
      make: *** [sub-doc-qch_docs] Error 2

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            docteam Qt Documentation Team
            joaijala Johanna Äijälä
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes