Skip to content

Commit 7c509dd

Browse files
omalysheomalyshe
committed
Improve documentation
1 parent ed141f3 commit 7c509dd

8 files changed

+69
-25
lines changed

‎doc/GSG/system_requirements.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
System Requirements
44
*******************
55

6-
Refer to the `oneTBB System Requirements <https://github.com/uxlfoundation/oneTBB/blob/master/SYSTEM_REQUIREMENTS.md>`_.
6+
|full_name| supports broad list of HW platforms, operating systems and compilers.
7+
Refer to the `oneTBB System Requirements <https://github.com/uxlfoundation/oneTBB/blob/master/SYSTEM_REQUIREMENTS.md>`_ for details.

‎doc/main/intro/help_support.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ Getting Help and Support
1010
.. rubric:: Getting Technical Support
1111
:class: sectiontitle
1212

13-
For general information about oneTBB technical support, product
13+
For general information about |short_name| technical support, product
1414
updates, user forums, FAQs, tips and tricks and other support
15-
questions, go to `GitHub issues <https://github.com/uxlfoundation/oneTBB/issues>`_.
15+
questions, go to `oneTBB Support <https://github.com/uxlfoundation/oneTBB/blob/master/SUPPORT.md>`_.

‎doc/main/intro/testing_approach.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@ There are four main types of errors/hazards you can encounter in the development
1111
* Race conditions and deadlocks
1212

1313
|short_name| testing approach is designed to provide high coverage of these error types.
14-
All types of errors are covered with unit testing and review.
14+
All types of errors are covered with unit testing and code review.
1515

1616
Code coverage metrics are tracked to ensure high code coverage with tests. Uncovered branches are analyzed manually.
1717
Memory errors and data races are additionally covered by special tools that include thread and memory sanitizers.
1818

1919
Race conditions and deadlocks are the most complicated errors.
2020
They are covered by:
2121

22-
* **Unit tests** that, however, have limited capability to catch such errors
22+
* **Unit tests** that, however, have limited capability to catch such errors.
2323
* **Integration tests**. Multiple different functionalities are heavily combined to emulate user use cases that may trigger such errors based on prior knowledge and expertise.
2424
* **Stress testing with different possible combinations**. It ensures that even rarely triggered error conditions are caught by testing.
2525

26-
.. note:: Every fix is required to be covered by a test to guarantee the detection of such issues in the future.
26+
.. note:: Every fix is required to be covered by a regression test to guarantee the detection of such issues in the future.
2727

2828
Continuous Integration triggers all the tests on each commit. This ensures that:
2929

‎doc/main/tbb_userguide/Linux_OS.rst

+18-4
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,26 @@ structure for Linux\*, relative to *<tbb_install_dir>*
1717
- Location
1818
- Environment Variable
1919
* - Header files
20-
- | ``include/oneapi/tbb.h``
21-
| ``include/oneapi/tbb/*.h``
20+
- | ``<tbb_install_dir>/include/oneapi/tbb.h``
21+
| ``<tbb_install_dir>/include/oneapi/tbb/*.h``
2222
- ``CPATH``
2323
* - Shared libraries
24-
- ``lib/<arch>/<lib><variant>.so.<version>``
24+
- ``<tbb_install_dir>/lib/<arch>/gcc4.8/<lib><compat_version><variant>.so.<version>``
2525
- | ``LIBRARY_PATH``
2626
| ``LD_LIBRARY_PATH``
27+
* - Symbolic links
28+
- | ``<tbb_install_dir>/lib/<arch>/gcc4.8/<lib><compat_version><variant>.so`` -> ``<tbb_install_dir>lib/<lib><compat_version><variant>.so.<ver_major>``
29+
| ``<tbb_install_dir>/lib/<lib><compat_version><variant>.so.<ver_major>`` -> ``<tbb_install_dir>lib/<lib><compat_version><variant>.so.<ver_major>.<ver_minor>``
30+
- \
31+
* - CMake files
32+
- ``<tbb_install_dir>/lib/cmake/tbb/*.cmake``
33+
- \
34+
* - pkg-config files
35+
- ``<tbb_install_dir>/lib/pkgconfig/*.pc``
36+
- \
37+
* - vars script
38+
- ``<tbb_install_dir>/env/vars.sh``
39+
- \
2740

2841
Where:
2942

@@ -33,4 +46,5 @@ Where:
3346

3447
* ``<lib>`` - ``libtbb``, ``libtbbmalloc``, ``libtbbmalloc_proxy`` or ``libtbbbind``
3548
* ``<variant>`` - ``_debug`` or empty
36-
* ``<version>`` - binary version in a form of ``<major>.<minor>``
49+
* ``<version>`` - binary version in a form of ``<ver_major>.<ver_minor>``
50+
* ``<compat_version>`` - compatibility version for ``libtbbbind``

‎doc/main/tbb_userguide/Mac_OS.rst

+22-6
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
macOS\*
44
=======
55

6-
This section uses *<install_dir>* to indicate the top-level installation directory.
7-
The following table describes the subdirectory structure for macOS\*, relative to *<install_dir>*.
6+
This section uses *<tbb_install_dir>* to indicate the top-level installation directory.
7+
The following table describes the subdirectory structure for macOS\*, relative to *<tbb_install_dir>*.
88

99
.. container:: tablenoborder
1010

@@ -15,18 +15,34 @@ The following table describes the subdirectory structure for macOS\*, relative t
1515
- Location
1616
- Environment Variable
1717
* - Header files
18-
- | ``include/oneapi/tbb.h``
19-
| ``include/oneapi/tbb/*.h``
18+
- | ``<tbb_install_dir>/include/oneapi/tbb.h``
19+
| ``<tbb_install_dir>/include/oneapi/tbb/*.h``
2020
- ``CPATH``
2121
* - Shared libraries
22-
- ``lib/<lib><variant>.<version>.dylib``
22+
- ``<tbb_install_dir>/lib/<lib><variant>.<version>.dylib``
2323
- | ``LIBRARY_PATH``
2424
| ``DYLD_LIBRARY_PATH``
25+
* - Symbolic links
26+
- | ``<tbb_install_dir>/lib/<lib><variant>.dylib`` -> ``<tbb_install_dir>lib/<lib><variant>.<ver_major>.dylib``
27+
| ``<tbb_install_dir>/lib/<lib><variant>.<ver_major>.dylib`` -> ``<tbb_install_dir>lib/<lib><variant>.<ver_major>.<ver_minor>.dylib``
28+
- \
29+
* - CMake files
30+
- ``<tbb_install_dir>/lib/cmake/tbb/*.cmake``
31+
- \
32+
* - pkg-config files
33+
- ``<tbb_install_dir>/lib/pkgconfig/tbb.pc``
34+
- \
35+
* - vars script
36+
- ``<tbb_install_dir>/env/vars.sh``
37+
- \
2538

2639
where
2740

2841
* ``<lib>`` - ``libtbb``, ``libtbbmalloc`` or ``libtbbmalloc_proxy``
2942

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

32-
* ``<version>`` - binary version in a form of ``<major>.<minor>``
45+
* ``<version>`` - binary version in a form of ``<ver_major>.<ver_minor>``
46+
47+
See the :ref:`Integrate oneTBB <integrate>` to learn how to use CMake* and pkg-config tools.
48+
Learn how to setup environment in :ref:`Next Steps <next_steps>`.

‎doc/main/tbb_userguide/Package_Contents_os.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Package Contents
55

66

77
|full_name| includes dynamic library files and header files for Windows\*, Linux\*
8-
and macOS\* operating systems as described in this section.
8+
and macOS\* operating systems as well as a number of supporting files like CMake and pkg-config files as described in this section.
99

1010
.. toctree::
1111
:maxdepth: 4

‎doc/main/tbb_userguide/Scalable_Memory_Allocator.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ general support and the other with a scalable memory allocator. The
1010
latter is distinguished by ``malloc`` in its name. For example, the
1111
release versions for Windows\* OS are ``tbb<version>.dll`` and ``tbbmalloc.dll``
1212
respectively. Applications may choose to use only the general library,
13-
or only the scalable memory allocator, or both. See the links below for
13+
or only the scalable memory allocator, or both. See :ref:`Memory Allocation <Memory_allocation>` for
1414
more information on memory allocation.
1515

‎doc/main/tbb_userguide/Windows_OS_ug.rst

+20-7
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,27 @@ structure for Windows\*, relative to <*tbb_install_dir*>.
1717
- Location
1818
- Environment Variable
1919
* - Header files
20-
- | ``include\oneapi\tbb.h``
21-
| ``include\oneapi\tbb\*.h``
20+
- | ``<tbb_install_dir>\include\oneapi\tbb.h``
21+
| ``<tbb_install_dir>\include\oneapi\tbb\*.h``
2222
- ``INCLUDE``
2323
* - .lib files
24-
- ``lib\<arch>\vc<vcversion>\<lib><variant><version>.lib``\
24+
- ``<tbb_install_dir>\lib\<arch>\vc<vcversion>\<lib><version><compat_version><variant>.lib``\
2525
- ``LIB``
2626
* - .dll files
27-
- ``redist\<arch>\vc<vcversion>\<lib><variant><version>.dll``
27+
- ``<tbb_install_dir>\redist\<arch>\vc<vcversion>\<lib><version><compat_version><variant>.dll``
2828
- ``PATH``
29-
* - .pdb files
29+
* - .pdb and .def files
3030
- Same as corresponding ``.dll`` file.
3131
- \
32+
* - CMake files
33+
- ``<tbb_install_dir>\lib\cmake\tbb\*.cmake``
34+
- \
35+
* - pkg-config files
36+
- ``<tbb_install_dir>\lib\pkgconfig\*.pc``
37+
- \
38+
* - vars script
39+
- ``<tbb_install_dir>\env\vars.bat``
40+
- \
3241

3342
Where
3443

@@ -39,7 +48,7 @@ Where
3948
* ``<lib>`` - ``tbb``, ``tbbmalloc``, ``tbbmalloc_proxy`` or ``tbbbind``
4049
* ``<vcversion>``
4150

42-
- ``14`` - use for dynamic linkage with the CRT
51+
- ``14`` - use for dynamic linkage with the Microsoft C runtime (CRT)
4352

4453
- ``14_uwp`` - use for Windows 10 Universal Windows applications
4554

@@ -49,11 +58,15 @@ Where
4958

5059
* ``<variant>`` - ``_debug`` or empty
5160
* ``<version>`` - binary version
61+
* ``<compat_version>`` - compatibility version for ``tbbbind``
5262

5363
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
64+
Microsoft\* Visual C++\* or Intel® oneAPI DPC++/C++ Compiler, to find these
5565
subdirectories.
5666

67+
See the :ref:`Integrate oneTBB <integrate>` to learn how to use CMake* and pkg-config tools.
68+
Learn how to setup environment in :ref:`Next Steps <next_steps>`.
69+
5770
.. CAUTION::
5871
Ensure that the relevant product directories are mentioned by the
5972
environment variables; otherwise the compiler might not find the

0 commit comments

Comments
 (0)