OpenE2K
/
glibc
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update install.texi documentation of uses of Perl and Python. 

The install.texi documentation of uses of Perl and Python is
substantially out of date.

The description of Perl is "to test the installation" (which I
interpret as referring to test-installation.pl), but it's used for
more tests than that, and to build the manual, and to regenerate one
file in the source tree.

The description of Python is only for pretty-printer tests, but it's
used for other tests / benchmarks as well (and for other internal uses
such as updating Unicode data, for which we already require Python 3,
but I think install.texi only needs to describe uses from the main
glibc Makefiles).

This patch updates the descriptions of what those tools are used for.
The Python information (and information about other tools for testing
pretty printers) was awkwardly in the middle of the general
description of building and testing glibc, rather than with the rest
of information about tools used in glibc build and test; this patch
moves the information about those tools into the main list.

Tested with regeneration of INSTALL as well as "make info" and "make
pdf".

	* manual/install.texi (Configuring and compiling): Do not list
	tools used for testing pretty printers here.
	(Tools for Compilation): List Python, PExpect and GDB here.
	Update descriptions of uses of Perl and Python.
	* INSTALL: Regenerate.
This commit is contained in:
Joseph Myers 2018-08-13 17:20:46 +00:00
parent f3cd0904a4
commit 3c1622eb77
3 changed files with 70 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ChangeLog
View File

@ -1,5 +1,11 @@
2018-08-13 Joseph Myers <joseph@codesourcery.com>
* manual/install.texi (Configuring and compiling): Do not list
tools used for testing pretty printers here.
(Tools for Compilation): List Python, PExpect and GDB here.
Update descriptions of uses of Perl and Python.
* INSTALL: Regenerate.
* scripts/build-many-glibcs.py (Context.checkout): Default Linux
version to 4.18.

68
INSTALL
View File

@ -296,38 +296,6 @@ You can specify 'stop-on-test-failure=y' when running 'make check' to
make the test run stop and exit with an error status immediately when a
failure occurs.
The GNU C Library pretty printers come with their own set of scripts
for testing, which run together with the rest of the testsuite through
'make check'. These scripts require the following tools to run
successfully:
* Python 2.7/3.4 or later
Python is required for running the printers' test scripts. As of
release time, Python 3.6 is the newest verified to work to test the
pretty printers.
* PExpect 4.0
The printer tests drive GDB through test programs and compare its
output to the printers'. PExpect is used to capture the output of
GDB, and should be compatible with the Python version in your
system. As of release time PExpect 4.3 is the newest verified to
work to test the pretty printers.
* GDB 7.8 or later with support for Python 2.7/3.4 or later
GDB itself needs to be configured with Python support in order to
use the pretty printers. Notice that your system having Python
available doesn't imply that GDB supports it, nor that your
system's Python and GDB's have the same version. As of release
time GNU 'debugger' 8.0.1 is the newest verified to work to test
the pretty printers.
If these tools are absent, the printer tests will report themselves as
'UNSUPPORTED'. Notice that some of the printer tests require the GNU C
Library to be compiled with debugging symbols.
To format the 'GNU C Library Reference Manual' for printing, type
'make dvi'. You need a working TeX installation to do this. The
distribution builds the on-line formatted version of the manual, as Info
@ -532,10 +500,11 @@ build the GNU C Library:
* Perl 5
Perl is not required, but it is used if present to test the
installation. We may decide to use it elsewhere in the future. As
of release time 'perl' version 5.28.0 is the newest verified to
work to build the GNU C Library.
Perl is not required, but if present it is used in some tests and
the 'mtrace' program, to build the GNU C Library manual, as well as
to regenerate 'locale/C-translit.h' if its source files are
modified. As of release time 'perl' version 5.28.0 is the newest
verified to work to build the GNU C Library.
* GNU 'sed' 3.02 or newer
@ -543,6 +512,33 @@ build the GNU C Library:
work with any version of 'sed'. As of release time, 'sed' version
4.5 is the newest verified to work to build the GNU C Library.
* Python 2.7/3.4 or later
Python is required to run some tests. As of release time, Python
3.6 is the newest verified to work for testing the GNU C Library.
* PExpect 4.0
The pretty printer tests drive GDB through test programs and
compare its output to the printers'. PExpect is used to capture
the output of GDB, and should be compatible with the Python version
in your system. As of release time PExpect 4.3 is the newest
verified to work to test the pretty printers.
* GDB 7.8 or later with support for Python 2.7/3.4 or later
GDB itself needs to be configured with Python support in order to
use the pretty printers. Notice that your system having Python
available doesn't imply that GDB supports it, nor that your
system's Python and GDB's have the same version. As of release
time GNU 'debugger' 8.0.1 is the newest verified to work to test
the pretty printers.
Unless Python, PExpect and GDB with Python support are present, the
printer tests will report themselves as 'UNSUPPORTED'. Notice that
some of the printer tests require the GNU C Library to be compiled
with debugging symbols.
If you change any of the 'configure.ac' files you will also need
* GNU 'autoconf' 2.69 (exactly)

69
manual/install.texi
View File

@ -330,39 +330,6 @@ occurred. You can specify @samp{stop-on-test-failure=y} when running
@code{make check} to make the test run stop and exit with an error
status immediately when a failure occurs.
The @glibcadj{} pretty printers come with their own set of scripts for testing,
which run together with the rest of the testsuite through @code{make check}.
These scripts require the following tools to run successfully:
@itemize @bullet
@item
Python 2.7/3.4 or later
Python is required for running the printers' test scripts. As of release time,
Python 3.6 is the newest verified to work to test the pretty printers.
@item PExpect 4.0
The printer tests drive GDB through test programs and compare its output
to the printers'. PExpect is used to capture the output of GDB, and should be
compatible with the Python version in your system. As of release time
PExpect 4.3 is the newest verified to work to test the pretty printers.
@item
GDB 7.8 or later with support for Python 2.7/3.4 or later
GDB itself needs to be configured with Python support in order to use the
pretty printers. Notice that your system having Python available doesn't imply
that GDB supports it, nor that your system's Python and GDB's have the same
version. As of release time GNU @code{debugger} 8.0.1 is the newest verified
to work to test the pretty printers.
@end itemize
@noindent
If these tools are absent, the printer tests will report themselves as
@code{UNSUPPORTED}. Notice that some of the printer tests require @theglibc{}
to be compiled with debugging symbols.
To format the @cite{GNU C Library Reference Manual} for printing, type
@w{@code{make dvi}}. You need a working @TeX{} installation to do
this. The distribution builds the on-line formatted version of the
@ -577,10 +544,11 @@ verified to work to build @theglibc{}.
@item
Perl 5
Perl is not required, but it is used if present to test the
installation. We may decide to use it elsewhere in the future. As of release
time @code{perl} version 5.28.0 is the newest verified to work to build
@theglibc{}.
Perl is not required, but if present it is used in some tests and the
@code{mtrace} program, to build the @glibcadj{} manual, as well as to
regenerate @file{locale/C-translit.h} if its source files are
modified. As of release time @code{perl} version 5.28.0 is the newest
verified to work to build @theglibc{}.
@item
GNU @code{sed} 3.02 or newer
@ -589,6 +557,33 @@ GNU @code{sed} 3.02 or newer
with any version of @code{sed}. As of release time, @code{sed} version
4.5 is the newest verified to work to build @theglibc{}.
@item
Python 2.7/3.4 or later
Python is required to run some tests. As of release time, Python 3.6
is the newest verified to work for testing @theglibc{}.
@item PExpect 4.0
The pretty printer tests drive GDB through test programs and compare
its output to the printers'. PExpect is used to capture the output of
GDB, and should be compatible with the Python version in your system.
As of release time PExpect 4.3 is the newest verified to work to test
the pretty printers.
@item
GDB 7.8 or later with support for Python 2.7/3.4 or later
GDB itself needs to be configured with Python support in order to use
the pretty printers. Notice that your system having Python available
doesn't imply that GDB supports it, nor that your system's Python and
GDB's have the same version. As of release time GNU @code{debugger}
8.0.1 is the newest verified to work to test the pretty printers.
Unless Python, PExpect and GDB with Python support are present, the
printer tests will report themselves as @code{UNSUPPORTED}. Notice
that some of the printer tests require @theglibc{} to be compiled with
debugging symbols.
@end itemize
@noindent