added new html

Signed-off-by: Martin, Doug <doug.martin@intel.com>
DougTW · Jul 10, 2024 · 61754da · 61754da
1 parent 2b47871
commit 61754da
Show file tree

Hide file tree

Showing 125 changed files with 26,183 additions and 0 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: ec10acb4393e04e76365fe36e27acb40
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_images/pdf-logo.png b/docs/_images/pdf-logo.png
diff --git a/docs/_sources/dbex/debug-linux-ex-lt.rst.txt b/docs/_sources/dbex/debug-linux-ex-lt.rst.txt
@@ -0,0 +1,46 @@
+.. _debug-linux-ex-lt:
+
+Debugging Linux Applications with GDB
+=====================================
+
+.. list-table::
+   :widths: 30 70
+
+   * - `Debug a CPU <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/overview.html>`_
+     - Use the simple SYCL application named
+       `Array Transform <https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/ApplicationDebugger/array-transform>`__ to
+       perform basic debugging operations, such as :code:`break`, :code:`run`,
+       :code:`print`, :code:`continue`, :code:`info`, and :code:`next`. The
+       application being debugged is limited to running on multiple CPU
+       threads by setting the :code:`ONEAPI_DEVICE_SELECTOR=*:cpu`
+       environment variable.
+
+   * - `Debug a GPU <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debug-a-sycl-application-on-a-gpu.html>`_
+     - Use a simple SYCL application named `Array Transform <https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/ApplicationDebugger/array-transform>`__
+       to perform basic debugging operations, such as ``break``, ``run``,
+       ``print``, ``continue``, ``info``, ``disassemble``, and ``next``.
+       This tutorial describes how to interact with SIMD lanes, as additional
+       thread elements. The application being debugged is instructed to run
+       on a GPU by setting the ``ONEAPI_DEVICE_SELECTOR=level_zero:gpu``
+       environment variable.
+
+   * - `Debug an FPGA <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debug-a-sycl-program-on-the-fpga-emulator.html>`_
+     - The FPGA emulator runs on the CPU and behaves similarly to the CPU
+       device. Make sure you complete the necessary setup steps described in
+       the `Get Started Guide <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/get-started-guide-linux>`__
+       and proceed with instructions on `Basic Debugging on CPU <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debug-a-sycl-application-on-a-cpu.html#basic-debugging>`_.
+
+   * - `Debug an OpenCL Application <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debugging-an-opencl-application.html>`_
+     - Starting with the 2023.0 release of oneAPI, debugging OpenCL™
+       applications is *not* supported. For earlier versions (2022.x and
+       earlier), see `these instructions <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debugging-an-opencl-application.html>`_.
+
+   * - `Debugging Options <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debugging-options.html>`_
+     - This section has some useful options for debugging, such as
+       Auto-Attach, Reducing Overhead, Pretty-Printing, Prettify Frames,
+       and more.
+
+   * - `Live Attach <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/live-attach.html>`_
+     - The debugger supports attaching to applications that are already
+       running. This may be useful to debug workloads that show hang-like
+       behavior, such as deadlocks, infinite loops, etc.
diff --git a/docs/_sources/dbex/debug-linux-ex.rst.txt b/docs/_sources/dbex/debug-linux-ex.rst.txt
@@ -0,0 +1,44 @@
+.. _debug-linux-ex:
+
+Debugging Linux Applications with GDB
+=====================================
+
+.. glossary::
+
+`Debug a cpu <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/overview.html>`_
+      Use the simple SYCL application named
+      `Array Transform <https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/ApplicationDebugger/array-transform>`__ to
+      perform basic debugging operations, such as :code:`break`, :code:`run`,
+      :code:`print`, :code:`continue`, :code:`info`, and :code:`next`. The
+      application being debugged is limited to running on multiple CPU
+      threads by setting the :code:`ONEAPI_DEVICE_SELECTOR=*:cpu`
+      environment variable.
+
+`Debug a gpu <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debug-a-sycl-application-on-a-gpu.html>`_
+      Use a simple SYCL application named 
+      `Array Transform <https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/ApplicationDebugger/array-transform>`__
+      to perform basic debugging operations, such as ``break``, ``run``,
+      ``print``, ``continue``, ``info``, ``disassemble``, and ``next``.
+      This tutorial describes how to interact with SIMD lanes, as additional
+      thread elements. The application being debugged is instructed to run on
+      a GPU by setting the ``ONEAPI_DEVICE_SELECTOR=level_zero:gpu``
+      environment variable.
+
+`Debug an FPGA <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debug-a-sycl-program-on-the-fpga-emulator.html>`_
+      The FPGA emulator runs on the CPU and behaves similarly to the CPU device.
+      Make sure you complete the necessary setup steps described in the
+      `Get Started Guide <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/get-started-guide-linux>`__
+      and proceed with instructions on `Basic Debugging on CPU <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debug-a-sycl-application-on-a-cpu.html#basic-debugging>`_.
+
+`Debug an OpenCL Application <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debugging-an-opencl-application.html>`_
+      Starting with the 2023.0 release of oneAPI, debugging OpenCL™ applications
+      is *not* supported. For earlier versions (2022.x and earlier), see `these instructions <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debugging-an-opencl-application.html>`_.
+
+`Debugging options <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debugging-options.html>`_
+      This section has some useful options for debugging, such as Auto-Attach, Reducing
+      Overhead, Pretty-Printing, Prettify Frames, and more.
+
+`Live Attach <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/live-attach.html>`_
+      The debugger supports attaching to applications that are already running.
+      This may be useful to debug workloads that show hang-like behavior, such as
+      deadlocks, infinite loops, etc.
diff --git a/docs/_sources/dbex/debug-windows-ex.rst.txt b/docs/_sources/dbex/debug-windows-ex.rst.txt
@@ -0,0 +1,15 @@
+.. _debug-windows-ex:
+
+Debugging Windows Applications with GDB
+#######################################
+
+.. list-table::
+   :widths: 30 70
+
+   * - `Debug a CPU <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-windows/current/debug-an-application-on-a-cpu.html>`_
+     - This example describes a basic scenario of debugging a sample SYCL\* app,
+       Array Transform, with the kernel offloaded to the CPU.
+
+   * - `Debug a GPU <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-windows/current/debug-an-application-on-a-gpu.html>`_
+     - This example describes a basic scenario of debugging a program with the kernel
+       offloaded to the GPU.
diff --git a/docs/_sources/dbex/index.rst.txt b/docs/_sources/dbex/index.rst.txt
@@ -0,0 +1,51 @@
+.. _debug-examples-index:
+
+Debug Examples
+##############
+
+..
+  .. list-table::
+     :widths: 5 5
+     :header-rows: 1
+
+
+     * - `Linux\* GDB Debugging Examples <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/overview.html>`_
+       - `Windows\* GDB Debugging Examples <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-windows/current/overview.html>`_
+     * - After you’ve installed and configured Intel® Distribution for GDB\*,
+         here are some examples of debugging on Linux.
+       - If you're debugging applications on Windows, here are some debugging
+         scenarios on Windows after you’ve installed and configured
+         Intel® Distribution for GDB\*.
+
+
+
+.. list-table::
+   :widths: 5 5
+   :header-rows: 1
+
+
+   * - :ref:`Linux\* GDB Debugging Examples <debug-linux>`
+     - `Windows\* GDB Debugging Examples <debug-windows>`_
+   * - After you’ve installed and configured Intel® Distribution for GDB\*,
+       here are some examples of debugging on Linux.
+     - If you're debugging applications on Windows, here are some debugging
+       scenarios on Windows after you’ve installed and configured
+       Intel® Distribution for GDB\*.
+
+
+.. toctree::
+   :hidden:
+
+   ../applications.debuggers.gdb.documentation/tutorial_lin/source/debug-a-dpcpp-application-on-a-cpu
+   debug-a-dpcpp-application-on-a-gpu
+   debug-a-dpcpp-program-on-the-fpga-emulator
+   debugging-options
+   live-attach
+   multi-target
+   multi-gpu-debugging
+   debugging-an-opencl-application
+   MPI-debugging
+   docker
+   troubleshooting
+   known-issues
+   notices-and-disclaimers
diff --git a/docs/_sources/gdb-ug/index.rst.txt b/docs/_sources/gdb-ug/index.rst.txt
@@ -0,0 +1,20 @@
+.. _users-guide-index:
+
+User's Guide
+############
+
+
+- `Debugging a Kernel on GDB and gdb-oneapi: Major Differences <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/overview.html#DEBUGGING-A-KERNEL-ON-CPU-AND-GPU-MAJOR-DIFFERENCES>`_
+
+- `Unique GDB Features <https://www.intel.com/content/www/us/en/developer/articles/technical/unique-gdb-features.html>`_
+
+- `Useful Debugging Features <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/debugging-options.html>`_
+
+- `Intel oneAPI Programming Guide: Debugging <https://www.intel.com/content/www/us/en/docs/oneapi/programming-guide/current/debugging-the-dpc-and-openmp-offload-process.html>`_
+
+
+
+.. toctree::
+   :maxdepth: 1
+
+   ../overview/debug-cpu-gpu-major-diffs
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,53 @@
+.. _layout4-homepage:
+
+
+Documentation
+#############
+
+.. toctree::
+   :maxdepth: 1
+
+
+   overview/index
+   Getting Started Guide: Linux <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/get-started-guide-linux/current/overview.html>
+   Getting Started Guide: Windows <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/get-started-guide-windows/current/overview.html>
+   gdb-ug/index
+   dbex/debug-linux-ex-lt
+   dbex/debug-windows-ex
+
+   videos/index
+
+
+oneAPI GDB Reference Documents
+******************************
+
+- `Multi-page HTML version <https://xmnboy.github.io/gdb-doc-test/gdb-oneapi/>`_
+
+- `Single-page HTML version <https://xmnboy.github.io/gdb-doc-test/gdb-oneapi.html>`_
+
+- `900+ pages PDF version <https://xmnboy.github.io/gdb-doc-test/gdb-oneapi.pdf>`_ |pdf-icon|
+
+- `Reference Sheet PDF version <https://xmnboy.github.io/gdb-doc-test/gdb-oneapi-reference-sheet.pdf>`_ |pdf-icon|
+
+
+References
+**********
+
+- `Intel Distribution for GDB FAQ <https://www.intel.com/content/www/us/en/developer/articles/technical/gdb-oneapi-faq.html>`_
+- `Known issues <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/known-issues.html>`_
+- `Release notes <https://www.intel.com/content/www/us/en/developer/articles/release-notes/gdb-release-notes.html>`_
+- `Troubleshooting <https://www.intel.com/content/www/us/en/docs/distribution-for-gdb/tutorial-debugging-dpcpp-linux/current/troubleshooting.html>`_
+
+.. |pdf-icon| image:: /images/pdf-logo.png
+   :height: 2ex
+
+.. toctree::
+   :hidden:
+
+   refs/blank
+   refs/gdb-oneapi-faq
+   refs/known-issues
+   refs/release-notes
+   refs/troubleshooting
+   Intel <http://www.intel.com>
+   GDB homepage <https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-gdb.html>
diff --git a/docs/_sources/overview/debug-cpu-gpu-major-diffs.rst.txt b/docs/_sources/overview/debug-cpu-gpu-major-diffs.rst.txt
@@ -0,0 +1,8 @@
+.. _debug-cpu-gpu-major-diffs:
+
+Debugging a Kernel on CPU and GPU: Major Differences
+####################################################
+
+.. include:: ../../../applications.debuggers.gdb.documentation/tutorial_lin/source/index.rst
+   :start-after: Debugging a Kernel on CPU and GPU: Major Differences
+   :end-before: To start debugging, refer to the following sections: