From f1141ede97269589b8e28815a4cc8738c2ecc4c1 Mon Sep 17 00:00:00 2001 From: "Agarwal, Udit" Date: Mon, 23 Sep 2024 20:11:46 -0700 Subject: [PATCH 1/5] Remove doxygen docs from intel.github.io --- .github/workflows/sycl-docs.yml | 4 ---- sycl/doc/index.rst | 3 --- 2 files changed, 7 deletions(-) diff --git a/.github/workflows/sycl-docs.yml b/.github/workflows/sycl-docs.yml index cddf2bb5fe492..cf37bdc6079c5 100644 --- a/.github/workflows/sycl-docs.yml +++ b/.github/workflows/sycl-docs.yml @@ -33,8 +33,6 @@ jobs: cd $GITHUB_WORKSPACE/build python $GITHUB_WORKSPACE/repo/buildbot/configure.py -w $GITHUB_WORKSPACE \ -s $GITHUB_WORKSPACE/repo -o $GITHUB_WORKSPACE/build -t Release --docs - cmake --build . --target doxygen-sycl - cmake --build . --target doxygen-clang cmake --build . --target docs-sycl-html cmake --build . --target docs-clang-html - name: Deploy @@ -52,9 +50,7 @@ jobs: git rm -rf . touch .nojekyll yes | \cp -rf $GITHUB_WORKSPACE/build/tools/sycl/doc/html/* . - mv $GITHUB_WORKSPACE/build/tools/sycl/doc/doxygen/html doxygen/ mv $GITHUB_WORKSPACE/build/tools/clang/docs/html clang/ - mv $GITHUB_WORKSPACE/build/tools/clang/docs/doxygen/html clang_doxygen/ git config --global user.name "iclsrc" git config --global user.email "ia.compiler.tools.git@intel.com" git add . diff --git a/sycl/doc/index.rst b/sycl/doc/index.rst index cd6b5282312eb..bfe2292e1ddcc 100644 --- a/sycl/doc/index.rst +++ b/sycl/doc/index.rst @@ -15,7 +15,6 @@ Using oneAPI DPC++ for Application Development Extensions syclcompat/README.md FAQ - User API Reference EnvironmentVariables MultiTileCardWithLevelZero syclgraph/SYCLGraphUsageGuide @@ -26,9 +25,7 @@ Design Documents for the oneAPI DPC++ Compiler .. toctree:: :maxdepth: 1 - API Reference Clang Documentation - Clang API Reference design/CompilerAndRuntimeDesign design/KernelParameterPassing design/PluginInterface From 7a3e122bdeddb3281bd8f80f86c270193408efd4 Mon Sep 17 00:00:00 2001 From: "Agarwal, Udit" Date: Mon, 23 Sep 2024 20:38:34 -0700 Subject: [PATCH 2/5] Don't install doxygen in container --- .github/workflows/sycl-docs.yml | 2 +- buildbot/configure.py | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/sycl-docs.yml b/.github/workflows/sycl-docs.yml index cf37bdc6079c5..2d540f0997d42 100644 --- a/.github/workflows/sycl-docs.yml +++ b/.github/workflows/sycl-docs.yml @@ -25,7 +25,7 @@ jobs: path: repo - name: Install deps run: | - sudo apt-get install -y doxygen graphviz ssh ninja-build libhwloc-dev + sudo apt-get install -y graphviz ssh ninja-build libhwloc-dev sudo pip3 install -r repo/llvm/docs/requirements.txt - name: Build Docs run: | diff --git a/buildbot/configure.py b/buildbot/configure.py index 32cf6ebdd93ab..788c82b4fa3fa 100644 --- a/buildbot/configure.py +++ b/buildbot/configure.py @@ -116,7 +116,6 @@ def do_configure(args): llvm_enable_assertions = "OFF" if args.docs: - llvm_enable_doxygen = "ON" llvm_enable_sphinx = "ON" if args.shared_libs: From 1997a3b3c8807c09a578fddd84651af1808451c1 Mon Sep 17 00:00:00 2001 From: Udit Agarwal Date: Mon, 23 Sep 2024 20:50:41 -0700 Subject: [PATCH 3/5] Update sycl-docs.yml --- .github/workflows/sycl-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sycl-docs.yml b/.github/workflows/sycl-docs.yml index 2d540f0997d42..437f46c558a85 100644 --- a/.github/workflows/sycl-docs.yml +++ b/.github/workflows/sycl-docs.yml @@ -55,4 +55,4 @@ jobs: git config --global user.email "ia.compiler.tools.git@intel.com" git add . git diff-index --quiet HEAD || git commit --amend -m "Update docs" -s - git push -f + git push From 80c6576b44ea83ab54ac2756bc775ef91769b7dd Mon Sep 17 00:00:00 2001 From: "Agarwal, Udit" Date: Mon, 23 Sep 2024 21:28:06 -0700 Subject: [PATCH 4/5] Remove doxygen links --- .github/workflows/sycl-docs.yml | 2 +- .../supported/sycl_ext_intel_esimd/README.md | 1 - .../sycl_ext_intel_esimd/sycl_ext_intel_esimd.md | 14 -------------- .../sycl_ext_intel_esimd_functions.md | 1 - 4 files changed, 1 insertion(+), 17 deletions(-) diff --git a/.github/workflows/sycl-docs.yml b/.github/workflows/sycl-docs.yml index 437f46c558a85..4a28d18f3201f 100644 --- a/.github/workflows/sycl-docs.yml +++ b/.github/workflows/sycl-docs.yml @@ -1,4 +1,4 @@ -name: Generate Doxygen documentation +name: Generate documentation on: schedule: diff --git a/sycl/doc/extensions/supported/sycl_ext_intel_esimd/README.md b/sycl/doc/extensions/supported/sycl_ext_intel_esimd/README.md index 58bdfc2641c31..178817c6ebb24 100644 --- a/sycl/doc/extensions/supported/sycl_ext_intel_esimd/README.md +++ b/sycl/doc/extensions/supported/sycl_ext_intel_esimd/README.md @@ -16,7 +16,6 @@ vectorization is expressed explicitly in the code by the programmer. Please see the additional resources on the Intel DPC++ project's github: 1) [ESIMD Extension Specification](./sycl_ext_intel_esimd.md) -1) [ESIMD API/doxygen reference](https://intel.github.io/llvm-docs/doxygen/group__sycl__esimd.html) 1) [Examples](./examples/README.md) 1) [ESIMD end-to-end LIT tests](https://github.com/intel/llvm/blob/sycl/sycl/test-e2e/ESIMD/) 1) [Implementation and API Restrictions](./sycl_ext_intel_esimd.md#implementation-restrictions) diff --git a/sycl/doc/extensions/supported/sycl_ext_intel_esimd/sycl_ext_intel_esimd.md b/sycl/doc/extensions/supported/sycl_ext_intel_esimd/sycl_ext_intel_esimd.md index fb5f6850defde..c01223a2e4fe0 100644 --- a/sycl/doc/extensions/supported/sycl_ext_intel_esimd/sycl_ext_intel_esimd.md +++ b/sycl/doc/extensions/supported/sycl_ext_intel_esimd/sycl_ext_intel_esimd.md @@ -38,7 +38,6 @@ - [Other restrictions](#other-restrictions) ## Other content: -* [ESIMD API/doxygen reference](https://intel.github.io/llvm-docs/doxygen/group__sycl__esimd.html) * [Examples](./examples/README.md) * [ESIMD LIT tests - working code examples](https://github.com/intel/llvm/blob/sycl/sycl/test-e2e/ESIMD/) @@ -162,7 +161,6 @@ The element type must either be a vectorizable type or the `sycl::half` type. The set of vectorizable types is the set of fundamental SYCL arithmetic types excluding `bool`. The length of the vector is the second template parameter. -See the complete [API reference](https://intel.github.io/llvm-docs/doxygen/classcl_1_1____ESIMD__NS_1_1simd.html#details) for the `simd` class for more details. ESIMD compiler back-end does the best it can to map each `simd` class object to a contiguous block of registers in the general register file (GRF). @@ -351,8 +349,6 @@ reduction operations are supported: - maximum - minimum -See more details on the API documentation [page TODO](https://intel.github.io/llvm-docs/doxygen). - ### Memory access APIs Explicit SIMD memory access interface is quite different from the standard SYCL @@ -598,9 +594,6 @@ Many memory access APIs accept offsets as arguments, which are used to determine actual memory location for the access. Offsets are always expressed in bytes rather than element units. -See more details in the API documentation -[page TODO](https://intel.github.io/llvm-docs/doxygen). - ### Math operations #### Extended math @@ -649,10 +642,6 @@ ESIMD supports the following non-standard math functions implemented in hardware - Plane equation - `plane`. Solves a component-wise plane equation `w = p*u + q*v + r` where `u`, `v`, `w` are vectors and `p`, `q`, `r` are scalars. - -See more details in the API documentation -[page TODO](https://intel.github.io/llvm-docs/doxygen). - ### Dot Product Accumulate Systolic - `DPAS` API DPAS is the matrix multiply-add-and-accumulate operation performed on limited size matrices/tiles. @@ -870,9 +859,6 @@ There are other useful miscellaneous APIs provided by ESIMD. - Find least significant set bit - `fbl`. - Find most significant set bit - `fbh`. -See more details in the API documentation -[page TODO](https://intel.github.io/llvm-docs/doxygen). -
### Private Global Variables. diff --git a/sycl/doc/extensions/supported/sycl_ext_intel_esimd/sycl_ext_intel_esimd_functions.md b/sycl/doc/extensions/supported/sycl_ext_intel_esimd/sycl_ext_intel_esimd_functions.md index 91a8e2182936a..5fb775dddc3bb 100644 --- a/sycl/doc/extensions/supported/sycl_ext_intel_esimd/sycl_ext_intel_esimd_functions.md +++ b/sycl/doc/extensions/supported/sycl_ext_intel_esimd/sycl_ext_intel_esimd_functions.md @@ -22,7 +22,6 @@ See more general ESIMD documentation [here](./sycl_ext_intel_esimd.md). ## Other content: * [General ESIMD documentation](./sycl_ext_intel_esimd.md) -* [ESIMD API/doxygen reference](https://intel.github.io/llvm-docs/doxygen/group__sycl__esimd.html) * [Examples](./examples/README.md) * [ESIMD LIT tests - working code examples](https://github.com/intel/llvm/blob/sycl/sycl/test-e2e/ESIMD/) From fdbcdd21698c2bb53a14f74255e7dfde7520626f Mon Sep 17 00:00:00 2001 From: Udit Agarwal Date: Tue, 24 Sep 2024 10:47:15 -0700 Subject: [PATCH 5/5] Separate out force-push in a followup PR --- .github/workflows/sycl-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sycl-docs.yml b/.github/workflows/sycl-docs.yml index 4a28d18f3201f..b50b0e897e158 100644 --- a/.github/workflows/sycl-docs.yml +++ b/.github/workflows/sycl-docs.yml @@ -55,4 +55,4 @@ jobs: git config --global user.email "ia.compiler.tools.git@intel.com" git add . git diff-index --quiet HEAD || git commit --amend -m "Update docs" -s - git push + git push -f