diff options
author | Matthias Braun <matze@braunis.de> | 2018-08-31 21:47:01 +0000 |
---|---|---|
committer | Matthias Braun <matze@braunis.de> | 2018-08-31 21:47:01 +0000 |
commit | 4f340e975e4d612203968244c191ba10a816b263 (patch) | |
tree | 4dd1bff5924a27ae95e4edeeb387c9092b9b4e31 /llvm/docs/SourceLevelDebugging.rst | |
parent | caf66727797061f212e91741b6ff21f0927cffbe (diff) | |
download | bcm5719-llvm-4f340e975e4d612203968244c191ba10a816b263.tar.gz bcm5719-llvm-4f340e975e4d612203968244c191ba10a816b263.zip |
Revamp test-suite documentation
- 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 with 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.
Differential Revision: https://reviews.llvm.org/D51465
llvm-svn: 341260
Diffstat (limited to 'llvm/docs/SourceLevelDebugging.rst')
-rw-r--r-- | llvm/docs/SourceLevelDebugging.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/llvm/docs/SourceLevelDebugging.rst b/llvm/docs/SourceLevelDebugging.rst index d9d948baf10..24e70f82d52 100644 --- a/llvm/docs/SourceLevelDebugging.rst +++ b/llvm/docs/SourceLevelDebugging.rst @@ -115,8 +115,9 @@ elimination and inlining), but you might lose the ability to modify the program and call functions which were optimized out of the program, or inlined away completely. -The :ref:`LLVM test suite <test-suite-quickstart>` provides a framework to test -optimizer's handling of debugging information. It can be run like this: +The :doc:`LLVM test-suite <TestSuiteMakefileGuide>` provides a framework to +test the optimizer's handling of debugging information. It can be run like +this: .. code-block:: bash |