[PATCH] D51465: Revamp test-suite documentation

[Matthias Braun via Phabricator via llvm-commits]

MatzeB created this revision.
MatzeB added reviewers: cmatthews, jpaquette, thegameg, Meinersbur, rengolin, tra, homerdin, chandlerc, hfinkel, kristof.beyls.
Herald added subscribers: mgorny, mcrosier.

- Remove duplication: Both TestingGuide and TestSuiteMakefileGuide would give a similar overview over the test-suite.
- Present cmake/lit as the default/normal way of running the test-suite:
- Move information about the cmake/lit testsuite into the new TestSuiteGuide.rst file. Mark the remaining information in TestSuiteMakefilesGuide.rst as deprecated.
- General simplification and shorting of language.
- Remove paragraphs about tests known to fail as everything should pass nowadays.
- Remove paragraph about zlib requirement; it's not required anymore since we copied a zlib source snapshot into the test-suite.
- Remove paragraph about comparison with "native compiler". Correctness is always checked against reference outputs nowadays.
- Change cmake/lit quickstart section to recommend `pip` for installing lit and use `CMAKE_C_COMPILER` and a cache file in the example as that is what most people will end up doing anyway. Also a section about compare.py to quickstart.
- Document `Bitcode` and `MicroBenchmarks` directories.
- Add section about commonly used cmake configuration options.
- Add section about showing and comparing result files via compare.py.
- Add section about using external benchmark suites.
- Add section about using custom benchmark suites.
- Add section about profile guided optimization.
- Add section about cross-compilation and running on external devices.


Repository:
  rL LLVM

https://reviews.llvm.org/D51465

Files:
  docs/CMake.rst
  docs/SourceLevelDebugging.rst
  docs/TestSuiteGuide.rst
  docs/TestSuiteMakefileGuide.rst
  docs/TestingGuide.rst
  docs/index.rst

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D51465.163218.patch
Type: text/x-patch
Size: 27645 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20180829/35c22908/attachment.bin>