Adapt LLVM_ENABLE_RUNTIMES change for Doxygen documentation builders

[Meinersbur]

The builder publish-doxygen-docs uses LLVM_ENABLE_PROJECT=openmp to build the doxygen documention. This build mode is scheduled to be removed in llvm/llvm-project#176950. Introduce a new builder publish-runtimes-doxygen-docs which uses LLVM_ENABLE_RUNTIMES=openmp instead.

In contrast to publish-sphinx-docs, there is no support yet for building doxygen documentation of a runtimes project. Support in llvm-project was added in llvm/llvm-project#176948. For llvm-zorg, this PR replicates the same approach as a5243cf: Create new publish-runtimes-doxygen-docs builder that builds the runtimes.

I verified this PR -- except the rsync step -- using a private buildbot master and worker (as-worker-4) instance.

[boomanaiden154]

This seems fine to me. But someone with access to as-worker-4 also needs to approve.

[boomanaiden154]

Why do all the words here need to be separate strings?

[Meinersbur]

I don't think they need to, but I am avoiding changes from the template

llvm-zorg/zorg/buildbot/builders/DoxygenDocsBuilder.py

Lines 104 to 107 in 617ab43

	description=[
	"Publish", "just", "built", "documentation", "for",
	"{}".format(project or target)
	],

without reason

[gkistanova]

Because buildbot takes care of the formatting like new lines, truncations and alike.

[Meinersbur]

This seems fine to me. But someone with access to as-worker-4 also needs to approve.

@gkistanova Please review

[andreil99]

Thanks for the effort, Michael.

We do not plan to run multiple doxygen builders on that host. So, this patch would not go as is. Sorry for this.

If you can make sure that openmp doxygen docs get built with LLVM_ENABLE_RUNTIMES and ninja doxygen that would help a lot. I'll take it from there and will change the builder accordingly.

[gkistanova]

@Meinersbur What Andrei said.

To unblock you I temporarily removed openmp from the doxygen builder. Could you follow up with Andrei when everything is ready to build doxygen after the migration is done, please?

[Meinersbur]

Why is multiple sphinx builders OK, but not doxygen? (out of curiosity, not complaining)

I could make something like

if (TARGET doxygen-openmp) # doxygen-openmp forwarded by llvm_ExternalProject_Add
  add_dependencies(doxygen doxygen-openmp)
endif ()

But this sticks out because e.g. the sphinx target does not work this way. I am preparing a PR anyway.

@gkistanova Thanks for the unblocking

[Meinersbur]

@andreil99 Requested change has landed: llvm/llvm-project#178298. You are going to make the llvm-zorg changes?

Note that by how the LLVM doxygen build works, you must define -DLLVM_ENABLE_RUNTIMES=openmp -DLLVM_ENABLE_DOXYGEN=ON -DLLVM_INCLUDE_DOCS=ON -DLLVM_BUILD_DOCS=ON (all four) for ninja doxygen to be available. You can also ninja doxygen-openmp. The files will be in runtimes/runtimes-bins/openmp/docs/doxygen.

Since it needs to run runtimes-configure first to create the runtimes build directory, it will also build clang (to pass as CMAKE_C(XX)_COMPILER), etc..

[andreil99]

@Meinersbur Thanks, Michael. I'll take it from there.

[andreil99]

Why is multiple sphinx builders OK, but not doxygen? (out of curiosity, not complaining)

Sphinx build is relatively fast and lightweight. Doxygen is quite the opposite. It is Ok to have Sphinx and Doxygen simultaneously building, but two Doxygen builds is too much. Serializing all the builds would significantly delay Sphinx build results.

[Meinersbur]

Closing this PR since @andreil99 is going to fix the OpenMP doxygen builder