Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[qt] Documentation is missing #43792

Open
OrkunTokdemir opened this issue Feb 12, 2025 · 5 comments
Open

[qt] Documentation is missing #43792

OrkunTokdemir opened this issue Feb 12, 2025 · 5 comments
Assignees
Labels
category:port-feature The issue is with a library, which is requesting new capabilities that didn’t exist

Comments

@OrkunTokdemir
Copy link

I have 6.8.0 installed by running vcpkg install qt. The installation doesn't have the documentation. Normally, the documentation exists under Docs/Qt-6.8.1 when it is installed via Maintenance tool.

The other problem is that qtpaths -query shows an incorrect path for QT_INSTALL_DOCS

./packages/qtbase_x64-linux/tools/Qt6/bin/qtpaths -query
QT_SYSROOT:
QT_INSTALL_PREFIX:/home/orkun/vcpkg/packages/qtbase_x64-linux
QT_INSTALL_ARCHDATA:/home/orkun/vcpkg/packages/qtbase_x64-linux/share/Qt6
QT_INSTALL_DATA:/home/orkun/vcpkg/packages/qtbase_x64-linux/share/Qt6
QT_INSTALL_DOCS:/home/orkun/vcpkg/packages/qtbase_x64-linux/doc/Qt6
QT_INSTALL_HEADERS:/home/orkun/vcpkg/packages/qtbase_x64-linux/include/Qt6
QT_INSTALL_LIBS:/home/orkun/vcpkg/packages/qtbase_x64-linux/lib
QT_INSTALL_LIBEXECS:/home/orkun/vcpkg/packages/qtbase_x64-linux/tools/Qt6/bin
QT_INSTALL_BINS:/home/orkun/vcpkg/packages/qtbase_x64-linux/bin
QT_INSTALL_TESTS:/home/orkun/vcpkg/packages/qtbase_x64-linux/tests
QT_INSTALL_PLUGINS:/home/orkun/vcpkg/packages/qtbase_x64-linux/Qt6/plugins
QT_INSTALL_QML:/home/orkun/vcpkg/packages/qtbase_x64-linux/Qt6/qml
QT_INSTALL_TRANSLATIONS:/home/orkun/vcpkg/packages/qtbase_x64-linux/translations/Qt6
QT_INSTALL_CONFIGURATION:
QT_INSTALL_EXAMPLES:/home/orkun/vcpkg/packages/qtbase_x64-linux/share/examples/Qt6
QT_INSTALL_DEMOS:/home/orkun/vcpkg/packages/qtbase_x64-linux/share/examples/Qt6
QT_HOST_PREFIX:/home/orkun/vcpkg/packages/qtbase_x64-linux
QT_HOST_DATA:/home/orkun/vcpkg/packages/qtbase_x64-linux/share/Qt6
QT_HOST_BINS:/home/orkun/vcpkg/packages/qtbase_x64-linux/bin
QT_HOST_LIBEXECS:/home/orkun/vcpkg/packages/qtbase_x64-linux/tools/Qt6/bin
QT_HOST_LIBS:/home/orkun/vcpkg/packages/qtbase_x64-linux/lib
QMAKE_SPEC:linux-g++
QMAKE_XSPEC:linux-g++
QMAKE_VERSION:3.1
QT_VERSION:6.8.0

/home/orkun/vcpkg/packages/qtbase_x64-linux/doc/Qt6 has the wrong files instead of the documentation.

ll /home/orkun/vcpkg/packages/qtbase_x64-linux/doc/Qt6

total 8,0K
drwxr-xr-x 2 orkun orkun 4,0K Nov 27 12:50 config
drwxr-xr-x 7 orkun orkun 4,0K Nov 27 12:50 global
@Neumann-A
Copy link
Contributor

vcpkg does not install docs or man pages by default.

@Cheney-W Cheney-W self-assigned this Feb 13, 2025
@OrkunTokdemir
Copy link
Author

@Neumann-A I'm working on https://github.com/qt-labs/vscodeext and we will add some new features which use documentation in the installation. We also support vcpkg installations, but some documentation-related features would be broken if the documentation doesn't exist. Providing the documentation would ensure a smoother experience on our end.

@Neumann-A
Copy link
Contributor

So you want thousands of people spending time and space rebuilding already existing easily available online docs?
For me that seems like the totally wrong approach. Also it is not so easy to build qtdoc. If i remember correctly it needs all the sources of all other qtmodules being available.

@OrkunTokdemir
Copy link
Author

So you want thousands of people spending time and space rebuilding already existing easily available online docs?

Can it not be made optional so that only people interested build it?

@Neumann-A
Copy link
Contributor

Can it not be made optional so that only people interested build it?

You can probably add it as a feature to qtdoc somehow..... however, it still would need approval from the ms maintainers.

@Cheney-W Cheney-W added the category:port-feature The issue is with a library, which is requesting new capabilities that didn’t exist label Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category:port-feature The issue is with a library, which is requesting new capabilities that didn’t exist
Projects
None yet
Development

No branches or pull requests

3 participants