Skip to content

Commit 26d7f29

Browse files
authored
Doc update for oneTBB 2022.0 (#1515)
1 parent 9d85bf3 commit 26d7f29

File tree

7 files changed

+39
-49
lines changed

7 files changed

+39
-49
lines changed

doc/GSG/get_started.rst

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,36 @@ It is helpful for new users of parallel programming and experienced developers t
88

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

11+
|full_name| is a runtime-based parallel programming model for C++ code that uses tasks.
12+
The template-based runtime library can help you harness the latent performance of multi-core processors.
13+
14+
oneTBB enables you to simplify parallel programming by breaking computation into parallel running tasks. Within a single process,
15+
parallelism is carried out by mapping tasks to threads. Threads are an operating system mechanism that allows the same or different sets of instructions
16+
to be executed simultaneously. Using threads can make your program work faster and more efficiently.
17+
18+
Here you can see one of the possible executions of tasks by threads.
19+
20+
.. figure:: Images/how-oneTBB-works.png
21+
:scale: 70%
22+
:align: center
23+
24+
Use oneTBB to write scalable applications that:
25+
26+
* Specify logical parallel structure instead of threads.
27+
* Emphasize data-parallel programming.
28+
* Take advantage of concurrent collections and parallel algorithms.
29+
30+
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.
31+
32+
oneTBB is used in different areas, such as scientific simulations, gaming, data analysis, etc.
33+
34+
It is available as a stand-alone product and as part of the |base_tk|.
35+
1136

1237
To start using oneTBB, follow the next steps:
1338
*********************************************
1439

15-
#. Learn what :ref:`oneTBB is<intro>` and see the :ref:`System Requirements<system_requirements>`.
40+
#. See the :ref:`System Requirements<system_requirements>`.
1641
#. :ref:`Install oneTBB<installation>`.
1742
#. Run your program using oneTBB following the :ref:`Next Steps <next_steps>`.
1843
#. Learn how to :ref:`Integrate oneTBB into your project <integrate>` using CMake* and pkg-config tool.

doc/GSG/intro.rst

Lines changed: 0 additions & 29 deletions
This file was deleted.

doc/index/toctree.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
:maxdepth: 2
1818

1919
/GSG/get_started
20-
/GSG/intro
2120
/GSG/system_requirements
2221
/GSG/installation
2322
/GSG/next_steps

doc/main/tbb_userguide/Exceptions_and_Cancellation.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,11 @@ the following steps generally occur:
2222
thread that invoked the algorithm.
2323

2424

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

3431

3532
::

doc/main/tbb_userguide/Linux_OS.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ structure for Linux\*, relative to *<tbb_install_dir>*
2525
- | ``LIBRARY_PATH``
2626
| ``LD_LIBRARY_PATH``
2727
28-
where
28+
Where:
2929

3030
* ``<arch>`` - ``ia32`` or ``intel64``
31+
32+
.. note:: Starting with oneTBB 2022.0, 32-bit binaries are supported only by the open-source version of the library.
3133

3234
* ``<lib>`` - ``libtbb``, ``libtbbmalloc``, ``libtbbmalloc_proxy`` or ``libtbbbind``
33-
3435
* ``<variant>`` - ``_debug`` or empty
35-
36-
* ``<version>`` - binary version in a form of ``<major>.<minor>``
36+
* ``<version>`` - binary version in a form of ``<major>.<minor>``

doc/main/tbb_userguide/Windows_C_Dynamic_Memory_Interface_Replacement.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,14 @@ To do the replacement use one of the following methods:
4444
- Alternatively, add the following parameters to the linker options for
4545
the .exe or .dll file that is loaded during application startup.
4646

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

5049

5150
::
5251

5352

5453
tbbmalloc_proxy.lib /INCLUDE:"___TBB_malloc_proxy"
55-
56-
54+
5755
For 64-bit code (note the double underscore):
5856

5957

doc/main/tbb_userguide/Windows_OS_ug.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,13 @@ structure for Windows\*, relative to <*tbb_install_dir*>.
3030
- Same as corresponding ``.dll`` file.
3131
- \
3232

33-
where
33+
Where
3434

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

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

39+
* ``<lib>`` - ``tbb``, ``tbbmalloc``, ``tbbmalloc_proxy`` or ``tbbbind``
3940
* ``<vcversion>``
4041

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

4950
* ``<variant>`` - ``_debug`` or empty
50-
5151
* ``<version>`` - binary version
5252

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

5757
.. CAUTION::

0 commit comments

Comments
 (0)