Bug 408129 – x11-libs/qt-assistant doesn't show qml.qch, qtcreator.qch nor qtcreator-dev.qch in doc list by default

• Status: RESOLVED WONTFIX
• Product: Gentoo Linux

[Description Jaak Ristioja 2012-03-14 08:10:53 UTC]

Qt creator 2.4.1 installs its documentation to:
  /usr/share/doc/qtcreator/qtcreator.qch.bz2
  /usr/share/doc/qtcreator/qtcreator-dev.qch.bz2

Qt 4.7.4 installs its documentation to:
  /usr/share/doc/qt-4.7.4/qch/designer.qch
  /usr/share/doc/qt-4.7.4/qch/linguist.qch
  /usr/share/doc/qt-4.7.4/qch/qml.qch
  /usr/share/doc/qt-4.7.4/qch/assistant.qch
  /usr/share/doc/qt-4.7.4/qch/qmake.qch
  /usr/share/doc/qt-4.7.4/qch/qt.qch

It appears, that by default, assistant does not show documentation the qt-creator documentation nor the documentation from qml.qch. It should.

[Comment 1 Davide Pesavento (RETIRED) 2012-03-14 18:39:32 UTC]

(In reply to comment #0)
> Qt creator 2.4.1 installs its documentation to:
>   /usr/share/doc/qtcreator/qtcreator.qch.bz2
>   /usr/share/doc/qtcreator/qtcreator-dev.qch.bz2
> 

First of all, these files should not be compressed with bzip2.

[Comment 2 Davide Pesavento (RETIRED) 2012-03-15 18:17:21 UTC]

As far as qml.qch is concerned, it works here. If it doesn't appear in the doc list, you should add it: go to Edit -> Preferences -> Documentation -> Add.

[Comment 3 Jaak Ristioja 2012-03-15 18:51:22 UTC]

(In reply to comment #2)
> As far as qml.qch is concerned, it works here. If it doesn't appear in the
> doc list, you should add it: go to Edit -> Preferences -> Documentation ->
> Add.

Shouldn't it be there by default?

[Comment 4 Davide Pesavento (RETIRED) 2012-03-15 21:06:41 UTC]

The first part of this bug (bzip2 compression of qch files) is now fixed in CVS.

[Comment 5 Davide Pesavento (RETIRED) 2012-03-15 23:42:02 UTC]

Created attachment 305563 [details, diff]
qt-assistant-add-qml-docs-by-default.patch

For the second issue, could you try and see if this patch (against qt-assistant) works for you, please?

[Comment 6 Jaak Ristioja 2012-03-16 16:23:46 UTC]

(In reply to comment #4)
> The first part of this bug (bzip2 compression of qch files) is now fixed in
> CVS.

The Changelog reads "Fix installation of qch files (bug #408129) and cleanup usage of prefix variables. Remove old." but the *.qch files still get installed compressed with bzip2:

  /usr/share/doc/qt-creator-2.4.1/qtcreator-dev.qch.bz2
  /usr/share/doc/qt-creator-2.4.1/qtcreator.qch.bz2

(In reply to comment #5)
> Created attachment 305563 [details, diff] [details, diff]
> qt-assistant-add-qml-docs-by-default.patch
> 
> For the second issue, could you try and see if this patch (against
> qt-assistant) works for you, please?

I tested the patch with qt-assistant-4.7.4 and after removing the "~/.local/share/data/Trolltech/Assistant" folder. I can confirm, that the QML docs now do appear, but the qt-creator docs still do not appear.

[Comment 7 Davide Pesavento (RETIRED) 2012-03-17 11:01:36 UTC]

(In reply to comment #6)
> (In reply to comment #4)
> > The first part of this bug (bzip2 compression of qch files) is now fixed in
> > CVS.
> 
> The Changelog reads "Fix installation of qch files (bug #408129) and cleanup
> usage of prefix variables. Remove old." but the *.qch files still get
> installed compressed with bzip2:
> 
>   /usr/share/doc/qt-creator-2.4.1/qtcreator-dev.qch.bz2
>   /usr/share/doc/qt-creator-2.4.1/qtcreator.qch.bz2
> 

Sorry, I forgot the 'docompress -x' call, should be fixed now, retry in a couple of hours.

> (In reply to comment #5)
> > Created attachment 305563 [details, diff] [details, diff] [details, diff]
> > qt-assistant-add-qml-docs-by-default.patch
> > 
> > For the second issue, could you try and see if this patch (against
> > qt-assistant) works for you, please?
> 
> I tested the patch with qt-assistant-4.7.4 and after removing the
> "~/.local/share/data/Trolltech/Assistant" folder. I can confirm, that the
> QML docs now do appear, but the qt-creator docs still do not appear.

Great, thanks a lot for testing!

[Comment 8 David E. Narváez 2012-04-16 05:32:41 UTC]

Created attachment 309115 [details]
List of files installed by qt-assistant-4.8.1-r1

It looks like qt-assistant-4.8.1-r1 still does funky stuff with qch files. I had to bunzip2 all files in /usr/share/doc/qt-4.8.0/qch and ln -s the qch dir in /usr/share/doc/qt-4.8.1/

[Comment 9 Davide Pesavento (RETIRED) 2012-04-16 10:53:30 UTC]

qt-assistant-4.8.1-r1 should install the documentation into '/usr/share/doc/qt-4.8.1', not '/usr/share/doc/qt-4.8.0'. Are you sure this is qt-assistant-4.8.1-r1?

[Comment 10 David E. Narváez 2012-04-18 05:24:19 UTC]

(In reply to comment #9)
> qt-assistant-4.8.1-r1 should install the documentation into
> '/usr/share/doc/qt-4.8.1', not '/usr/share/doc/qt-4.8.0'. Are you sure this
> is qt-assistant-4.8.1-r1?

Yes, I'm sure, yet I re-emerged qt-assistant and it now installed everything in the right place and bunzipped, so disregard my previous comment. Something similar happened to me before with qt-webkit-4.8.0, so I guess I'll have to emerge qt stuff a couple of times before reporting bugs.

[Comment 11 Davide Pesavento (RETIRED) 2012-06-22 13:48:33 UTC]

(In reply to comment #5)
> Created attachment 305563 [details, diff] [details, diff]
> qt-assistant-add-qml-docs-by-default.patch
> 

Patch submitted upstream.

[Comment 12 Davide Pesavento (RETIRED) 2012-12-25 20:51:29 UTC]

Upstream rejected the patch saying that qml.qch is a duplication of content already present in qt.qch, and I agree, just use qt.qch please.