Skip to content

Commit 950d3b5

Browse files
author
Colin Davidson
authored
Merge pull request #1003 from coldav/colin/update_emails
[DOCUMENTATION] General tidy ups of email addresses and links
2 parents 988ddd8 + 891acce commit 950d3b5

9 files changed

Lines changed: 14 additions & 90 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -53,21 +53,6 @@ or acting as an appointed representative at an online or offline event.
5353
Representation of a project may be further defined and clarified by project
5454
maintainers.
5555

56-
## Enforcement
57-
58-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59-
reported by contacting the project team at
60-
[oneapi.construction.kit@codeplay.com](mailto:oneapi.construction.kit@codeplay.com).
61-
All complaints will be reviewed and investigated and will result in a response
62-
that is deemed necessary and appropriate to the circumstances. The project team
63-
is obligated to maintain confidentiality with regard to the reporter of an
64-
incident. Further details of specific enforcement policies may be posted
65-
separately.
66-
67-
Project maintainers who do not follow or enforce the Code of Conduct in good
68-
faith may face temporary or permanent repercussions as determined by other
69-
members of the project's leadership.
70-
7156
## Attribution
7257

7358
This Code of Conduct is adapted from the [Contributor
@@ -76,7 +61,5 @@ https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
7661

7762
---
7863

79-
If there are any issues or suggestions relating to the current set of rules,
80-
you can reach us at
81-
[oneapi.construction.kit@codeplay.com](mailto:oneapi.construction.kit@codeplay.com).
82-
64+
If there are any issues or suggestions relating to the current set of rules, you
65+
can reach us by raising a [github issue](https://github.com/uxlfoundation/oneapi-construction-kit/issues).

CONTRIBUTING.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,7 @@ where appropriate.
3333
This project and everyone participating in it are governed by the [oneAPI
3434
Construction Kit Code of Conduct](blob/main/CODE_OF_CONDUCT.md). By
3535
participating, you are expected to uphold this code and use your best judgement
36-
where it's unclear if your behaviour would violate the code. Please report
37-
unacceptable behaviour to
38-
[oneapi.construction.kit@codeplay.com](mailto:oneapi.construction.kit@codeplay.com).
36+
where it's unclear if your behaviour would violate the code.
3937

4038
# I want to contribute
4139

@@ -86,7 +84,7 @@ with potential bugs as quickly and as smoothly as possible.
8684
If you have discovered a security vulnerability, sensitive information leak, or
8785
a similar security-related issue, please do **not** report this directly to the
8886
issue tracker. Instead, please send your report by email to
89-
[oneapi.construction.kit@codeplay.com](mailto:oneapi.construction.kit@codeplay.com),
87+
[security@uxlfoundation.org](mailto:security@uxlfoundation.org),
9088
making sure to write `DISCLOSURE:` at the beginning of the subject line so that
9189
we can prioritize accordingly.
9290

@@ -125,7 +123,7 @@ in preparation for your suggestion.
125123
the
126124
[main branch](https://github.com/uxlfoundation/oneapi-construction-kit/blob/main).
127125
* Read the
128-
[Documentation](https://developer.codeplay.com/products/oneapi/construction-kit/guides)
126+
[Documentation](https://uxlfoundation.github.io/oneapi-construction-kit/doc)
129127
carefully and make sure your suggested functionality is not already covered
130128
by the project or by an individual configuration of the project.
131129
* Check to see if the enhancement has already been suggested in
@@ -230,10 +228,4 @@ maintainers to review your changes.
230228

231229
Once again, thank you for expressing interest in contributing to the project.
232230
If you'd like to contribute in any way but are unclear on the guidelines listed
233-
above, please don't hesitate to get in touch by [asking a
234-
question](#i-have-a-question).
235-
236-
Finally, if you would like to get in touch with us directly to discuss the
237-
oneAPI Construction Kit, please contact
238-
[oneapi.construction.kit@codeplay.com](mailto:oneapi.construction.kit@codeplay.com)
239-
and include all relevant details.
231+
above, please read [Support](README.md#support).

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ and external components.
2828
oneAPI Construction Kit was previously referred to as ComputeAorta and referred to as acronym `CA`. As a result, references to ComputeAorta or CA may be present in some oneAPI Construction Kit's documentation and code.
2929

3030
## Get started with the oneAPI Construction Kit
31-
This section provides the minimum system requirements for building the oneAPI Construction Kit on Ubuntu 22.04. For Windows platform dependencies and build instructions please refer to the [developer guide](doc/developer-guide.md). There is a [blog post](https://codeplay.com/portal/blogs/2023/06/05/introducing-the-oneapi-construction-kit) demonstrating how to build the kit for a simulated RISC-V target. You can also find the documentation on [Codeplay's developer website](https://developer.codeplay.com/products/oneapi/construction-kit/home/).
31+
This section provides the minimum system requirements for building the oneAPI Construction Kit on Ubuntu 22.04. For Windows platform dependencies and build instructions please refer to the [developer guide](doc/developer-guide.md). There is a [blog post](https://web.archive.org/web/20250516110421/https://codeplay.com/portal/blogs/2023/06/05/introducing-the-oneapi-construction-kit) demonstrating how to build the kit for a simulated RISC-V target.
3232

3333
### Platform Dependencies
3434
* [GCC](https://gcc.gnu.org/)
@@ -400,7 +400,7 @@ If you would like to open a new question, we ask that you follow these steps:
400400
Once your question has been opened, we will take a look and try to help you as
401401
soon as possible.
402402

403-
[Documentation]: https://developer.codeplay.com/products/oneapi/construction-kit/guides
403+
[Documentation]: https://uxlfoundation.github.io/oneapi-construction-kit/doc
404404
[GitHub Discussions Q&A]: https://github.com/uxlfoundation/oneapi-construction-kit/discussions/categories/q-a
405405
[GitHub Issues]: https://github.com/uxlfoundation/oneapi-construction-kit/issues
406406

doc/modules/builtins/libimg.md

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -233,42 +233,3 @@ be generated.
233233
```
234234
-DCODEPLAY_IMG_ENABLE_DOCUMENTATION=ON
235235
```
236-
237-
## ComputeCpp Integration
238-
239-
A quick overview of the road map for IMG integration with ComputeCpp.
240-
241-
### IMG requires
242-
243-
* A header containing typedef's of ComputeCpp vector types.
244-
* This is to be included in the image functions header file.
245-
* The naming convention for the vector typedefs is to prefix the OpenCL C
246-
vector type names with two underscores such as `__float4`.
247-
* A header containing vector element access functions.
248-
* This is to generalise access to vector elements between the OpenCL C
249-
appraoch and the SYCL appraoch.
250-
* The naming convention for vector access functions is to declare the
251-
functions in the `img` namespace such as `float img::get(float4 &v, int i)`.
252-
* A header containing wrappers around ComputeCpp built-in functions.
253-
* This is to be included in the image functions source file.
254-
* The naming convention for the function declarations is to declare the
255-
functions in the `img` namespace such as `int2 img::clamp(int2 x, int2
256-
minval, int2 maxval)`.
257-
* May require the provision of a library path to link with to access the
258-
built-in function definitions.
259-
260-
### IMG provides
261-
262-
* A list of required built-in functions it depends on.
263-
* List is TBD.
264-
* A header declaring the image library functions.
265-
* This is to be included by ComputeCpp to implement the SYCL image host
266-
fallback.
267-
* A static library defining the image library functions.
268-
* Provides the definitions of the IMG image library functions.
269-
270-
### IMG does not provide
271-
272-
* The SYCL function types to be used in the image host fallback.
273-
* The intention is for ComputeCpp to wrap the IMG declarations in inline
274-
functions.

doc/overview/example-scenarios/mapping-custom-instructions-to-builtin-functions.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,14 @@ Creating and exposing new custom builtins so that they can be used from SYCL
108108
kernels follows a similar process to OpenCL, with some differences.
109109
Builtin declarations can be added to a C++ SYCL header that is specific to the
110110
target. This header needs to be explicitly included by the kernel source file
111-
and used by the ComputeCpp device compiler to generate declarations for these
111+
and used by the DPC++ device compiler to generate declarations for these
112112
builtin functions when compiling the kernel to SPIRV.
113113

114-
SPIR-V code generated by ComputeCpp is then translated into LLVM IR by
114+
SPIR-V code generated by DPC++ is then translated into LLVM IR by
115115
the oneAPI Construction Kit and passed to the ComputeMux target. From that
116116
point on, the compilation process is the same for custom builtins exposed
117117
through OpenCL and SYCL. A LLVM pass is needed to translate custom builtin
118118
calls to compiler intrinsics.
119119

120120
In some cases, SPIR-V extensions to add new custom SPIR-V opcodes **may**
121-
be necessary. Please refer to the ComputeCpp documentation for more details on
122-
the SPIR-V compilation process.
121+
be necessary.

doc/overview/example-scenarios/refsi-in-kernel-dma.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ simulator, the RISC-V target supports a mechanism that allows kernels to perform
66
data transfers between different kinds of simulated memory. This feature is
77
called RefSi In-Kernel DMA and it serves as an example of how
88
accelerator-controlled DMA can be integrated in the oneAPI Construction Kit and
9-
ComputeCpp for existing hardware. DMA transfers can be configured, started and
9+
oneAPI toolchain for existing hardware. DMA transfers can be configured, started and
1010
waited for through an interface consisting of memory-mapped registers. The current
1111
implementation simulates memory transfers at a high level, not taking into
1212
account memory bandwidth nor being tied to the RISC-V pipeline.

doc/overview/introduction/architecture.rst

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -262,15 +262,12 @@ oneAPI Construction Kit is designed to slot into a `SYCL`_ technology stack, as
262262
`SYCL Backend`_, or oneAPI Construction Kit can be used to write an implementation of
263263
SYCL directly to a system or device.
264264

265-
oneAPI Construction Kit has thoroughly tested integration with `ComputeCpp`_, Codeplay's
265+
oneAPI Construction Kit has thoroughly tested integration with `DPC++`_, Intel's
266266
implementation of the `SYCL 1.2.1`_ and `SYCL 2020`_ specifications. This
267267
allows `SYCL`_ applications to be run through oneAPI Construction Kit, encouraging the
268268
development of OpenCL extensions and optimizations in oneAPI Construction Kit that are of
269269
benefit to software using `SYCL`_.
270270

271-
To learn more about ComputeCpp see the :doc:`ComputeCpp Overview
272-
</computecpp>`.
273-
274271
.. _SYCL:
275272
https://www.khronos.org/sycl
276273
.. _SYCL 1.2.1:
@@ -279,5 +276,3 @@ To learn more about ComputeCpp see the :doc:`ComputeCpp Overview
279276
https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html
280277
.. _SYCL Backend:
281278
https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#_the_sycl_backend_model
282-
.. _ComputeCpp:
283-
https://developer.codeplay.com/products/computecpp/ce/home

doc/overview/preface.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,6 @@ requirements it places on that hardware or software.
1717

1818
Related documents that you may have access to include:
1919

20-
* ComputeCpp Overview
21-
* `ComputeCpp User Guides`_
2220
* ComputeMux Specifications
2321
* HAL Specification
2422
* oneAPI Construction Kit Reference Documentation
25-
26-
.. _ComputeCpp User Guides:
27-
https://developer.codeplay.com/products/computecpp/ce/guides/#computecpp

doc/overview/reference-silicon/overview.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ where the "Host CPU" offloads the key computations to an accelerator.
1616

1717
The platform is meant as an example for how Acoran maps to hardware with similar
1818
components and features. It is used to demonstrate how such hardware
19-
features can be integrated within Acoran components such as ComputeCpp,
20-
oneAPI Construction Kit and libraries such as SYCL-BLAS and SYCL-DNN.
19+
features can be integrated with toolchains such as provided by oneAPI.
2120

2221
In this section we will describe the first version RefSi Accelerator
2322
architecture (RefSi M1), its components and how these components interact. A

0 commit comments

Comments
 (0)