This is an archive of the discontinued LLVM Phabricator instance.

Differential D19366

[Docs] Add some requirements to the Testing Guide
ClosedPublic

Authored by rovka on Apr 21 2016, 8:23 AM.

Download Raw Diff

Details

Reviewers

rengolin
silvas

Summary

The Testing Guide only mentions as requirements Python and the software needed
to build LLVM. This patch adds zlib as a requirement for the test-suite (needed
by the ClamAV multisource application).

Diff Detail

Event Timeline

rovka updated this revision to Diff 54508.Apr 21 2016, 8:23 AM

rovka retitled this revision from to [Docs] Add some requirements to the Testing Guide.

rovka updated this object.

rovka added reviewers: rengolin, silvas.

rovka added a subscriber: llvm-commits.

Ping?

No brainer.

This revision is now accepted and ready to land.May 14 2016, 7:29 AM

Committed in r269566.

Revision Contents

Path

Size

docs/

TestingGuide.rst

6 lines

Diff 54508

docs/TestingGuide.rst

	Show All 19 Lines

	Requirements			Requirements
	============			============

	In order to use the LLVM testing infrastructure, you will need all of the			In order to use the LLVM testing infrastructure, you will need all of the
	software required to build LLVM, as well as `Python <http://python.org>`_ 2.7 or			software required to build LLVM, as well as `Python <http://python.org>`_ 2.7 or
	later.			later.

				If you intend to run the :ref:`test-suite <test-suite-overview>`, you will also
				need a development version of zlib (zlib1g-dev is known to work on several Linux
				distributions).

	LLVM testing infrastructure organization			LLVM testing infrastructure organization
	========================================			========================================

	The LLVM testing infrastructure contains two major categories of tests:			The LLVM testing infrastructure contains two major categories of tests:
	regression tests and whole programs. The regression tests are contained			regression tests and whole programs. The regression tests are contained
	inside the LLVM repository itself under ``llvm/test`` and are expected			inside the LLVM repository itself under ``llvm/test`` and are expected
	to always pass -- they should be run before every commit.			to always pass -- they should be run before every commit.

	▲ Show 20 Lines • Show All 494 Lines • ▼ Show 20 Lines
	the last RUN: line. This has two side effects:			the last RUN: line. This has two side effects:

	(a) it prevents special interpretation of lines that are part of the test			(a) it prevents special interpretation of lines that are part of the test
	program, not the instructions to the test case, and			program, not the instructions to the test case, and

	(b) it speeds things up for really big test cases by avoiding			(b) it speeds things up for really big test cases by avoiding
	interpretation of the remainder of the file.			interpretation of the remainder of the file.

				.. _test-suite-overview:

	``test-suite`` Overview			``test-suite`` Overview
	=======================			=======================

	The ``test-suite`` module contains a number of programs that can be			The ``test-suite`` module contains a number of programs that can be
	compiled and executed. The ``test-suite`` includes reference outputs for			compiled and executed. The ``test-suite`` includes reference outputs for
	all of the programs, so that the output of the executed program can be			all of the programs, so that the output of the executed program can be
	checked for correctness.			checked for correctness.

	▲ Show 20 Lines • Show All 51 Lines • Show Last 20 Lines