Add the specification to the docs by akukanov · Pull Request #2621 · uxlfoundation/oneDPL

akukanov · 2026-03-17T10:29:20Z

Copy the oneDPL specification source files from https://github.com/uxlfoundation/oneAPI-spec/tree/main/source/elements/oneDPL/source, commit 0d9d8e993c3b077dad7922c8f3096d9dd5d938d0

timmiesmith

This looks good to me. I noticed that we're not consistent in the use of dates in the copyright notice. I'd prefer to see the years removed for simplicity, but if we need to keep them I've checked the oneAPI-spec repo to identify what the ranges should be for each file.

timmiesmith · 2026-03-19T15:29:45Z

documentation/specification/sycl_kernels_api.rst

@@ -0,0 +1,197 @@
+.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation


Suggested change

.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

.. SPDX-FileCopyrightText: 2019-2025 Intel Corporation

I will update the copyrights in a subsequent PR.

timmiesmith · 2026-03-19T15:30:55Z

documentation/specification/parallel_api/algorithms.rst

@@ -0,0 +1,309 @@
+.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation


Suggested change

.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

.. SPDX-FileCopyrightText: 2019-2025 Intel Corporation

Update year to the last time a PR touched the file.

timmiesmith · 2026-03-19T15:31:27Z

documentation/specification/parallel_api/buffer_wrappers.rst

@@ -0,0 +1,113 @@
+.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation


Suggested change

.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

.. SPDX-FileCopyrightText: 2019-2025 Intel Corporation

Update year to the last time a PR touched the file.

timmiesmith · 2026-03-19T15:32:19Z

documentation/specification/parallel_api/execution_policies.rst

@@ -0,0 +1,243 @@
+.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation


Suggested change

.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

.. SPDX-FileCopyrightText: 2019-2025 Intel Corporation

timmiesmith · 2026-03-19T15:32:33Z

documentation/specification/parallel_api/iterators.rst

@@ -0,0 +1,457 @@
+.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation


Suggested change

.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

.. SPDX-FileCopyrightText: 2019-2025 Intel Corporation

timmiesmith · 2026-03-19T15:33:36Z

documentation/specification/parallel_api/parallel_range_api.rst

@@ -0,0 +1,1054 @@
+.. SPDX-FileCopyrightText: Contributors to the oneAPI Specification project.
+..


There is no mention of the Copyright year(s) here. Do we want to remove the years from the other files or add it here so that we are consistent?

timmiesmith · 2026-03-19T15:34:12Z

documentation/specification/common.rst

@@ -0,0 +1,53 @@
+.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation


Suggested change

.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

.. SPDX-FileCopyrightText: 2019-2024 Intel Corporation

timmiesmith · 2026-03-19T15:35:37Z

documentation/specification/conf.py

@@ -0,0 +1,27 @@
+# SPDX-FileCopyrightText: 2019-2020 Intel Corporation
+#


This seems to be the oldest file and doesn't mention years in the copyright notice. I think I'd prefer to remove it from the others to be consistent.

timmiesmith · 2026-03-19T15:36:23Z

documentation/specification/index.rst

@@ -0,0 +1,50 @@
+.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation


Suggested change

.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

.. SPDX-FileCopyrightText: 2019-2024 Intel Corporation

If we decide to keep years in the notice

timmiesmith · 2026-03-19T15:39:14Z

documentation/specification/parallel_api.rst

@@ -0,0 +1,30 @@
+.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation


Suggested change

.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

.. SPDX-FileCopyrightText: 2019-2025 Intel Corporation

documentation/specification/conf.py

danhoeflinger · 2026-03-19T15:53:23Z

documentation/specification/index.rst

+oneDPL Specification
+====================
+
+This is the specification of |onedpl_long|, version 1.5.


I think we should mention that the history can be found at https://github.com/uxlfoundation/oneAPI-spec/, and that we are copying this as of a specific commit hash (15dd358db74b31dc9a5668b8127d872f4210ed3a).

I will mention that in the commit message, as well as in the description of this PR which the commit message will refer to. I think that should be sufficient to track the history.

documentation/specification/index.rst

akukanov · 2026-03-20T15:02:52Z

@timmiesmith @danhoeflinger My intent for this PR was to just copy the source files and do bare minimum necessary to add the spec into the doc tree, with other changes done in subsequent PRs.

Maybe I should leave just the single "copy the files" commit here, making all other changes in a new PR. Update: I have done that.

…ndation/oneAPI-spec/tree/main/source/elements/oneDPL/source, commit 0d9d8e993c3b077dad7922c8f3096d9dd5d938d0

timmiesmith

LGTM. Thank you.

danhoeflinger

LGTM

dmitriy-sobolev · 2026-03-24T18:20:23Z

Should we integrate the specification into the documentation tree, e.g. by adding it into https://github.com/uxlfoundation/oneDPL/blob/main/documentation/library_guide/guide_toc.rst or https://github.com/uxlfoundation/oneDPL/blob/main/documentation/index.rst?

timmiesmith · 2026-03-24T18:31:42Z

Should we integrate the specification into the documentation tree, e.g. by adding it into https://github.com/uxlfoundation/oneDPL/blob/main/documentation/library_guide/guide_toc.rst or https://github.com/uxlfoundation/oneDPL/blob/main/documentation/index.rst?

#2640 does this.

akukanov force-pushed the doc/add-spec-sources branch 6 times, most recently from e97510c to 571180b Compare March 18, 2026 11:08

akukanov marked this pull request as ready for review March 18, 2026 11:27

akukanov marked this pull request as draft March 18, 2026 11:27

akukanov changed the title ~~Documentation restructure and improvements~~ Add the specification to the docs Mar 18, 2026

akukanov added this to the 2022.12.0 milestone Mar 18, 2026

akukanov force-pushed the doc/add-spec-sources branch from 02b25cc to 3624ad9 Compare March 19, 2026 14:27

akukanov marked this pull request as ready for review March 19, 2026 14:28

akukanov requested review from danhoeflinger, timmiesmith and vossmjp March 19, 2026 14:28

timmiesmith previously approved these changes Mar 19, 2026

View reviewed changes

danhoeflinger reviewed Mar 19, 2026

View reviewed changes

documentation/specification/conf.py Outdated Show resolved Hide resolved

danhoeflinger reviewed Mar 19, 2026

View reviewed changes

documentation/specification/index.rst Outdated Show resolved Hide resolved

Copy oneDPL specification source files from https://github.com/uxlfou…

b1afb07

…ndation/oneAPI-spec/tree/main/source/elements/oneDPL/source, commit 0d9d8e993c3b077dad7922c8f3096d9dd5d938d0

akukanov dismissed timmiesmith’s stale review via b1afb07 March 23, 2026 11:32

akukanov force-pushed the doc/add-spec-sources branch from 3624ad9 to b1afb07 Compare March 23, 2026 11:32

akukanov requested review from danhoeflinger and timmiesmith March 23, 2026 11:40

akukanov mentioned this pull request Mar 23, 2026

Integrate the specification into the oneDPL documentation #2640

Merged

timmiesmith approved these changes Mar 23, 2026

View reviewed changes

danhoeflinger approved these changes Mar 23, 2026

View reviewed changes

akukanov merged commit 922dd10 into main Mar 23, 2026
2 checks passed

akukanov deleted the doc/add-spec-sources branch March 23, 2026 14:52

		@@ -0,0 +1,197 @@
		.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

	.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation
	.. SPDX-FileCopyrightText: 2019-2025 Intel Corporation

		@@ -0,0 +1,309 @@
		.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

		@@ -0,0 +1,113 @@
		.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

		@@ -0,0 +1,243 @@
		.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

		@@ -0,0 +1,457 @@
		.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

		@@ -0,0 +1,1054 @@
		.. SPDX-FileCopyrightText: Contributors to the oneAPI Specification project.
		..

		@@ -0,0 +1,53 @@
		.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

	.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation
	.. SPDX-FileCopyrightText: 2019-2024 Intel Corporation

		@@ -0,0 +1,27 @@
		# SPDX-FileCopyrightText: 2019-2020 Intel Corporation
		#

		@@ -0,0 +1,50 @@
		.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

		@@ -0,0 +1,30 @@
		.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation

Conversation

akukanov commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

timmiesmith left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

akukanov commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

timmiesmith left a comment

Choose a reason for hiding this comment

Uh oh!

danhoeflinger left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dmitriy-sobolev commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

timmiesmith commented Mar 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

akukanov commented Mar 17, 2026 •

edited

Loading

akukanov commented Mar 20, 2026 •

edited

Loading

dmitriy-sobolev commented Mar 24, 2026 •

edited

Loading