Skip to content
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.

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

Update queue description to new format #606

Merged
merged 6 commits into from
Oct 3, 2024

Conversation

gmlueck
Copy link
Contributor

@gmlueck gmlueck commented Aug 25, 2024

Update the section describing the queue class to the new format.

Update the section describing the `queue` class to the new format.
@TApplencourt
Copy link
Contributor

Thanks will review this week!

@TApplencourt TApplencourt self-assigned this Aug 26, 2024
@@ -53,22 +53,25 @@ class queue {

bool is_in_order() const;

template <typename Param> typename Param::return_type get_info() const;
template <typename Param>
Copy link
Contributor

Choose a reason for hiding this comment

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

It's not important, but AFAIK those files were formatted via clang format.
In the future, we should commit a clang-format-config on we a style we like and stick with it.

adoc/headers/queue.h Outdated Show resolved Hide resolved
adoc/chapters/programming_interface.adoc Show resolved Hide resolved
adoc/chapters/programming_interface.adoc Outdated Show resolved Hide resolved
a@
[source]
_Effects:_ Submit a <<command-group-function-object>> to the queue, in order to
be scheduled for execution on the device.
Copy link
Contributor

Choose a reason for hiding this comment

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

Missing the Synchronous errors are reported through SYCL exceptions.?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The text I have here describing the submit function is exactly the same as the text prior to this PR. The only thing I added was the word "Effects".

I do agree that the submit function could throw a synchronous exception if there is an error condition, but the sentence you propose was not there before. Are you suggesting that we should add it as part of this PR?

Copy link
Contributor

@TApplencourt TApplencourt Sep 16, 2024

Choose a reason for hiding this comment

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

Thanks for the clarification.
We can do it in a follow-up PR. Cleaner indeed

Improve the wording of the event that is returned by `queue::submit` and
friends.

Since the new wording says that the event represents the *command* that
is submitted to the queue, it seemed awkward for the _Effects_ paragraph
to say that a *command group function* is submitted to the queue.  I
replaced this with wording saying that the command group function is
immediately called, which is consistent with what we say in the
introductory paragraphs of section 4.6.5 "Queue class".  The new wording
also notes that the command group function may submit no more than one
command to the queue, which is consistent with the existing wording in
section 4.9.3 "Command group scope".
These sentences had two clauses, but one was passive voice while the
other was active voice.  Change them so both clauses are passive voice.
Copy link
Member

@keryell keryell left a comment

Choose a reason for hiding this comment

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

Thanks!

@tomdeakin
Copy link
Contributor

WG approved to merge.

@gmlueck gmlueck merged commit 23f8a15 into KhronosGroup:main Oct 3, 2024
3 checks passed
@gmlueck gmlueck deleted the gmlueck/reformat-queue branch October 3, 2024 18:38
gmlueck added a commit to gmlueck/SYCL-Docs that referenced this pull request Oct 3, 2024
Cherry pick KhronosGroup#606 from main
(cherry picked from commit 23f8a15)
gmlueck added a commit that referenced this pull request Nov 7, 2024
Update queue description to new format

(cherry picked from commit 23f8a15)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants