Skip to content

Commit 2034175

Browse files
authored
[SYCL][Doc] Add documentation to use iostream_proxy.hpp instead of <iostream> (#6786)
This is to complement this [PR](#6469) which removes \<iostream\> headers to comply with LLVM Coding Standards. Signed-off-by: Rauf, Rana <[email protected]> Signed-off-by: Rauf, Rana <[email protected]>
1 parent b333cee commit 2034175

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

sycl/doc/developer/ContributeToDPCPP.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ For any DPC++-related commit, the `[SYCL]` tag should be present in the
3131
commit message title. To a reasonable extent, additional tags can be used
3232
to signify the component changed, e.g.: `[PI]`, `[CUDA]`, `[Doc]`.
3333

34+
## Using \<iostream\>
35+
According to [LLVM Coding Standards](https://llvm.org/docs/CodingStandards.html#include-iostream-is-forbidden),
36+
the use `#include <iostream>` is forbidden in library files. Instead, the
37+
sycl/detail/iostream_proxy.hpp header offers the functionality of <iostream>
38+
without its static constructor.
39+
This header should be used in place of <iostream> in DPC++ headers
40+
and runtime library files.
41+
3442
## Tests development
3543

3644
Every product change should be accompanied with corresponding test modification

0 commit comments

Comments
 (0)