Skip to content

Commit dc3b5fe

Browse files
committed
Fix test cases in proposals-disallowed and two typos in an updated proposal.
Add $(QUIET) before most check-* build targets to cut down on noise in CI logs.
1 parent b35ce93 commit dc3b5fe

3 files changed

Lines changed: 28 additions & 23 deletions

File tree

Makefile

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ MARKUP_SPEC_SOURCES = $(SPECDIR)/[a-z]*.adoc $(SPECDIR)/chapters $(SPECDIR)/appe
472472
# Look for disallowed contractions
473473
CHECK_CONTRACTIONS = git grep -n -i -F -f $(ROOTDIR)/config/CI/contractions | grep -v -E -f $(ROOTDIR)/config/CI/contractions-allowed
474474
check-contractions:
475-
if test `$(CHECK_CONTRACTIONS) | wc -l` != 0 ; then \
475+
$(QUIET) if test `$(CHECK_CONTRACTIONS) | wc -l` != 0 ; then \
476476
echo "Contractions found that are not allowed:" ; \
477477
$(CHECK_CONTRACTIONS) ; \
478478
exit 1 ; \
@@ -481,8 +481,9 @@ check-contractions:
481481
# Look for duplicate words
482482
CHECK_DUPLICATES = $(PYTHON) $(ROOTDIR)/scripts/find_duplicates.py `find *.adoc appendices chapters config scripts style -name '*.adoc'`
483483
check-duplicates:
484-
if ! $(CHECK_DUPLICATES) ; then \
484+
$(QUIET) if ! $(CHECK_DUPLICATES) ; then \
485485
echo "Successive duplicate words found that are not allowed" ; \
486+
$(CHECK_DUPLICATES) ; \
486487
exit 1 ; \
487488
fi
488489

@@ -491,7 +492,7 @@ check-duplicates:
491492
# check-writing target below.
492493
CODESPELL = codespell --config $(ROOTDIR)/config/CI/codespellrc
493494
check-spelling:
494-
if ! $(CODESPELL) > /dev/null ; then \
495+
$(QUIET) if ! $(CODESPELL) > /dev/null ; then \
495496
echo "Found probable misspellings. Corrections can be added to config/CI/codespell-allowed, or files excluded in config/CI/codespellrc if there is no other option:" ; \
496497
$(CODESPELL) ; \
497498
exit 1 ; \
@@ -502,7 +503,7 @@ check-spelling:
502503
# made in outstanding extension branches for new text.
503504
CHECK_WRITING = git grep -n -E -f $(ROOTDIR)/config/CI/writing $(SPECDIR)/[a-z]*.adoc $(SPECDIR)/chapters $(SPECDIR)/appendices
504505
check-writing:
505-
if test `$(CHECK_WRITING) | wc -l` != 0 ; then \
506+
$(QUIET) if test `$(CHECK_WRITING) | wc -l` != 0 ; then \
506507
echo "Found old style writing. Please refer to the style guide or similar language in current main branch for fixes:" ; \
507508
$(CHECK_WRITING) ; \
508509
exit 1 ; \
@@ -511,7 +512,7 @@ check-writing:
511512
# Look for bullet list items not preceded by exactly two spaces, per styleguide
512513
CHECK_BULLETS = git grep -n -E '^( | +)[-*]+ ' $(MARKUP_SPEC_SOURCES)
513514
check-bullets:
514-
if test `$(CHECK_BULLETS) | wc -l` != 0 ; then \
515+
$(QUIET) if test `$(CHECK_BULLETS) | wc -l` != 0 ; then \
515516
echo "Bullet list item found not preceded by exactly two spaces:" ; \
516517
$(CHECK_BULLETS) ; \
517518
exit 1 ; \
@@ -520,7 +521,7 @@ check-bullets:
520521
# Look for VU text ending in a period
521522
CHECK_VUPERIOD = ag --nocolor --asciidoc '\* \[\[VUID[^.]+\.\n( {2}\* \[\[VUID|\*\*\*\*)' $(MARKUP_SPEC_SOURCES)
522523
check-vuperiod:
523-
if test `$(CHECK_VUPERIOD) | wc -l` != 0 ; then \
524+
$(QUIET) if test `$(CHECK_VUPERIOD) | wc -l` != 0 ; then \
524525
echo "VU rule ending with a disallowed period found. Note that the matched text may be very long:" ; \
525526
$(CHECK_VUPERIOD) ; \
526527
exit 1 ; \
@@ -529,7 +530,7 @@ check-vuperiod:
529530
# Look for common macro markup errors
530531
CHECK_MARKUP = git grep -n -E -f $(ROOTDIR)/config/CI/markup $(MARKUP_SPEC_SOURCES)
531532
check-markup:
532-
if test `$(CHECK_MARKUP) | wc -l` != 0 ; then \
533+
$(QUIET) if test `$(CHECK_MARKUP) | wc -l` != 0 ; then \
533534
echo "Common macro markup errors found. Please refer to the style guide or similar markup in current main branch for fixes:" ; \
534535
$(CHECK_MARKUP) ; \
535536
exit 1 ; \
@@ -538,14 +539,14 @@ check-markup:
538539
# Look for asciidoctor conditionals inside VU statements; and for
539540
# duplicated VUID numbers, but only in spec sources.
540541
check-reflow:
541-
$(PYTHON) $(SCRIPTS)/reflow.py -nowrite -noflow -check FAIL -checkVUID FAIL $(SPECFILES)
542+
$(QUIET) $(PYTHON) $(SCRIPTS)/reflow.py -nowrite -noflow -check FAIL -checkVUID FAIL $(SPECFILES)
542543

543544
# Look for files whose Khronos copyright has not been updated to the
544545
# current year
545546
DATE_YEAR = $(shell date +%Y)
546547
CHECK_DATES = git grep -z -l 'Copyright.*The Khronos' | xargs -0 git grep -L 'Copyright.*$(DATE_YEAR).*The Khronos'
547548
check-copyright-dates:
548-
if test `$(CHECK_DATES) | wc -l` != 0 ; then \
549+
$(QUIET) if test `$(CHECK_DATES) | wc -l` != 0 ; then \
549550
echo "Files with out-of-date Khronos copyrights (must be updated to $(DATE_YEAR):" ; \
550551
$(CHECK_DATES) ; \
551552
exit 1 ; \
@@ -554,51 +555,55 @@ check-copyright-dates:
554555
# Look for proper use of custom markup macros
555556
# --ignore_count 0 can be incremented if there are unfixable errors
556557
check-links:
557-
$(PYTHON) $(SCRIPTS)/check_spec_links.py -Werror --ignore_count 0
558+
$(QUIET) $(PYTHON) $(SCRIPTS)/check_spec_links.py -Werror --ignore_count 0
558559

559560
# Perform XML consistency checks
560561
# Use '-warn' option to display warnings as well as errors
561562
CHECK_UGLY_TYPE_DECL = git grep -E '</type>\*+<name>' $(VKXML)
562563
check-consistency:
563-
$(PYTHON) $(SCRIPTS)/xml_consistency.py
564-
if test `$(CHECK_UGLY_TYPE_DECL) | wc -l` != 0 ; then \
564+
$(QUIET) $(PYTHON) $(SCRIPTS)/xml_consistency.py
565+
$(QUIET) if test `$(CHECK_UGLY_TYPE_DECL) | wc -l` != 0 ; then \
565566
echo "XML contains declarations lacking whitespace:" ; \
566567
$(CHECK_UGLY_TYPE_DECL) ; \
567568
exit 1 ; \
568569
fi
569570

570571
# Look for untagged use of 'undefined' in spec sources
571572
check-undefined:
572-
$(SCRIPTS)/ci/check_undefined
573+
$(QUIET) $(SCRIPTS)/ci/check_undefined
573574

574575
# Look for use of custom macros in the proposals and other
575576
# non-Specification document (except for the ChangeLog*.adoc) markup
576577
CHECK_CUSTOM_MACROS = git grep -n -E -f $(ROOTDIR)/config/CI/custom-macros [A-Z][A-Z]*.adoc proposals/
577578
CHECK_PROPOSALS = git grep -n -E -f $(ROOTDIR)/config/CI/proposals-disallowed proposals/
578579
check-custom-macros:
579-
if test `$(CHECK_CUSTOM_MACROS) | wc -l` != 0 ; then \
580+
$(QUIET) if test `$(CHECK_CUSTOM_MACROS) | wc -l` != 0 ; then \
580581
echo "Found use of specification macros in proposal or repository metadocumentation, where they are not allowed. Please use straight asciidoc markup like *must* for fixes:" ; \
581582
$(CHECK_CUSTOM_MACROS) ; \
582583
exit 1 ; \
583584
fi
584-
if test `$(CHECK_PROPOSALS) | wc -l` != 0 ; then \
585-
echo "Found use of {refpage} attribute in proposals (use {docs} or {extensions}, see proposals/template.adoc); or of asciidoctor markup which cannot be rendered on github, such as include: or asciimath: directives:" ; \
585+
$(QUIET) if test `$(CHECK_PROPOSALS) | wc -l` != 0 ; then \
586+
echo "Found use of one or more of:" ; \
587+
echo " - {extensions} attribute in proposals (use xref:{docs} or xref:{refpages})" ; \
588+
echo " - link: used with {docs} or {extensions} (use xref:)" ; \
589+
echo " - asciidoctor markup which cannot be rendered on github, such as include: or asciimath: directives" ; \
590+
echo "(see proposals/template.adoc) for examples" ; \
586591
$(CHECK_PROPOSALS) ; \
587592
exit 1 ; \
588593
fi
589594

590595
# Look for '.txt' and '.asciidoc' files, which should almost all be .adoc now
591596
CHECK_TXTFILES = find . -name '*.txt' -o -name '*.asciidoc' | grep -v -E -f $(ROOTDIR)/config/CI/txt-files-allowed
592597
check-txtfiles:
593-
if test `$(CHECK_TXTFILES) | wc -l` != 0 ; then \
598+
$(QUIET) if test `$(CHECK_TXTFILES) | wc -l` != 0 ; then \
594599
echo "*.txt and/or .asciidoc files found that are not allowed (use .adoc):" ; \
595600
$(CHECK_TXTFILES) ; \
596601
exit 1 ; \
597602
fi
598603

599604
# Check for valid xrefs in the output html
600605
check-xrefs: $(HTMLDIR)/vkspec.html
601-
$(PYTHON) $(SCRIPTS)/check_html_xrefs.py $(HTMLDIR)/vkspec.html
606+
$(QUIET) $(PYTHON) $(SCRIPTS)/check_html_xrefs.py $(HTMLDIR)/vkspec.html
602607

603608
# Check for stuff that should not be published.
604609
# This is not part of 'allchecks' since it would fail in most new
@@ -608,7 +613,7 @@ check-internal-phrasing: check-proposed check-gitlab
608613
# Check for UNRESOLVED or PROPOSED issues in extension appendices
609614
CHECK_PROPOSED = git grep -n -E 'PROPOSED|UNRESOLVED' $(SPECDIR)/appendices/
610615
check-proposed:
611-
if test `$(CHECK_PROPOSED) | wc -l` != 0 ; then \
616+
$(QUIET) if test `$(CHECK_PROPOSED) | wc -l` != 0 ; then \
612617
echo "PROPOSED or UNRESOLVED issues should not be published in extension appendices:" ; \
613618
$(CHECK_PROPOSED) ; \
614619
exit 1 ; \
@@ -617,7 +622,7 @@ check-proposed:
617622
# Check for internal gitlab links anywhere in markup sources
618623
CHECK_GITLAB = git grep -n 'gitlab.khronos.org' $(MARKUP_SPEC_SOURCES) proposals/
619624
check-gitlab:
620-
if test `$(CHECK_GITLAB) | wc -l` != 0 ; then \
625+
$(QUIET) if test `$(CHECK_GITLAB) | wc -l` != 0 ; then \
621626
echo "Internal gitlab.khronos.org links should not be published, use corresponding github links instead:" ; \
622627
$(CHECK_GITLAB) ; \
623628
exit 1 ; \

config/CI/proposals-disallowed

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
:refpage:
2-
\{refpage\}
1+
link:\{(docs|refpages)\}
2+
\{extensions\}
33
(^|[^-_.&:<>\[[:alnum:]])(asciimath|latexmath|stem):
44
^include::

proposals/VK_EXT_descriptor_heap.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -772,7 +772,7 @@ There are no absolute guarantees that replay will succeed, as system updates, me
772772
Implementations are expected to provide a best effort to ensure captured descriptors can be replayed, but are not expected to work around exceptional circumstances, or across driver versions or devices.
773773

774774
For the best chance of success, applications should replay in a separate process, using the same system, driver, and device, without any updates since the replay.
775-
Additionally, tools must capture some data from the implementation during capture to give the implementation the information to recreate identical descriptors during replay, should use an identically created xref:{refpage}VkDevice.html[VkDevice] and xref:{refpage}VkInstance.html[VkInstance], and should create all captured descriptors before creating any others for use in the tool.
775+
Additionally, tools must capture some data from the implementation during capture to give the implementation the information to recreate identical descriptors during replay, should use an identically created xref:{refpages}VkDevice.html[VkDevice] and xref:{refpages}VkInstance.html[VkInstance], and should create all captured descriptors before creating any others for use in the tool.
776776

777777

778778
==== Samplers

0 commit comments

Comments
 (0)