summaryrefslogtreecommitdiffstats
path: root/llvm/docs/TestingGuide.rst
Commit message (Collapse)AuthorAgeFilesLines
* [FileCheck] Make FILECHECK_OPTS useful for its test suiteJoel E. Denny2019-11-211-0/+7
| | | | | | | | | | | | | | | | | | | | Without this patch, `FILECHECK_OPTS` isn't propagated to FileCheck's test suite so that `FILECHECK_OPTS` doesn't inadvertently affect test results by affecting the output of FileCheck calls under test. As a result, `FILECHECK_OPTS` is useless for debugging FileCheck's test suite. In `llvm/test/FileCheck/lit.local.cfg`, this patch provides a new subsitution, `%ProtectFileCheckOutput`, to address this problem for both `FILECHECK_OPTS` and the deprecated `FILECHECK_DUMP_INPUT_ON_FAILURE`. The rest of the patch uses `%ProtectFileCheckOutput` throughout the test suite Fixes PR40284. Reviewed By: probinson, thopre Differential Revision: https://reviews.llvm.org/D65121
* [Docs] Test commitDeForest Richards2019-08-181-1/+1
| | | | | | Fixes typo - Removes extra space between last word of sentence and period. llvm-svn: 369216
* [Docs] Modernize references to macOSJ. Ryan Stinnett2019-05-301-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | Summary: This updates all places in documentation that refer to "Mac OS X", "OS X", etc. to instead use the modern name "macOS" when no specific version number is mentioned. If a specific version is mentioned, this attempts to use the OS name at the time of that version: * Mac OS X for 10.0 - 10.7 * OS X for 10.8 - 10.11 * macOS for 10.12 - present Reviewers: JDevlieghere Subscribers: mgorny, christof, arphaman, cfe-commits, lldb-commits, libcxx-commits, llvm-commits Tags: #clang, #lldb, #libc, #llvm Differential Revision: https://reviews.llvm.org/D62654 llvm-svn: 362113
* [docs] Recommend assertions when testing.Davide Italiano2019-02-031-1/+1
| | | | | | Pointed out by Shoaib Meenai. llvm-svn: 353008
* Adjust documentation for git migration.James Y Knight2019-01-291-9/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This fixes most references to the paths: llvm.org/svn/ llvm.org/git/ llvm.org/viewvc/ github.com/llvm-mirror/ github.com/llvm-project/ reviews.llvm.org/diffusion/ to instead point to https://github.com/llvm/llvm-project. This is *not* a trivial substitution, because additionally, all the checkout instructions had to be migrated to instruct users on how to use the monorepo layout, setting LLVM_ENABLE_PROJECTS instead of checking out various projects into various subdirectories. I've attempted to not change any scripts here, only documentation. The scripts will have to be addressed separately. Additionally, I've deleted one document which appeared to be outdated and unneeded: lldb/docs/building-with-debug-llvm.txt Differential Revision: https://reviews.llvm.org/D57330 llvm-svn: 352514
* [Docs] Add information about unit tests to the testing guideMichael Platings2019-01-241-10/+25
| | | | | | Differential Revision: https://reviews.llvm.org/D57088 llvm-svn: 352052
* [Docs] Add a note clarifying how to get good test performances.Davide Italiano2019-01-221-0/+7
| | | | | | Differential Revision: https://reviews.llvm.org/D56337 llvm-svn: 351885
* Revamp test-suite documentationMatthias Braun2018-08-311-70/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - 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
* [llvm] Document "%T" as deprecated in TestingGuide.rstKuba Mracek2018-06-191-1/+4
| | | | | | Differential Revision: https://reviews.llvm.org/D48189 llvm-svn: 335080
* Revert "lit.py: Add new %{shared_output(LABEL)} substitution"Jordan Rose2017-10-141-6/+0
| | | | | | | This reverts r315697 and my ill-fated attempts to fix it on Windows. I'll try again when I get access to a Windows machine. llvm-svn: 315793
* lit.py: Add new %{shared_output(LABEL)} substitutionJordan Rose2017-10-131-0/+6
| | | | | | | | | | | | This refers to a temporary path that can be shared across all tests, identified by a particular label. This can be used for things like caches. At the moment, the character set for the LABEL is limited to C identifier characters, plus '-', '+', '=', and '.'. This is the same set of characters currently allowed in REQUIRES clause identifiers. llvm-svn: 315697
* [docs] cleanup documentation on lit substitutionsDavid Bozier2017-02-091-0/+19
| | | | | | | | | | | 1. Added missing substitutions to the documentation in docs/TestingGuide.rst 2. Modified docs/CommandGuide/lit.rst to only document the "base" set of substitutions and to refer the reader to docs/TestingGuide.rst for more detailed info on substitutions. Patch by bd1976llvm Differential Revision: https://reviews.llvm.org/D29281 llvm-svn: 294586
* Reinstate "r292904 - [lit] Allow boolean expressions in REQUIRES and XFAILGreg Parker2017-01-251-28/+36
| | | | | | | | and UNSUPPORTED" This reverts the revert in r292942. llvm-svn: 293007
* Revert "r292904 - [lit] Allow boolean expressions in REQUIRES and XFAILAlex Lorenz2017-01-241-36/+28
| | | | | | | | | | | and UNSUPPORTED" After r292904 llvm-lit fails to emit the test results in the XML format for Apple's internal buildbots. rdar://30164800 llvm-svn: 292942
* [lit] Allow boolean expressions in REQUIRES and XFAIL and UNSUPPORTEDGreg Parker2017-01-241-28/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | A `lit` condition line is now a comma-separated list of boolean expressions. Comma-separated expressions act as if each expression were on its own condition line: For REQUIRES, if every expression is true then the test will run. For UNSUPPORTED, if every expression is false then the test will run. For XFAIL, if every expression is false then the test is expected to succeed. As a special case "XFAIL: *" expects the test to fail. Examples: # Test is expected fail on 64-bit Apple simulators and pass everywhere else XFAIL: x86_64 && apple && !macosx # Test is unsupported on Windows and on non-Ubuntu Linux # and supported everywhere else UNSUPPORTED: linux && !ubuntu, system-windows Syntax: * '&&', '||', '!', '(', ')'. 'true' is true. 'false' is false. * Each test feature is a true identifier. * Substrings of the target triple are true identifiers for UNSUPPORTED and XFAIL, but not for REQUIRES. (This matches the current behavior.) * All other identifiers are false. * Identifiers are [-+=._a-zA-Z0-9]+ Differential Revision: https://reviews.llvm.org/D18185 llvm-svn: 292904
* Revert "[lit] Allow boolean expressions in REQUIRES and XFAIL and UNSUPPORTED"Greg Parker2017-01-241-36/+28
| | | | | | This change needs to be better-coordinated with libc++. llvm-svn: 292900
* [lit] Allow boolean expressions in REQUIRES and XFAIL and UNSUPPORTEDGreg Parker2017-01-241-28/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | A `lit` condition line is now a comma-separated list of boolean expressions. Comma-separated expressions act as if each expression were on its own condition line: For REQUIRES, if every expression is true then the test will run. For UNSUPPORTED, if every expression is false then the test will run. For XFAIL, if every expression is false then the test is expected to succeed. As a special case "XFAIL: *" expects the test to fail. Examples: # Test is expected fail on 64-bit Apple simulators and pass everywhere else XFAIL: x86_64 && apple && !macosx # Test is unsupported on Windows and on non-Ubuntu Linux # and supported everywhere else UNSUPPORTED: linux && !ubuntu, system-windows Syntax: * '&&', '||', '!', '(', ')'. 'true' is true. 'false' is false. * Each test feature is a true identifier. * Substrings of the target triple are true identifiers for UNSUPPORTED and XFAIL, but not for REQUIRES. (This matches the current behavior.) * All other identifiers are false. * Identifiers are [-+=._a-zA-Z0-9]+ Differential Revision: https://reviews.llvm.org/D18185 llvm-svn: 292896
* fix some typos in the docSylvestre Ledru2017-01-141-1/+1
| | | | llvm-svn: 292014
* Review fixes to lit documentationPiotr Padlewski2016-07-121-32/+2
| | | | | | | | | | Reviewers: mehdi_amini Subscribers: llvm-commits Differential Revision: http://reviews.llvm.org/D22245 llvm-svn: 275214
* Added REQUIRES to TestingGuide documentationPiotr Padlewski2016-07-081-0/+47
| | | | | | | | | | Reviewers: alexfh, wolfgangp, rengolin Subscribers: llvm-commits Differential Revision: http://reviews.llvm.org/D22172 llvm-svn: 274949
* [Docs] Add some requirements to the Testing GuideRenato Golin2016-05-141-0/+6
| | | | | | Patch by Diana Picus. llvm-svn: 269566
* Fixing the documentation buildsChris Bieneman2016-01-261-10/+2
| | | | | | I broke the documentation builds when I deleted the MakefileGuide as part of the autoconf removal. At some point I'll need to do a more in-depth pass updating the documentation to remove references to the old build system. llvm-svn: 258873
* [Documentation] Add guidelines for grouping tests together.Davide Italiano2015-11-171-0/+4
| | | | | | | | This was considered a good practice but it was not documented. Now it is. Differential Revision: http://reviews.llvm.org/D14733 llvm-svn: 253281
* Document some of the options in test/lit.cfgMatthias Braun2015-05-041-0/+19
| | | | llvm-svn: 236462
* Require python 2.7.Rafael Espindola2014-12-121-1/+1
| | | | | | | | | | | | | We were already requiring 2.5, which meant that people on old linux distros had to upgrade anyway. Requiring python 2.6 will make supporting 3.X easier as we can use the 3.X exception syntax. According to the discussion on llvmdev, there is not much value is requiring just 2.6, we may as well just require 2.7. llvm-svn: 224129
* [docs] Document usage of Inputs/ for extra test files.Sean Silva2014-11-051-0/+52
| | | | llvm-svn: 221406
* Reduce verbiage of lit.local.cfg filesAlp Toker2014-06-091-2/+1
| | | | | | We can just split targets_to_build in one place and make it immutable. llvm-svn: 210496
* Cleanup docs about lit substitutionsNico Rieck2014-02-151-48/+69
| | | | llvm-svn: 201464
* Remove mention of old deleted test scripts from testing guideNico Rieck2014-01-081-13/+5
| | | | llvm-svn: 198771
* Update the Python version. And Perl isn't used anymore.Bill Wendling2013-10-271-3/+3
| | | | | | PR17608 llvm-svn: 193491
* [docs] Update TestingGuide's note on how to run with Valgrind.Daniel Dunbar2013-08-091-3/+5
| | | | llvm-svn: 188097
* Add platform specific tests docRenato Golin2013-07-031-0/+60
| | | | llvm-svn: 185581
* fix small doc typoEli Bendersky2013-03-221-1/+1
| | | | llvm-svn: 177737
* [docs] Remove incorrect information about lit.Sean Silva2013-03-191-10/+1
| | | | | | Lit does support redirects in the 2>&1 style. llvm-svn: 177403
* Streamline the mentions of grep and FileCheck in TestingGuide.rstEli Bendersky2013-01-181-37/+7
| | | | | | | | grep is now only mentioned once in a sentence that explicitly says it's deprecated. For FileCheck, there's no reason to repeat part of the documentation that exists in CommandGuide/FileCheck. llvm-svn: 172835
* remove the rest of the "written by" lines in the documentation. It isChris Lattner2013-01-101-3/+0
| | | | | | | against the developer policy to include this sort of thing as SVN blame already captures this in a far more fine-grained way. llvm-svn: 172109
* Documentation: add a section to prevent spurious test failures like the oneDmitri Gribenko2012-12-301-0/+37
| | | | | | fixed in r171243. llvm-svn: 171258
* Get rid of references to Tcl, DejagGNU, old test structure, discourage the useEli Bendersky2012-12-041-106/+57
| | | | | | of grep in favor of FileCheck, and other cleanups. llvm-svn: 169269
* Remove the very out-of-date listing of "very important LLVM areas". I don'tEli Bendersky2012-12-041-12/+1
| | | | | | think it adds much and keeping it up-to-date is (obviously) a chore. llvm-svn: 169263
* Clean up, bring up-to-date and apply consistent formatting.Eli Bendersky2012-12-031-30/+21
| | | | | | This document is a long-time pet peeve :-) More fixes to come. llvm-svn: 169115
* Documentation: remove a copy of the FileCheck man page from TestingGuideDmitri Gribenko2012-11-181-194/+4
| | | | llvm-svn: 168288
* Documentation: use a :doc: link instead of an absolute http:// link.Dmitri Gribenko2012-11-181-2/+2
| | | | llvm-svn: 168286
* docs: Improve typographical correctness.Sean Silva2012-11-141-2/+2
| | | | llvm-svn: 167998
* docs: Sphinxify TestSuiteMakefileGuideSean Silva2012-11-141-5/+11
| | | | | | Some small related fixups to TestingGuide too. llvm-svn: 167996
* docs: Sphinxify TestingGuideSean Silva2012-11-141-0/+713
llvm-svn: 167979
OpenPOWER on IntegriCloud