[PATCH] D112936: [Docs] Document scripts that are use to generate assertion in test cases

[Jessica Clarke via Phabricator via llvm-commits]

jrtc27 added inline comments.


================
Comment at: llvm/docs/TestingGuide.rst:285
+
+For example to update assertions in all the RISCV CodeGen's 'llc' based tests,
+run:
----------------



================
Comment at: llvm/docs/TestingGuide.rst:290
+
+     % llvm/utils/update_llc_test_checks.py --llc-binary build/bin/llc -u `find llvm/test/CodeGen/RISCV/ \( -name '*.ll' -o -name '*.mir' \)`
+
----------------
jrtc27 wrote:
> MaskRay wrote:
> > Probably only run on existing tests which have the notice line.
> > 
> > Change `build` to something else to indicate it is a placeholder. Many people don't use `build` as the build directory.
> > Probably only run on existing tests which have the notice line.
> 
> That's what the -u is for, will check the NOTE: line exists and matches the script name
Which means, if you're documenting things here, you should probably note what -u does, otherwise people writing new test files who come to run update_llc_test_checks.py -u might get rather confused as to why it's doing nothing...


================
Comment at: llvm/docs/TestingGuide.rst:298
+update_cc_test_checks.py
+clang c/c++
+
----------------
C/C++, or clang/clang++


================
Comment at: llvm/docs/TestingGuide.rst:301
+update_llc_test_checks.py
+llc
+
----------------
perhaps to distinguish from MIR, I know people (myself included) can get confused about the difference between update_llc and update_mir, but it's about the output being generated, not the input


================
Comment at: llvm/docs/TestingGuide.rst:307
+update_mir_test_checks.py
+llc mir checks
+
----------------



Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D112936