[binutils-gdb] gas: scfi: testsuite: refresh the README

[Indu Bhagat]

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=dfeb912e160b3eae596a4fd92cc14d0f5e90ee68

commit dfeb912e160b3eae596a4fd92cc14d0f5e90ee68
Author: Indu Bhagat <indu.bhagat@oracle.com>
Date:   Tue Jul 16 23:34:43 2024 -0700

    gas: scfi: testsuite: refresh the README
    
    Update some stale text in the README.  Add few more notes to guide
    future maintenance of the testsuite.
    
    gas/testsuite/
            * gas/scfi/README: Update text.

Diff:
---
 gas/testsuite/gas/scfi/README | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

diff --git a/gas/testsuite/gas/scfi/README b/gas/testsuite/gas/scfi/README
index 91191634769..ddb8a3d1320 100644
--- a/gas/testsuite/gas/scfi/README
+++ b/gas/testsuite/gas/scfi/README
@@ -2,15 +2,18 @@ Notes on the SCFI testsuite in GAS:
 
 * At this time, SCFI machinery is only supported for x86_64.
 
-* When adding more tests, please keep CFI annotations updated in the .s files.
-  Ideally the test should be run with and without --scfi (as is done currently
-  for the core SCFI tests); Such workflow ensures sanity checking of the CFI
-  annotations. 
+* When adding more core SCFI tests (scfi-* tests), please keep CFI
+  annotations updated in the .s files.  Ideally the test should be run with and
+  without --scfi (as is done currently for the core SCFI tests); Such workflow
+  ensures sanity checking of the CFI annotations.
 
 * Note that GAS issues a warning:
-    "Warning: --scfi=all ignores some user-specified CFI directive"
-  when it encounters CFI directives in the input assembly and --scfi (=all) is
-  active.  To bypass the noise from this warning, while keeping the testcases
-  useful/understandable, most tests are run twice. E.g.,
+    "Warning: SCFI ignores most user-specified CFI directives"
+  when it encounters CFI directives in the input assembly and SCFI is enabled.
+  To bypass the noise from this warning, while keeping the testcases
+  useful/understandable, most of the SCFI core tests are run twice. E.g.,
      - run_dump_test "scfi-cfi-add-1" // ignores warnings
-     - run_list_test "scfi-cfi-add-1" "--scfi --warn" // tests warnings
+     - run_list_test "scfi-cfi-add-1" "--scfi=experimental --warn" // tests warnings
+
+* Tests named ginsn-* generally aim to ensure graceful ginsn creation process for
+  various instructions.