Skip to content

[SYCL][Doc] Add documentation to use iostream_proxy.hpp instead of <iostream> #6786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 27, 2022
Merged

[SYCL][Doc] Add documentation to use iostream_proxy.hpp instead of <iostream> #6786

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d8f5f45
Added documentation for iostream_proxy.hpp
raaiq1 Sep 14, 2022
e35f95b
Applied code review suggestions
raaiq1 Sep 15, 2022
68ee74f
Update ContributeToDPCPP.md
raaiq1 Sep 23, 2022
28c2423
Update ContributeToDPCPP.md
raaiq1 Sep 23, 2022
dab251a
Update ContributeToDPCPP.md
raaiq1 Sep 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions sycl/doc/developer/ContributeToDPCPP.md
View file
Open in desktop
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