Skip to content

Integrate the specification into the oneDPL documentation#2640

Merged
akukanov merged 5 commits intomainfrom
doc/integrate-spec
Mar 25, 2026
Merged

Integrate the specification into the oneDPL documentation#2640
akukanov merged 5 commits intomainfrom
doc/integrate-spec

Conversation

@akukanov
Copy link
Contributor

@akukanov akukanov commented Mar 23, 2026

On top of #2621, this PR makes changes to build the oneDPL specification as part of the overall project documentation.

  • Add it as a top-level item to the table of content
  • Remove or replace missing variables
  • Change the version to 1.5-provisional, decoupled from the oneAPI specification version
  • Add a missing copyright notice.

Comment on lines 1 to 3
.. SPDX-FileCopyrightText: 2019-2022 Intel Corporation
.. SPDX-FileCopyrightText: Contributors to the oneAPI Specification project.
..
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two copyright notices are consistent within the oneDPL specification, with two exceptions:

  • sycl_kernels_api.rst misses the "contributors" notice;
  • parallel_range_api.rst misses the Intel Corporation notice

The marked change addresses the first one, but the second one is I believe intentional. The logic behind this is that after 2022 Intel acted as one but not the only contributor to the specification (technically, though, all modifications of the oneDPL spec came from Intel, according to the commit log). Since the parallel range algorithms were added to the spec only in 2024, there is no Intel copyright notice.

Perhaps it makes sense to change the second notice to "UXL Foundation Contributors". As for the years in the first notice, I think we can either leave these as-is, change to 2019-2023 (assuming that it's transmitted to UXL then), or change to the year of the last modification. I have some preference for 2023.

@akukanov akukanov force-pushed the doc/integrate-spec branch from 5efe187 to 05c6d60 Compare March 23, 2026 14:58
@akukanov akukanov added this to the 2022.12.0 milestone Mar 23, 2026
Copy link
Contributor

@timmiesmith timmiesmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

timmiesmith
timmiesmith previously approved these changes Mar 24, 2026
@akukanov akukanov marked this pull request as ready for review March 25, 2026 13:33
======
oneDPL
======
This is the specification of |onedpl_long|, version 1.5-provisional.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this document is best positioned as a provisional specification at this point, There is still at least one change in progress, and generally, I think we need some formal decision to "release" the new specification.

Copy link
Contributor

@danhoeflinger danhoeflinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@akukanov akukanov merged commit a3d2957 into main Mar 25, 2026
2 checks passed
@akukanov akukanov deleted the doc/integrate-spec branch March 25, 2026 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants