From 764c7ae949a502be0bf8c3c75120b6bfbfa13eb4 Mon Sep 17 00:00:00 2001 From: Aiden Grossman Date: Sat, 21 Oct 2023 02:11:15 -0700 Subject: [PATCH 1/3] [Github] Remove CMake options from docs CI resetting defaults The SPHINX_OUTPUT_HTML and SPHINX_OUTPUT_MAN CMake flags are by default set to ON/True in ./llvm/cmake/modules/FindSphinx.cmake, so we don't need to set them true again within the CMake invocation. --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 8eadd382398089..2900f73c77c5a6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -62,11 +62,11 @@ jobs: - name: Build LLVM docs if: steps.docs-changed-subprojects.outputs.llvm_any_changed == 'true' run: | - cmake -B llvm-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_SPHINX=ON -DSPHINX_OUTPUT_HTML=ON -DSPHINX_OUTPUT_MAN=ON ./llvm + cmake -B llvm-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_SPHINX=ON ./llvm TZ=UTC ninja -C llvm-build docs-llvm-html docs-llvm-man - name: Build Clang docs if: steps.docs-changed-subprojects.outputs.clang_any_changed == 'true' run: | - cmake -B clang-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang" -DLLVM_ENABLE_SPHINX=ON -DSPHINX_OUTPUT_HTML=ON -DSPHINX_OUTPUT_MAN=ON ./llvm + cmake -B clang-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang" -DLLVM_ENABLE_SPHINX=ON ./llvm TZ=UTC ninja -C clang-build docs-clang-html docs-clang-man From c779120a6dc6d2fc28b2d2dc51195808ae67a6f3 Mon Sep 17 00:00:00 2001 From: Aiden Grossman Date: Sat, 21 Oct 2023 02:52:24 -0700 Subject: [PATCH 2/3] [Github] Add libunwind to docs CI This patch adds the libunwind docs to the Github docs action which enables easy triage of docs build failures in Github PRs. There is already buildbot coverage of this configuration, but it is much less convenient to use in PRs. --- .github/workflows/docs.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 2900f73c77c5a6..f9693f4390a3a5 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,10 +15,12 @@ on: paths: - 'llvm/docs/**' - 'clang/docs/**' + - 'libunwind/docs/**' pull_request: paths: - 'llvm/docs/**' - 'clang/docs/**' + - 'libunwind/docs/**' jobs: check-docs-build: @@ -47,6 +49,8 @@ jobs: - 'llvm/docs/**' clang: - 'clang/docs/**' + libunwind: + - 'libunwind/docs/**' - name: Setup Python env uses: actions/setup-python@v4 with: @@ -69,4 +73,9 @@ jobs: run: | cmake -B clang-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang" -DLLVM_ENABLE_SPHINX=ON ./llvm TZ=UTC ninja -C clang-build docs-clang-html docs-clang-man + - name: Build libunwind docs + if: steps.docs-changed-subprojects.outputs.libunwind_any_changed == 'true' + run: | + cmake -B libunwind-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_RUNTIMES="libunwind" -DLLVM_ENABLE_SPHINX=ON ./runtimes + TZ=UTC ninja -C libunwind-build docs-libunwind-html From de27e99c8d8635b898800c69287bcc952999c25a Mon Sep 17 00:00:00 2001 From: Aiden Grossman Date: Sat, 21 Oct 2023 02:54:23 -0700 Subject: [PATCH 3/3] docs test change --- libunwind/docs/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/libunwind/docs/index.rst b/libunwind/docs/index.rst index 7126d02abd2960..071954cf01b754 100644 --- a/libunwind/docs/index.rst +++ b/libunwind/docs/index.rst @@ -7,6 +7,8 @@ libunwind LLVM Unwinder Overview ======== +This is just a test + libunwind is an implementation of the interface defined by the HP libunwind project. It was contributed by Apple as a way to enable clang++ to port to platforms that do not have a system unwinder. It is intended to be a small and