[PATCH] D112936: [Docs] Document update_llc_test_checks.py in TestingGuide.rst

[Shivam Gupta via Phabricator via llvm-commits]

xgupta updated this revision to Diff 384054.
xgupta added a comment.

mention similar update script


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D112936/new/

https://reviews.llvm.org/D112936

Files:
  llvm/docs/TestingGuide.rst


Index: llvm/docs/TestingGuide.rst
===================================================================
--- llvm/docs/TestingGuide.rst
+++ llvm/docs/TestingGuide.rst
@@ -275,6 +275,40 @@
 test. Check if there are files already covering your feature and consider
 adding your code there instead of creating a new file.
 
+Generating assertions in regression tests
+-----------------------------------------
+
+Some regression test cases are very large and complex to write/update by hand.
+In that case to reduce the human work we can use the scripts available in
+llvm/utils/ to generate the assertions.
+
+For example to update assertions in all the RISCV CodeGen's 'llc' based tests,
+run:
+
+ .. code-block:: bash
+
+     % llvm/utils/update_llc_test_checks.py --llc-binary build/bin/llc -u `find llvm/test/CodeGen/RISCV/ \( -name '*.ll' -o -name '*.mir' \)`
+
+Most common scripts and their purposes or applications in generating assertions:
+
+update_analyze_test_checks.py
+opt --analyze --costmodel
+
+update_cc_test_checks.py
+clang c/c++
+
+update_llc_test_checks.py
+llc
+
+update_mca_test_checks.py
+llvm-mca
+
+update_mir_test_checks.py
+llc mir checks
+
+update_test_checks.py
+opt
+
 Extra files
 -----------
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D112936.384054.patch
Type: text/x-patch
Size: 1223 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20211102/d5698e79/attachment.bin>