Skip to content

Commit e901d30

Browse files
fix clang format, update docs
Signed-off-by: Tikhomirova, Kseniya <[email protected]>
1 parent fb11e68 commit e901d30

File tree

5 files changed

+38
-20
lines changed

5 files changed

+38
-20
lines changed

libsycl/.clang-format

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
BasedOnStyle: LLVM
2+
3+
# Preferred indentions of preprocessor statements.
4+
IndentPPDirectives: AfterHash

libsycl/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ libsycl runtime library and headers require C++17 support or higher.
99

1010
### How to use libsycl with Clang
1111

12-
TBD
12+
TODO
1313

1414
#### How to build
1515

16-
TBD
16+
TODO
1717

1818
# License
1919

libsycl/docs/index.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
1+
=====================
2+
SYCL runtime implementation
3+
=====================
4+
5+
.. contents::
6+
:local:
7+
18
.. _index:
29

310
Current Status
4-
==============
11+
========
512

613
The implementation is in the very early stages of upstreaming. The first milestone is to get
714
support for a simple SYCL application with device code using Unified Shared Memory:
@@ -46,6 +53,9 @@ This requires at least partial support of the following functionality on the lib
4653
* Unified shared memory allocation/deallocation
4754
* Program manager, an internal component for retrieving and using device images from the multi-architectural binaries
4855

56+
Builds steps
57+
========
58+
4959
To build LLVM with libsycl runtime enabled the following script can be used.
5060

5161
.. code-block:: console

libsycl/include/sycl/__detail/config.hpp

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,31 +28,31 @@
2828

2929
#ifndef __SYCL_DEVICE_ONLY__
3030

31-
#ifndef _LIBSYCL_EXPORT
32-
#ifdef _WIN32
31+
# ifndef _LIBSYCL_EXPORT
32+
# ifdef _WIN32
3333

34-
#define _LIBSYCL_DLL_LOCAL
34+
# define _LIBSYCL_DLL_LOCAL
3535

36-
#if _LIBSYCL_BUILD_SYCL_DLL
37-
#define _LIBSYCL_EXPORT __declspec(dllexport)
38-
#else
39-
#define _LIBSYCL_EXPORT __declspec(dllimport)
40-
#endif //_LIBSYCL_BUILD_SYCL_DLL
36+
# if _LIBSYCL_BUILD_SYCL_DLL
37+
# define _LIBSYCL_EXPORT __declspec(dllexport)
38+
# else
39+
# define _LIBSYCL_EXPORT __declspec(dllimport)
40+
# endif //_LIBSYCL_BUILD_SYCL_DLL
4141

42-
#else // _WIN32
42+
# else // _WIN32
4343

44-
#define _LIBSYCL_DLL_LOCAL __attribute__((visibility("hidden")))
45-
#define _LIBSYCL_EXPORT __attribute__((visibility("default")))
44+
# define _LIBSYCL_DLL_LOCAL [[gnu::visibility("hidden")]]
45+
# define _LIBSYCL_EXPORT [[gnu::visibility("default")]]
4646

47-
#endif // _WIN32
48-
#endif // _LIBSYCL_EXPORT
47+
# endif // _WIN32
48+
# endif // _LIBSYCL_EXPORT
4949

5050
#else // __SYCL_DEVICE_ONLY__
5151

52-
#ifndef _LIBSYCL_EXPORT
53-
#define _LIBSYCL_EXPORT
54-
#define _LIBSYCL_DLL_LOCAL
55-
#endif
52+
# ifndef _LIBSYCL_EXPORT
53+
# define _LIBSYCL_EXPORT
54+
# define _LIBSYCL_DLL_LOCAL
55+
# endif
5656

5757
#endif // __SYCL_DEVICE_ONLY__
5858

libsycl/include/sycl/sycl.hpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
66
//
77
//===----------------------------------------------------------------------===//
8+
///
9+
/// \file
10+
/// This file is a SYCL2020 standard header file.
11+
///
12+
//===----------------------------------------------------------------------===//
813

914
#ifndef _LIBSYCL_SYCL_HPP
1015
#define _LIBSYCL_SYCL_HPP

0 commit comments

Comments
 (0)