Skip to content

Commit

Permalink
[SYCL][Doc] Add documentation to use iostream_proxy.hpp instead of <i…
Browse files Browse the repository at this point in the history
…ostream> (intel#6786)

This is to complement this [PR](intel#6469)
which removes \<iostream\> headers to comply with LLVM Coding Standards.

Signed-off-by: Rauf, Rana <rana.rauf@intel.com>

Signed-off-by: Rauf, Rana <rana.rauf@intel.com>
  • Loading branch information
raaiq1 authored Sep 27, 2022
1 parent b333cee commit 2034175
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions sycl/doc/developer/ContributeToDPCPP.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ For any DPC++-related commit, the `[SYCL]` tag should be present in the
commit message title. To a reasonable extent, additional tags can be used
to signify the component changed, e.g.: `[PI]`, `[CUDA]`, `[Doc]`.

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

## Tests development

Every product change should be accompanied with corresponding test modification
Expand Down

0 comments on commit 2034175

Please sign in to comment.