svn commit: r264572 - in stable/10: gnu/usr.bin/groff/tmac share/man/man7 tools/build/options

Wed Apr 16 23:12:37 UTC 2014

Author: jmmv
Date: Wed Apr 16 23:12:35 2014
New Revision: 264572
URL: http://svnweb.freebsd.org/changeset/base/264572

Log:
  MFC several WITH_TESTS-related documentation fixes.
  
  - r258014 Document WITH_TESTS src.conf(5) option.
  - r263089 Fix description of WITHOUT_BMAKE's purpose.
  - r264408 Fix test suite name in src.conf(5).
  - r264410 Document how to install the test suite.
  - r264412 Add FreeBSD 10.1 to the list of recognized releases for Fx.
  - r264413 Miscellaneous fixes to tests(7).

Added:
  stable/10/tools/build/options/WITH_TESTS
     - copied, changed from r258014, head/tools/build/options/WITH_TESTS
Modified:
  stable/10/gnu/usr.bin/groff/tmac/mdoc.local
  stable/10/share/man/man7/Makefile
  stable/10/share/man/man7/tests.7
  stable/10/tools/build/options/WITHOUT_BMAKE
Directory Properties:
  stable/10/   (props changed)

Modified: stable/10/gnu/usr.bin/groff/tmac/mdoc.local
==============================================================================

--- stable/10/gnu/usr.bin/groff/tmac/mdoc.local	Wed Apr 16 22:26:42 2014	(r264571)
+++ stable/10/gnu/usr.bin/groff/tmac/mdoc.local	Wed Apr 16 23:12:35 2014	(r264572)
@@ -58,6 +58,7 @@
 .ds doc-operating-system-FreeBSD-9.1    9.1
 .ds doc-operating-system-FreeBSD-9.2    9.2
 .ds doc-operating-system-FreeBSD-10.0   10.0
+.ds doc-operating-system-FreeBSD-10.1   10.1
 .ds doc-operating-system-NetBSD-7.0     7.0
 .
 .\" Definitions not (yet) in doc-syms

Modified: stable/10/share/man/man7/Makefile
==============================================================================
--- stable/10/share/man/man7/Makefile	Wed Apr 16 22:26:42 2014	(r264571)
+++ stable/10/share/man/man7/Makefile	Wed Apr 16 23:12:35 2014	(r264572)
@@ -27,12 +27,9 @@ MAN=	adding_user.7 \
 	sprog.7 \
 	stdint.7 \
 	sticky.7 \
+	tests.7 \
 	tuning.7
 
-.if ${MK_TESTS} != "no"
-MAN+=	tests.7
-.endif
-
 MLINKS=	intro.7 miscellaneous.7
 MLINKS+= security.7 securelevel.7
 MLINKS+= c99.7 c.7

Modified: stable/10/share/man/man7/tests.7
==============================================================================
--- stable/10/share/man/man7/tests.7	Wed Apr 16 22:26:42 2014	(r264571)
+++ stable/10/share/man/man7/tests.7	Wed Apr 16 23:12:35 2014	(r264572)
@@ -26,16 +26,16 @@
 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 .\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd March 20, 2014
+.Dd April 13, 2014
 .Dt TESTS 7
 .Os
 .Sh NAME
 .Nm tests
-.Nd introduction to the FreeBSD test suite
+.Nd introduction to the FreeBSD Test Suite
 .Sh DESCRIPTION
 The
 .Fx
-test suite provides a collection of automated tests for two major purposes.
+Test Suite provides a collection of automated tests for two major purposes.
 On one hand, the test suite aids
 .Em developers
 to detect bugs and regressions when they modify the source tree.  On the other
@@ -50,12 +50,31 @@ maintenance.
 .Pp
 The
 .Fx
-test suite is installed in the
+Test Suite can be found in the
 .Pa /usr/tests
 hierarchy.
 .Pp
 This manual page describes how to run the test suite and how to configure
 some of its optional features.
+.Ss Installing the test suite
+The test suite is not yet installed by default as part of
+.Fx ,
+but this is bound to change during the development of
+.Fx 11.0 .
+.Pp
+If the
+.Pa /usr/tests
+directory is missing, then you will have to enable the build of the test
+suite, rebuild your system and install the results.
+You can do so by setting
+.Sq WITH_TESTS=yes
+in your
+.Pa /etc/src.conf
+file (see
+.Xr src.conf 5
+for details)
+and rebuilding the system as described in
+.Xr build 7 .
 .Ss When to run the tests?
 Before diving into the details of how to run the test suite, here are some
 scenarios in which you should run it:
@@ -129,7 +148,7 @@ to its manual page
 .Ss Configuring the tests
 Some test cases in the
 .Fx
-test suite require manual configuration by the administrator before they can be
+Test Suite require manual configuration by the administrator before they can be
 run.  Unless certain properties are defined, the tests that require them will
 be skipped.
 .Pp
@@ -141,7 +160,7 @@ The format of this file is detailed in
 .Pp
 The following configuration variables are available in the
 .Fx
-test suite:
+Test Suite:
 .Bl -tag -width "allow_sysctl_side_effects"
 .It allow_devfs_side_effects
 If defined, enables tests that may destroy and recreate semipermanent device
@@ -192,21 +211,24 @@ Default result database used by Kyua.
 .It Pa /usr/tests/
 Location of the
 .Fx
-test suite.
+Test Suite.
 .It Pa /usr/tests/Kyuafile
 Top-level test suite definition file.
 .El
 .Sh SEE ALSO
-.Xr kyua 1 .
+.Xr kyua 1 ,
+.Xr build 7
 .Sh HISTORY
-This test suite first appeared in
-.Fx 11.0 .
+The
+.Fx
+Test Suite first appeared in
+.Fx 10.1 .
 .Pp
 The
 .Nm
 manual page first appeared in
 .Nx 6.0
 and was later ported to
-.Fx 11.0 .
+.Fx 10.1 .
 .Sh AUTHORS
-.An Julio Merino Aq Mt jmmv at google.com
+.An Julio Merino Aq Mt jmmv at FreeBSD.org

Modified: stable/10/tools/build/options/WITHOUT_BMAKE
==============================================================================
--- stable/10/tools/build/options/WITHOUT_BMAKE	Wed Apr 16 22:26:42 2014	(r264571)
+++ stable/10/tools/build/options/WITHOUT_BMAKE	Wed Apr 16 23:12:35 2014	(r264572)
@@ -3,6 +3,6 @@ Set to not build and install the portabl
 .Xr make 1
 instead of the traditional FreeBSD make.
 This build option is temporary.
-It allows developers to switch to bmake in order to work out any remaining
-kinks or issues.
+It allows developers to switch to the traditional FreeBSD make in order to
+work out any remaining kinks or issues.
 This option will be removed in due time.

Copied and modified: stable/10/tools/build/options/WITH_TESTS (from r258014, head/tools/build/options/WITH_TESTS)
==============================================================================
--- head/tools/build/options/WITH_TESTS	Mon Nov 11 21:13:14 2013	(r258014, copy source)
+++ stable/10/tools/build/options/WITH_TESTS	Wed Apr 16 23:12:35 2014	(r264572)
@@ -1,2 +1,7 @@
 .\" $FreeBSD$
-Set to install the Kyua test suite.
+Set to install the
+.Fx
+Test Suite.
+See
+.Xr tests 7
+for more details.
