Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc update for oneTBB 2022.0 #1515

Merged
merged 8 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion doc/GSG/get_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,36 @@ It is helpful for new users of parallel programming and experienced developers t

It is recommended for you to have a basic knowledge of C++ programming and some experience with parallel programming concepts.

|full_name| is a runtime-based parallel programming model for C++ code that uses tasks.
The template-based runtime library can help you harness the latent performance of multi-core processors.

oneTBB enables you to simplify parallel programming by breaking computation into parallel running tasks. Within a single process,
parallelism is carried out by mapping tasks to threads. Threads are an operating system mechanism that allows the same or different sets of instructions
to be executed simultaneously. Using threads can make your program work faster and more efficiently.

Here you can see one of the possible executions of tasks by threads.

.. figure:: Images/how-oneTBB-works.png
:scale: 70%
:align: center

Use oneTBB to write scalable applications that:

* Specify logical parallel structure instead of threads.
* Emphasize data-parallel programming.
* Take advantage of concurrent collections and parallel algorithms.

oneTBB supports nested parallelism and load balancing. It means that you can use the library without worrying about oversubscribing a system, which happens when more tasks are assigned to a system than it can handle efficiently.

oneTBB is used in different areas, such as scientific simulations, gaming, data analysis, etc.

It is available as a stand-alone product and as part of the |base_tk|.


To start using oneTBB, follow the next steps:
*********************************************

#. Learn what :ref:`oneTBB is<intro>` and see the :ref:`System Requirements<system_requirements>`.
#. See the :ref:`System Requirements<system_requirements>`.
#. :ref:`Install oneTBB<installation>`.
#. Run your program using oneTBB following the :ref:`Next Steps <next_steps>`.
#. Learn how to :ref:`Integrate oneTBB into your project <integrate>` using CMake* and pkg-config tool.
Expand Down
29 changes: 0 additions & 29 deletions doc/GSG/intro.rst

This file was deleted.

1 change: 0 additions & 1 deletion doc/index/toctree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
:maxdepth: 2

/GSG/get_started
/GSG/intro
/GSG/system_requirements
/GSG/installation
/GSG/next_steps
Expand Down
9 changes: 3 additions & 6 deletions doc/main/tbb_userguide/Exceptions_and_Cancellation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,11 @@ the following steps generally occur:
thread that invoked the algorithm.


The exception thrown in step 3 might be the original exception, or might
merely be a summary of type ``captured_exception``. The latter usually
occurs on current systems because propagating exceptions between threads
requires support for the C++ ``std::exception_ptr`` functionality. As
compilers evolve to support this functionality, future versions of
As compilers evolve to support this functionality, future versions of
oneTBB might throw the original exception. So be sure your code can
catch either type of exception. The following example demonstrates
exception handling.
exception handling:



::
Expand Down
8 changes: 4 additions & 4 deletions doc/main/tbb_userguide/Linux_OS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ structure for Linux\*, relative to *<tbb_install_dir>*
- | ``LIBRARY_PATH``
| ``LD_LIBRARY_PATH``

where
Where:

* ``<arch>`` - ``ia32`` or ``intel64``

.. note:: Starting with oneTBB 2022.0, 32-bit binaries are supported only by the open-source version of the library.

* ``<lib>`` - ``libtbb``, ``libtbbmalloc``, ``libtbbmalloc_proxy`` or ``libtbbbind``

* ``<variant>`` - ``_debug`` or empty

* ``<version>`` - binary version in a form of ``<major>.<minor>``
* ``<version>`` - binary version in a form of ``<major>.<minor>``
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,14 @@ To do the replacement use one of the following methods:
- Alternatively, add the following parameters to the linker options for
the .exe or .dll file that is loaded during application startup.


For 32-bit code (note the triple underscore):


::


tbbmalloc_proxy.lib /INCLUDE:"___TBB_malloc_proxy"



For 64-bit code (note the double underscore):


Expand Down
10 changes: 5 additions & 5 deletions doc/main/tbb_userguide/Windows_OS_ug.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,13 @@ structure for Windows\*, relative to <*tbb_install_dir*>.
- Same as corresponding ``.dll`` file.
- \

where
Where

* ``<arch>`` - ``ia32`` or ``intel64``

* ``<lib>`` - ``tbb``, ``tbbmalloc``, ``tbbmalloc_proxy`` or ``tbbbind``
.. note:: Starting with oneTBB 2022.0, 32-bit binaries are supported only by the open-source version of the library.

* ``<lib>`` - ``tbb``, ``tbbmalloc``, ``tbbmalloc_proxy`` or ``tbbbind``
* ``<vcversion>``

- ``14`` - use for dynamic linkage with the CRT
Expand All @@ -47,11 +48,10 @@ where
- ``_mt`` - use for static linkage with the CRT

* ``<variant>`` - ``_debug`` or empty

* ``<version>`` - binary version

The last column shows which environment variables are used by the
Microsoft\* Visual C++\* or Intel® C++ Compiler Classic or Intel® oneAPI DPC++/C++ Compiler to find these
The last column shows, which environment variables are used by the
Microsoft\* Visual C++\* or Intel® C++ Compiler Classic or Intel® oneAPI DPC++/C++ Compiler, to find these
subdirectories.

.. CAUTION::
Expand Down
Loading