[3/7] libstdc++: Document timeout and timeout-factor of simd tests

Message ID 8239109.NyiUUSuA9g@minbar
State Accepted
Headers
Series Work on PR108030 and several simd bugfixes and testsuite improvements |

Checks

Context Check Description
snail/gcc-patch-check success Github commit url

Commit Message

Matthias Kretz Feb. 15, 2023, 8:49 p.m. UTC
  Signed-off-by: Matthias Kretz <m.kretz@gsi.de>

libstdc++-v3/ChangeLog:

	* testsuite/experimental/simd/README.md: Document the timeout
	and timeout-factor directives. Minor typo fixed.
---
 libstdc++-v3/testsuite/experimental/simd/README.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)


--
──────────────────────────────────────────────────────────────────────────
 Dr. Matthias Kretz                           https://mattkretz.github.io
 GSI Helmholtz Centre for Heavy Ion Research               https://gsi.de
 stdₓ::simd
──────────────────────────────────────────────────────────────────────────
  

Comments

Jonathan Wakely Feb. 15, 2023, 11:17 p.m. UTC | #1
On Wed, 15 Feb 2023 at 20:50, Matthias Kretz via Libstdc++
<libstdc++@gcc.gnu.org> wrote:
>
>
>
> Signed-off-by: Matthias Kretz <m.kretz@gsi.de>
>
> libstdc++-v3/ChangeLog:
>
>         * testsuite/experimental/simd/README.md: Document the timeout
>         and timeout-factor directives. Minor typo fixed.


OK for all relevant branches (trunk/12/11).
  

Patch

diff --git a/libstdc++-v3/testsuite/experimental/simd/README.md b/libstdc++-v3/testsuite/experimental/simd/README.md
index b82453df403..ef8b7c33de7 100644
--- a/libstdc++-v3/testsuite/experimental/simd/README.md
+++ b/libstdc++-v3/testsuite/experimental/simd/README.md
@@ -139,7 +139,13 @@  allowed_distance)` macros.
   test then shows as "XFAIL: ...". If the test passes, the test shows "XPASS: 
   ...".
 
-All patterns are matched via
+* `timeout: <number>`
+  Set the timeout of this test to `<number>` seconds.
+
+* `timeout-factor: <number>`
+  Multiply the default timeout with `<number>`.
+
+All patterns except `timeout` and `timeout-factor` are matched via
 ```sh
 case '<test context>' in
   <pattern>)
@@ -147,7 +153,7 @@  case '<test context>' in
   ;;
 esac
 ```
-The `<CXXFLAGS pattern>` is implicitly adds a `*` wildcard before and after the 
+The `<CXXFLAGS pattern>` implicitly adds a `*` wildcard before and after the 
 pattern. Thus, the `CXXFLAGS` pattern matches a substring and all other 
 patterns require a full match.