review: use //! for directive comments

test/README.md

@@ -40,10 +40,10 @@ output.log  # the captured printed output--only for errors
 To add a test, create a new C file in [`src/misc`]:
 
 ```c
-// filter.py(TARGET_TRIPLE): !wasm32-wasip2
-// add-flags.py(CFLAGS): ...
-// add-flags.py(LDFLAGS): ...
-// add-flags.py(RUN): ...
+//! filter.py(TARGET_TRIPLE): !wasm32-wasip2
+//! add-flags.py(CFLAGS): ...
+//! add-flags.py(LDFLAGS): ...
+//! add-flags.py(RUN): ...
 void main() { ... }
 ```
 

test/scripts/add-flags.py

@@ -9,7 +9,7 @@
 # Example:
 # ```
 # $ head one.c
-# // add-flags.py(CFLAGS): -DFOO
+# //! add-flags.py(CFLAGS): -DFOO
 # $ ./add-flags.py CFLAGS one.c
 # -DFOO
 
@@ -19,17 +19,17 @@
 import logging
 
 """
-Match a C comment like the following: `// add-flags.py: <FLAGS>`.
+Match a C comment like the following: `//! add-flags.py: <FLAGS>`.
 """
-PATTERN = re.compile('\\s*//\\s*add-flags\\.py\\(([^)]+)\\):\\s*(.*)')
+PATTERN = re.compile('\\s*//\\!\\s*add-flags\\.py\\(([^)]+)\\):\\s*(.*)')
 
 
 def find_flags(name, file):
     with open(file, 'r') as f:
         for lineno, line in enumerate(f, start=1):
             match = PATTERN.match(line)
-            pos = f'[{file}:{lineno}]'
             if match and match[1] == name:
+                pos = f'[{file}:{lineno}]'
                 logging.debug(f'{pos} found flags')
                 return match[2].strip()
 

test/scripts/filter.py

@@ -3,7 +3,7 @@
 # Filter out test files that do not match a configuration variable.
 #
 # This script accepts a list of files as arguments and looks for a comment like
-# the following in each: `// filter.py(<VARIABLE>): <EXPRESSION>`. The
+# the following in each: `//! filter.py(<VARIABLE>): <EXPRESSION>`. The
 # `VARIABLE` value is looked up in the environment and compared with the
 # expression. An `EXPRESSION` is a comma-separated list of terms: either
 # `<string>` or `!<string>`. If the `VARIABLE` value matches the expression, the
@@ -12,9 +12,9 @@
 # Example:
 # ```
 # $ head one.c
-# // filter.py(FOO): bar
+# //! filter.py(FOO): bar
 # $ head two.c
-# // filter.py(FOO):!bar, baz
+# //! filter.py(FOO):!bar, baz
 # $ FOO=bar ./filter.py one.c two.c
 # one.c
 # $ FOO=baz ./filter.py one.c two.c
@@ -55,9 +55,9 @@ def matches_expression(value, expr, pos):
 
 
 """
-Match a C comment like the following: `// filter.py(<VARIABLE>): <EXPRESSION>`.
+Match a C comment like the following: `//! filter.py(<VARIABLE>): <EXPRESSION>`.
 """
-PATTERN = re.compile('\\s*//\\s*filter\\.py\\(([^)]+)\\):\\s*(.*)')
+PATTERN = re.compile('\\s*//\\!\\s*filter\\.py\\(([^)]+)\\):\\s*(.*)')
 
 
 def line_matches(line, env, pos):

test/src/libc-test/functional/argv.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/argv.c"

test/src/libc-test/functional/basename.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/basename.c"

test/src/libc-test/functional/clocale_mbfuncs.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/clocale_mbfuncs.c"

test/src/libc-test/functional/clock_gettime.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/clock_gettime.c"

test/src/libc-test/functional/crypt.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/crypt.c"

test/src/libc-test/functional/dirname.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/dirname.c"

test/src/libc-test/functional/env.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/env.c"

test/src/libc-test/functional/fnmatch.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/fnmatch.c"

test/src/libc-test/functional/iconv_open.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/iconv_open.c"

test/src/libc-test/functional/mbc.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/mbc.c"

test/src/libc-test/functional/memstream.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/memstream.c"

test/src/libc-test/functional/qsort.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/qsort.c"

test/src/libc-test/functional/random.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/random.c"

test/src/libc-test/functional/search_hsearch.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/search_hsearch.c"

test/src/libc-test/functional/search_insque.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/search_insque.c"

test/src/libc-test/functional/search_lsearch.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/search_lsearch.c"

test/src/libc-test/functional/search_tsearch.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/search_tsearch.c"

test/src/libc-test/functional/snprintf.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/snprintf.c"

test/src/libc-test/functional/sscanf.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/sscanf.c"

test/src/libc-test/functional/strftime.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/strftime.c"

test/src/libc-test/functional/string.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/string.c"

test/src/libc-test/functional/string_memcpy.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/string_memcpy.c"

test/src/libc-test/functional/string_memmem.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/string_memmem.c"

test/src/libc-test/functional/string_memset.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/string_memset.c"

test/src/libc-test/functional/string_strchr.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/string_strchr.c"

test/src/libc-test/functional/string_strcspn.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/string_strcspn.c"

test/src/libc-test/functional/string_strstr.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/string_strstr.c"

test/src/libc-test/functional/strtod.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/strtod.c"

test/src/libc-test/functional/strtod_long.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/strtod_long.c"

test/src/libc-test/functional/strtod_simple.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/strtod_simple.c"

test/src/libc-test/functional/strtof.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/strtof.c"

test/src/libc-test/functional/strtol.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/strtol.c"

test/src/libc-test/functional/strtold.c

@@ -1,3 +1,3 @@
-// add-flags.py(CFLAGS): -I.
-// add-flags.py(LDFLAGS): -lc-printscan-long-double
+//! add-flags.py(CFLAGS): -I.
+//! add-flags.py(LDFLAGS): -lc-printscan-long-double
 #include "build/download/libc-test/src/functional/strtold.c"

test/src/libc-test/functional/swprintf.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/swprintf.c"

test/src/libc-test/functional/tgmath.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/tgmath.c"

test/src/libc-test/functional/udiv.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/udiv.c"

test/src/libc-test/functional/wcsstr.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/wcsstr.c"

test/src/libc-test/functional/wcstol.c

@@ -1,2 +1,2 @@
-// add-flags.py(CFLAGS): -I.
+//! add-flags.py(CFLAGS): -I.
 #include "build/download/libc-test/src/functional/wcstol.c"

test/src/misc/fts.c

@@ -1,4 +1,4 @@
-// add-flags.py(RUN): --dir fs::/
+//! add-flags.py(RUN): --dir fs::/
 
 /*
  * We modified musl-fts not to use fchdir() and we made FTS_NOCHDIR