Bug 209861 - New Port: misc/qt5-doc: Qt5 API documentation for use with IDEs such as qtcreator or kdevelop
Summary: New Port: misc/qt5-doc: Qt5 API documentation for use with IDEs such as qtcre...
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Kurt Jaeger
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2016-05-30 13:02 UTC by Marie Loise Nolden
Modified: 2016-05-31 18:04 UTC (History)
5 users (show)

See Also:


Attachments
svn diff against ports HEAD for qt5-doc (685.51 KB, patch)
2016-05-30 13:02 UTC, Marie Loise Nolden
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Marie Loise Nolden 2016-05-30 13:02:14 UTC
Created attachment 170824 [details]
svn diff against ports HEAD for qt5-doc

This port builds and installs the Qt5 API documentation for use with IDEs such as qtcreator or kdevelop in qch file format and HTML file format.

Limitations: The port is made for Qt 5.5.1 and excludes the documentation for qtwebkit, qtwebkit-examples and qtwebengine. The reasons are, webkit is deprecated and should not be used for further development, it will not be part of the Qt 5.6.x sources by default and only provided on FreeBSD for backwards compatibility with ports. API documentation may be later added to the qt5-webkit port (as well for qtwebkit-examples). The qtwebengine hasn't been ported to FreeBSD yet, so no documenation can be generated either.

The build process uses the full qt source tarball and uses configure with the respective platform (freebsd-g++ or freebsd-clang). During configure, the qmake tool is compiled that generates the Makefiles for doc creation. While the qt5-qmake could also be used, it currently generates the documentation without the correct links and replaces them with text, which makes the API documentation useless with respect to the workflow. The compiling of qmake has been accepted for now as a minor drawback of the port.

Build tested with poudriere on 9.3, 10.3 and 11-current.
Comment 1 Kurt Jaeger freebsd_committer freebsd_triage 2016-05-30 16:06:09 UTC
testbuilds@work
Comment 2 commit-hook freebsd_committer freebsd_triage 2016-05-31 18:03:11 UTC
A commit references this bug:

Author: pi
Date: Tue May 31 18:02:43 UTC 2016
New revision: 416213
URL: https://svnweb.freebsd.org/changeset/ports/416213

Log:
  New port: misc/qt5-doc

  This port builds and installs the Qt5 API documentation for use
  with IDEs such as qtcreator or kdevelop in qch file format and HTML
  file format.

  Limitations: The port is made for Qt 5.5.1 and excludes the
  documentation for qtwebkit, qtwebkit-examples and qtwebengine. The
  reasons are, webkit is deprecated and should not be used for further
  development, it will not be part of the Qt 5.6.x sources by default
  and only provided on FreeBSD for backwards compatibility with ports.
  API documentation may be later added to the qt5-webkit port (as
  well for qtwebkit-examples). The qtwebengine hasn't been ported to
  FreeBSD yet, so no documenation can be generated either.

  The build process uses the full qt source tarball and uses configure
  with the respective platform (freebsd-g++ or freebsd-clang). During
  configure, the qmake tool is compiled that generates the Makefiles
  for doc creation. While the qt5-qmake could also be used, it currently
  generates the documentation without the correct links and replaces
  them with text, which makes the API documentation useless with
  respect to the workflow. The compiling of qmake has been accepted
  for now as a minor drawback of the port.

  PR:		209861
  Submitted by:	Ralf Nolden <nolden@kde.org> (kde)

Changes:
  head/misc/Makefile
  head/misc/qt5-doc/
  head/misc/qt5-doc/Makefile
  head/misc/qt5-doc/distinfo
  head/misc/qt5-doc/pkg-plist
Comment 3 Kurt Jaeger freebsd_committer freebsd_triage 2016-05-31 18:04:02 UTC
Committed, thanks!