diff options
| author | Toni Saario <toni.saario@qt.io> | 2021-11-10 13:26:56 +0200 |
|---|---|---|
| committer | Toni Saario <toni.saario@qt.io> | 2021-11-12 16:44:22 +0000 |
| commit | 98e1760d2e54cdc446e0d966511c4e899f14427d (patch) | |
| tree | 8912a3d4f9139ab8fd1ffc1fedf2d5421ad26273 /coin | |
| parent | e6e8c59485b8ba8dda9b6bfd203fb1c68f1c2e47 (diff) | |
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>
Diffstat (limited to 'coin')
| -rw-r--r-- | coin/instructions/cmake_documentation_build.yaml | 23 |
1 files changed, 10 insertions, 13 deletions
diff --git a/coin/instructions/cmake_documentation_build.yaml b/coin/instructions/cmake_documentation_build.yaml index 141d0b65b3..2675e63c48 100644 --- a/coin/instructions/cmake_documentation_build.yaml +++ b/coin/instructions/cmake_documentation_build.yaml @@ -1,31 +1,28 @@ type: Group instructions: - - type: MakeDirectory - directory: "{{.SourceDir}}_doc_build" - - type: SetBuildDirectory - directory: "{{.SourceDir}}_doc_build" - type: ChangeDirectory - directory: "{{.BuildDir}}" + directory: "{{.SourceDir}}" + # 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. - type: ExecuteCommand - command: "rm -f {{.SourceDir}}/CMakeCache.txt" # CMake configure does not apply if not removed. + command: "rsync -a {{.SourceDir}}_doc_build/doc {{.SourceDir}}" maxTimeInSeconds: 300 maxTimeBetweenOutput: 300 - userMessageOnFailure: Failed to remove CMake cache. + 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. - type: CreateFileListFromDirectory - directory: "{{.BuildDir}}/doc" + directory: "{{.SourceDir}}/doc" filterListFileName: "doc_build_filter" userMessageOnFailure: "Failed to create filter list for docs" - - type: EnvironmentVariable - variableName: COIN_CMAKE_ARGS - variableValue: "-DCMAKE_INSTALL_PREFIX:PATH={{.InstallDir}} {{.SourceDir}}" - - !include "{{qt/qtbase}}/call_cmake.yaml" - type: ExecuteCommand command: "{{.Env.ENV_PREFIX}} cmake --build . --target docs -v" maxTimeInSeconds: 6000 maxTimeBetweenOutput: 1200 userMessageOnFailure: Failed to generate documentation. - type: UploadArtifact - archiveDirectory: "{{.BuildDir}}/doc" + archiveDirectory: "{{.SourceDir}}/doc" transferType: UploadModuleDocumentation filterListFileName: "doc_build_filter" maxTimeInSeconds: 1200 |