Update documentation for oneTBB 2022.2.0 (#1767)

Author: omalyshe

doc/GSG/integrate.rst

@@ -14,8 +14,8 @@ To integrate oneTBB, you need to:
 However, you can use CMake* and the pkg-config tool to simplify the process of integrating oneTBB into your project and handling its dependencies.
 See the instructions below to learn how to use the tools. 
 
-CMake*
-*******
+Integrate oneTBB with CMake*
+****************************
 
 CMake* is a cross-platform build tool that helps you manage dependencies and build systems. 
 Integrating oneTBB into your project using CMake*:

doc/GSG/next_steps.rst

@@ -19,9 +19,10 @@ After installing |short_name|, set the environment variables:
 
 .. tip::
 
-   oneTBB can coordinate with Intel(R) OpenMP on CPU resources usage 
-   to avoid excessive oversubscription when both runtimes are used within a process.
-   To enable this feature set up ``TCM_ENABLE`` environment variable to ``1``.
+   oneTBB can coordinate with Intel(R) OpenMP on CPU resources usage to avoid
+   excessive oversubscription when both runtimes are used within a process. To
+   enable this feature set ``TCM_ENABLE`` environment variable to ``1``. For
+   more details, see :ref:`avoid_cpu_overutilization`.
 
 
 Build and Run a Sample 
@@ -125,34 +126,20 @@ Build and Run a Sample
 
 
 
-Hybrid CPU and NUMA Support
-****************************
+Enable Hybrid CPU and NUMA Support
+***********************************
 
-If you need NUMA/Hybrid CPU support in oneTBB, you need to make sure that HWLOC* is installed on your system.
+To support Hybrid CPU and NUMA platforms, oneTBB relies on the HWLOC* library.
+ 
+The HWLOC functionality is accessed through a set of proxy libraries whose names begin with the ``tbbbind`` prefix. oneTBB automatically loads them at runtime when needed. To find and load these libraries successfully, locate them in the same directory as the oneTBB library itself (e.g., alongside ``libtbb.so`` or ``tbb.dll``).
+ 
+Starting with oneTBB 2022.2, the default ``tbbbind`` library is statically linked with HWLOC 2.x. This version is used if a system-provided HWLOC cannot be found.
+ 
+If you prefer to use a system-provided or custom-built version of HWLOC, make sure it is available in the search paths used by the dynamic loader. Consult your platform’s dynamic loader documentation for details about these paths (e.g., ``LD_LIBRARY_PATH`` on Linux* OS or ``PATH`` on Windows* OS).
+ 
+To use a specific HWLOC version, place one of the following tbbbind variants in the same directory as the oneTBB library:
 
-HWLOC* (Hardware Locality) is a library that provides a portable abstraction of the hierarchical topology of modern architectures (NUMA, hybrid CPU systems, etc). oneTBB relies on HWLOC* to identify the underlying topology of the system to optimize thread scheduling and memory allocation.
+* ``tbbbind_2_5`` — depends on HWLOC version 2.5 or higher. Use this version if hybrid CPU support is required.
+* ``tbbbind_2_0`` — depends on HWLOC versions 2.1 to 2.4.
 
-Without HWLOC*, oneTBB may not take advantage of NUMA/Hybrid CPU support. Therefore, it's important to make sure that HWLOC* is installed before using oneTBB on such systems.
-
-Check HWLOC* on the System
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-To check if HWLOC* is already installed on your system, run ``hwloc-ls``:
-
-* For Linux* OS, in the command line.
-* For Windows* OS, in the command prompt.
-
-If HWLOC* is installed, the command displays information about the hardware topology of your system. If it is not installed, you receive an error message saying that the command ``hwloc-ls`` could not be found.
-
-.. note:: For Hybrid CPU support, make sure that HWLOC* is version 2.5 or higher. For NUMA support, install HWLOC* version 1.11 or higher.
-
-Install HWLOC*
-^^^^^^^^^^^^^^
-
-To install HWLOC*, visit the official Portable Hardware Locality website (https://www-lb.open-mpi.org/projects/hwloc/).
-
-* For Windows* OS, binaries are available for download.
-* For Linux* OS, only the source code is provided and binaries should be built.
-
-On Linux* OS, HWLOC* can be also installed with package managers, such as APT*, YUM*, etc. To do so, run: sudo apt install hwloc.
-
-.. note:: For Hybrid CPU support, make sure that HWLOC* is version 2.5 or higher. For NUMA support, install HWLOC* version 1.11 or higher.
+.. tip:: To confirm that tbbbind is loaded successfully at runtime, set the environment variable ``TBB_VERSION=1`` before launching your application.

doc/conf.py

@@ -29,8 +29,8 @@
     project = u'Intel® oneAPI Threading Building Blocks (oneTBB)'
 else:
     project = u'oneTBB'
-copyright = u'Intel Corporation'
-author = u'Intel'
+copyright = u'UXL Foundation Contributors'
+author = u''
 
 # The short X.Y version
 version = u''
@@ -137,10 +137,8 @@
         'use_issues_button': True,
         'use_edit_page_button': True,
         'repository_branch': 'master',
-    }
 
-if BUILD_TYPE != 'oneapi' and BUILD_TYPE != 'dita':
-   html_theme_options["extra_footer"]="<div><a href='https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html' data-cookie-notice='true'>Cookies</a> <a href='https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html'>| Privacy</a> <a data-wap_ref='dns' id='wap_dns' href='https://www.intel.com/content/www/us/en/privacy/intel-cookie- notice.html'>| Do Not Share My Personal Information</a> </div><div>&copy; Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document, with the sole exception that code included in this document is licensed subject to the Zero-Clause BSD open source license (OBSD), <a href='http://opensource.org/licenses/0BSD'>http://opensource.org/licenses/0BSD</a>. </div><br><div>oneTBB is licensed under Apache License Version 2.0. Refer to the <a href='https://github.com/uxlfoundation/oneTBB/blob/master/LICENSE.txt'>LICENSE </a> file for the full license text and copyright notice.</div>"
+    }
 
 
 # Add any paths that contain custom static files (such as style sheets) here,

doc/main/_templates/layout.html

@@ -1,15 +1 @@
 {% extends "!layout.html" %}
-{% block extrahead %}
-    <script defer type="text/javascript" src="https://www.intel.com/content/dam/www/global/wap/performance-config.js" ></script>
-    <script type="text/javascript">
-        // Configure TMS settings
-        var wapLocalCode = 'us-en'; // Dynamically set per localized site, see mapping table for values
-        var wapSection = "oneapi-tbb"; // WAP team will give you a unique section for your site
-        // Load TMS
-        (function () {
-            var url = 'https://www.intel.com/content/dam/www/global/wap/tms-loader.js'; // WAP file URL
-            var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; po.src = url;
-            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
-        })();
-      </script>
-{% endblock %}

doc/main/examples_testing/CMakeLists.txt

@@ -39,3 +39,11 @@ file(GLOB_RECURSE DOC_EXAMPLES_LIST "${_reference_examples_path}/*.cpp" "${_user
 foreach(_doc_example_path IN LISTS DOC_EXAMPLES_LIST)
     add_doc_example(${_doc_example_path})
 endforeach()
+
+find_package(OpenMP)
+if (OpenMP_FOUND)
+    target_compile_options(tbb_mixing_other_runtimes_example PRIVATE "${OpenMP_CXX_FLAGS}")
+    target_link_options(tbb_mixing_other_runtimes_example PRIVATE "${OpenMP_CXX_FLAGS}")
+endif()
+
+