AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
7833b604b6
qt5base-lts/coin/instructions/cmake_documentation_build.yaml

39 lines
1.5 KiB
YAML
Raw Normal View History

Add instructions to build documentation This enables documentation building in add-ons and other modules that need to build docs. Task-number: QTQAINFRA-3972 Change-Id: Ic2763d6d36d26e5a1267b312727c3c268ad6d114 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> (cherry picked from commit e84e85dd4c59f2c79f81ba4d8d7f04397eb0003c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
2020-10-27 13:01:16 +00:00
type: Group
instructions:
- type: ChangeDirectory
Adjust documentation build dir for out of source builds As the build dir was changed the location of CMake build files changed, which resulted in "could not load cache" error. Change-Id: I97d55d060bfab08ab54d1b15d9eabbede1776155 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
2022-06-23 07:09:06 +00:00
directory: "{{.SourceDir}}_build"
Build docs in-tree The actual module build is done in-tree and after this attempting to do shadow build of the dirty source directory causes issues in some modules. Pick-to: 6.2 Change-Id: I74bca186b238c5c1f10576b4f821efdf66b827ed Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
2021-11-10 11:26:56 +00:00
# If documentation feature is present, Coin installs top-level documentation
# built by product(qt5) build into <module_name>_doc_build/doc. Coin will
# silently omit installing the top-level documentations if not built by the product.
Add instructions to build documentation This enables documentation building in add-ons and other modules that need to build docs. Task-number: QTQAINFRA-3972 Change-Id: Ic2763d6d36d26e5a1267b312727c3c268ad6d114 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> (cherry picked from commit e84e85dd4c59f2c79f81ba4d8d7f04397eb0003c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
2020-10-27 13:01:16 +00:00
- type: ExecuteCommand
Adjust documentation build dir for out of source builds As the build dir was changed the location of CMake build files changed, which resulted in "could not load cache" error. Change-Id: I97d55d060bfab08ab54d1b15d9eabbede1776155 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
2022-06-23 07:09:06 +00:00
command: "rsync -a {{.SourceDir}}_doc_build/doc {{.SourceDir}}_build"
Add instructions to build documentation This enables documentation building in add-ons and other modules that need to build docs. Task-number: QTQAINFRA-3972 Change-Id: Ic2763d6d36d26e5a1267b312727c3c268ad6d114 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> (cherry picked from commit e84e85dd4c59f2c79f81ba4d8d7f04397eb0003c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
2020-10-27 13:01:16 +00:00
maxTimeInSeconds: 300
maxTimeBetweenOutput: 300
Build docs in-tree The actual module build is done in-tree and after this attempting to do shadow build of the dirty source directory causes issues in some modules. Pick-to: 6.2 Change-Id: I74bca186b238c5c1f10576b4f821efdf66b827ed Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
2021-11-10 11:26:56 +00:00
userMessageOnFailure: Failed to copy top-level docs to build dir.
# Filter list is created to exclude everything else than the
# generated documentation from the documentation archive.
Add instructions to build documentation This enables documentation building in add-ons and other modules that need to build docs. Task-number: QTQAINFRA-3972 Change-Id: Ic2763d6d36d26e5a1267b312727c3c268ad6d114 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> (cherry picked from commit e84e85dd4c59f2c79f81ba4d8d7f04397eb0003c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
2020-10-27 13:01:16 +00:00
- type: CreateFileListFromDirectory
Adjust documentation build dir for out of source builds As the build dir was changed the location of CMake build files changed, which resulted in "could not load cache" error. Change-Id: I97d55d060bfab08ab54d1b15d9eabbede1776155 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
2022-06-23 07:09:06 +00:00
directory: "{{.SourceDir}}_build/doc"
Add instructions to build documentation This enables documentation building in add-ons and other modules that need to build docs. Task-number: QTQAINFRA-3972 Change-Id: Ic2763d6d36d26e5a1267b312727c3c268ad6d114 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> (cherry picked from commit e84e85dd4c59f2c79f81ba4d8d7f04397eb0003c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
2020-10-27 13:01:16 +00:00
filterListFileName: "doc_build_filter"
userMessageOnFailure: "Failed to create filter list for docs"
- type: ExecuteCommand
Update the COIN build instructions to also build creator help file Changed the cmake build target from "generate_docs" to "docs" Pick-to: 6.1 Fixes: QTBUG-93174 Change-Id: I244290888f578ccfee4c733cd8f93bb6faed4fda Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2021-05-07 10:21:26 +00:00
command: "{{.Env.ENV_PREFIX}} cmake --build . --target docs -v"
Add instructions to build documentation This enables documentation building in add-ons and other modules that need to build docs. Task-number: QTQAINFRA-3972 Change-Id: Ic2763d6d36d26e5a1267b312727c3c268ad6d114 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> (cherry picked from commit e84e85dd4c59f2c79f81ba4d8d7f04397eb0003c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
2020-10-27 13:01:16 +00:00
maxTimeInSeconds: 6000
maxTimeBetweenOutput: 1200
userMessageOnFailure: Failed to generate documentation.
- type: UploadArtifact
Adjust documentation build dir for out of source builds As the build dir was changed the location of CMake build files changed, which resulted in "could not load cache" error. Change-Id: I97d55d060bfab08ab54d1b15d9eabbede1776155 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
2022-06-23 07:09:06 +00:00
archiveDirectory: "{{.SourceDir}}_build/doc"
Add instructions to build documentation This enables documentation building in add-ons and other modules that need to build docs. Task-number: QTQAINFRA-3972 Change-Id: Ic2763d6d36d26e5a1267b312727c3c268ad6d114 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> (cherry picked from commit e84e85dd4c59f2c79f81ba4d8d7f04397eb0003c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
2020-10-27 13:01:16 +00:00
transferType: UploadModuleDocumentation
filterListFileName: "doc_build_filter"
maxTimeInSeconds: 1200
maxTimeBetweenOutput: 1200
enable_if:
condition: and
conditions:
- condition: property
property: features
contains_value: Documentation
- condition: runtime
env_var: BUILD_DOCUMENTATION
not_equals_value: null
Reference in New Issue Copy Permalink