Skip to content

Commit

Permalink
Fail spec creation if asciidoctor errors are encountered (#1205)
Browse files Browse the repository at this point in the history
* Fail spec creation if asciidoctor errors are encountered

This would have enabled the CI to catch a markup issue introduced by #938.

Signed-off-by: Kevin Petit <kevin.petit@arm.com>
Change-Id: I49de3eaf623117f7c29d1019dedf5b342766a029

* attempt to fix asciidoctor errors in API spec

Change-Id: I0f9cbeddb72e0d76ba508b336d91c4ee640d77ad

---------

Signed-off-by: Kevin Petit <kevin.petit@arm.com>
  • Loading branch information
kpet committed Jul 10, 2024
1 parent 110a226 commit 735396c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ ADOCCOMMONOPTS = -a apispec="$(CURDIR)/api" \
-a cspec="$(CURDIR)/c" \
-a images="$(CURDIR)/images" \
$(ATTRIBOPTS) $(NOTEOPTS) $(VERBOSE) $(ADOCEXTS)
ADOCOPTS = -d book $(ADOCCOMMONOPTS)
ADOCOPTS = --failure-level ERROR -d book $(ADOCCOMMONOPTS)

# Asciidoctor options to build refpages
#
Expand Down
8 changes: 4 additions & 4 deletions api/opencl_runtime_layer.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2524,29 +2524,29 @@ The memory layout of this image format is described below:

[width="60%",cols="<10%,<10%,<10%,<10%,<60%"]
|====
| R | G | B | A | ... |
| R | G | B | A | ...
|====

with the corresponding byte offsets

[width="60%",cols="<10%,<10%,<10%,<10%,<60%"]
|====
| 0 | 1 | 2 | 3 | ... |
| 0 | 1 | 2 | 3 | ...
|====

Similar, if `image_channel_order` = {CL_RGBA} and `image_channel_data_type` =
{CL_SIGNED_INT16}, the memory layout of this image format is described below:

[width="60%",cols="<10%,<10%,<10%,<10%,<60%"]
|====
| R | G | B | A | ... |
| R | G | B | A | ...
|====

with the corresponding byte offsets

[width="60%",cols="<10%,<10%,<10%,<10%,<60%"]
|====
| 0 | 2 | 4 | 6 | ... |
| 0 | 2 | 4 | 6 | ...
|====

`image_channel_data_type` values of {CL_UNORM_SHORT_565}, {CL_UNORM_SHORT_555},
Expand Down

0 comments on commit 735396c

Please sign in to comment.