Skip to content

Commit

Permalink
Merge pull request #563 from gmlueck/gmlueck/non-normative-note
Browse files Browse the repository at this point in the history
Add new non-normative note format
  • Loading branch information
gmlueck committed Jun 12, 2024
2 parents ae99673 + a2165ab commit 1d59e27
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
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_]]

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

0 comments on commit 1d59e27

Please sign in to comment.