Skip to content

Commit a53fa88

Browse files
committed
Review of contributor guides
1 parent 0cb2181 commit a53fa88

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

docs/doc_sources/contributor_guides/building.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,20 @@
33
Building from the Source
44
========================
55

6-
To build :py:mod:`dpctl` from the source, you need DPC++ compiler.
6+
To build :py:mod:`dpctl` from the source, you need the Intel(R) oneAPI DPC++ compiler.
77
To run examples and test suite you would need GPU drivers and/or CPU
88
OpenCL drivers. It is preferable to use the Intel(R) oneAPI DPC++ compiler
9-
available as part of oneAPI Base-Kit. However, it is possible to use a custom
9+
available as part of the oneAPI Base Kit. However, it is possible to use a custom
1010
build of DPC++ to build :py:mod:`dpctl`, especially if you want to enable
11-
CUDA support or try latest features.
11+
CUDA* support or try the latest features.
1212

1313
Building using oneAPI DPC++
1414
---------------------------
1515

16-
Install oneAPI and graphics drivers to the system prior
17-
to proceeding further.
16+
prerequisites
17+
~~~~~~~~~~~~~
18+
19+
Install oneAPI and graphics drivers to the system.
1820

1921
Activate oneAPI
2022
~~~~~~~~~~~~~~~
@@ -138,7 +140,7 @@ You can build dpctl from the source using the `DPC++ toolchain <https://github.c
138140
instead of the DPC++ compiler that comes with oneAPI.
139141

140142
Following steps in the `Build and install with scikit-build`_ use a command-line option to set
141-
the relevant CMake variables, for example:
143+
the relevant CMake variables. For example:
142144

143145
.. code-block:: bash
144146
@@ -167,7 +169,7 @@ To build the library, you need:
167169
* ``ninja`` or ``make``
168170
* Optionally ``gtest 1.10`` if you want to build and run the test suite
169171

170-
For example, on Linux OS the following script can be used to build the C oneAPI
172+
For example, on Linux* OS the following script can be used to build the C oneAPI
171173
library.
172174

173175
.. code-block:: bash

docs/doc_sources/contributor_guides/memory_ownership_sycl_interface.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Working with DPCTLSyclInterface library
44
=======================================
55

6-
The DPCLSyclInterface library is a C-API library which does provide select C++ functions
6+
The DPCLSyclInterface library is a C-API library which provides select C++ functions
77
for casting from C opaque pointers to pointers to corresponding C++ classes.
88

99
This document explains the memory ownership model adopted by DPCTLSyclInterface.

0 commit comments

Comments
 (0)