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

Add new non-normative note format #563

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion adoc/chapters/architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,8 @@ Programming languages — {cpp}>>, referred to in this specification as the next
Unless stated otherwise, text within this SYCL specification is normative and
defines the required behavior of a SYCL implementation.
Non-normative / informational notes are included within this specification using
a "`note`" callout, of the form:
either of two formats.
One format for non-normative notes is the "`note`" callout of this form:

[NOTE]
====
Expand All @@ -170,6 +171,11 @@ purposes and does not impose requirements on or specify behavior of a SYCL
implementation.
====

The other format for a non-normative note is like this:

{note}This is also a non-normative note.
{endnote}

Source code examples within the specification are provided to aid with
understanding, and are non-normative.

Expand Down
11 changes: 11 additions & 0 deletions adoc/syclbase.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,17 @@ include::config/attribs.adoc[]
:cpp20: pass:[C++20]
// Fortunately, the cpp macro for C++ is defined by default in AsciiDoctor

// Use these to format a non-normative note. The Asciidoc source:
//
// {note}Caveat emptor.
// {endnote}
//
// is formatted like:
//
// [Note: Caveat emptor. -- end note]
:note: pass:q[[_Note:_ ]
:endnote: pass:q,a[_—{nbsp}end{nbsp}note_]]
TApplencourt marked this conversation as resolved.
Show resolved Hide resolved

// SYCL Algebraic definitions
:SYCLeval: Satisfied
:SYCLperform: Perform
Expand Down
Loading