summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README138
1 files changed, 85 insertions, 53 deletions
diff --git a/README b/README
index 236b2d5..efa1d2e 100644
--- a/README
+++ b/README
@@ -7,18 +7,21 @@ arbitrary limits.
The programs that can be built with this package are:
- [ base64 basename cat chgrp chmod chown chroot cksum comm cp csplit cut date
- dd df dir dircolors dirname du echo env expand expr factor false fmt fold
- ginstall groups head hostid hostname id join kill link ln logname ls
- md5sum mkdir mkfifo mknod mv nice nl nohup od paste pathchk pinky pr
- printenv printf ptx pwd readlink rm rmdir seq sha1sum sha224sum sha256sum
- sha384sum sha512sum shred shuf sleep sort split stat stty su sum sync tac
- tail tee test touch tr true tsort tty uname unexpand uniq unlink uptime
- users vdir wc who whoami yes
+ [ arch base32 base64 basename cat chcon chgrp chmod chown chroot cksum comm
+ coreutils cp csplit cut date dd df dir dircolors dirname du echo env
+ expand expr factor false fmt fold groups head hostid hostname id install
+ join kill link ln logname ls md5sum mkdir mkfifo mknod mktemp mv nice nl
+ nohup nproc numfmt od paste pathchk pinky pr printenv printf ptx pwd
+ readlink realpath rm rmdir runcon seq sha1sum sha224sum sha256sum sha384sum
+ sha512sum shred shuf sleep sort split stat stdbuf stty sum sync tac tail
+ tee test timeout touch tr true truncate tsort tty uname unexpand uniq
+ unlink uptime users vdir wc who whoami yes
See the file NEWS for a list of major changes in the current release.
-See the file INSTALL for compilation and installation instructions.
+If you obtained this file as part of a "git clone", then see the
+README-hacking file. If this file came to you as part of a tar archive,
+then see the file INSTALL for compilation and installation instructions.
These programs are intended to conform to POSIX (with BSD and other
extensions), like the rest of the GNU system. By default they conform
@@ -38,7 +41,7 @@ Special thanks to Paul Eggert, Brian Matthews, Bruce Evans, Karl Berry,
Kaveh Ghazi, and François Pinard for help with debugging and porting
these programs. Many thanks to all of the people who have taken the
time to submit problem reports and fixes. All contributed changes are
-attributed in the ChangeLog files.
+attributed in the commit logs.
And thanks to the following people who have provided accounts for
portability testing on many different types of systems: Bob Proulx,
@@ -55,25 +58,43 @@ and from the corresponding --help usage message. Patches to the template
files (man/*.x) are welcome. However, the authoritative documentation
is in texinfo form in the doc directory.
-If you run the tests on a SunOS4.1.4 system, expect the ctime-part of
-the ls `time-1' test to fail. I believe that is due to a bug in the
-way Sun implemented link(2) and chmod(2).
+*********************************************
+On Mac OS X 10.5.1 (Darwin 9.1), test failure
+---------------------------------------------
-***********************
+Mac OS X 10.5.1 (Darwin 9.1) provides only partial (and incompatible)
+ACL support, so although "./configure && make" succeeds, "make check"
+exposes numerous failures. The solution is to turn off ACL support
+manually via "./configure --disable-acl". For details, see
+<http://thread.gmane.org/gmane.comp.gnu.coreutils.bugs/12292/focus=12318>.
+
+
+*****************************************
+Test failure with NLS and gettext <= 0.17
+-----------------------------------------
+
+Due to a conflict between libintl.h and gnulib's new xprintf module,
+when you configure with NLS support, and with a gettext installation
+older than 0.17.1 (not yet released, at the time of this writing),
+then some tests fail, at least on NetBSD 1.6. To work around it in
+the mean time, you can configure with --disable-nls. For details,
+see <http://thread.gmane.org/gmane.comp.lib.gnulib.bugs/12015/>.
+
+
+*********************
Pre-C99 build failure
------------------------
+---------------------
-There is a new, implicit build requirement:
-To build the coreutils from source, you should have a C99-conforming
+In 2009 we added this requirement:
+To build the coreutils from source, you must have a C99-conforming
compiler, due to the use of declarations after non-declaration statements
in several files in src/. There is code in configure to find and, if
possible, enable an appropriate compiler. However, if configure doesn't
find a C99 compiler, it continues nonetheless, and your build will fail.
-If that happens, simply apply the included patch using the following
-command, and then run make again:
-
- cd src && patch < c99-to-c89.diff
+There used to be a "c99-to-c89.diff" patch you could apply to convert
+to code that even an old pre-c99 compiler can handle, but it was too
+tedious to maintain, so has been removed.
***********************
@@ -81,7 +102,7 @@ HPUX 11.x build failure
-----------------------
A known problem exists when compiling on HPUX on both hppa and ia64
-in 64-bit mode (i.e. +DD64) on HP-UX 11.0, 11.11, and 11.23. This
+in 64-bit mode (i.e., +DD64) on HP-UX 11.0, 11.11, and 11.23. This
is not due to a bug in the package but instead due to a bug in the
system header file which breaks things in 64-bit mode. The default
compilation mode is 32-bit and the software compiles fine using the
@@ -108,23 +129,31 @@ the best solution is to use GNU make. Otherwise, simply remove
all mention of "[$(EXEEXT)" from src/Makefile.
+*************************************************
+"make check" failure on IRIX 6.5 and Solaris <= 9
+-------------------------------------------------
+
+Using the vendor make program to run "make check" fails on these two systems.
+If you want to run all of the tests there, use GNU make.
+
+
**********************
Running tests as root:
----------------------
If you run the tests as root, note that a few of them create files
-and/or run programs as a non-root user, `nobody' by default.
+and/or run programs as a non-root user, 'nobody' by default.
If you want to use some other non-root username, specify it via
the NON_ROOT_USERNAME environment variable. Depending on the
permissions with which the working directories have been created,
-using `nobody' may fail, because that user won't have the required
+using 'nobody' may fail, because that user won't have the required
read and write access to the build and test directories.
I find that it is best to unpack and build as a non-privileged
user, and then to run the following command as that user in order
to run the privilege-requiring tests:
- sudo env NON_ROOT_USERNAME=$USER make -k check
+ sudo env PATH="$PATH" NON_ROOT_USERNAME=$USER make -k check-root
If you can run the tests as root, please do so and report any
problems. We get much less test coverage in that mode, and it's
@@ -136,20 +165,26 @@ root than when run by less privileged users.
Reporting bugs:
---------------
+Send bug reports, questions, comments, etc. to bug-coreutils@gnu.org.
+To suggest a patch, see the files README-hacking and HACKING for tips.
+
+If you have a problem with 'sort', try running 'sort --debug', as it
+can can often help find and fix problems without having to wait for an
+answer to a bug report. If the debug output does not suffice to fix
+the problem on your own, please compress and attach it to the rest of
+your bug report.
+
IMPORTANT: if you take the time to report a test failure,
-please be sure to include the output of running `make check'
+please be sure to include the output of running 'make check'
in verbose mode for each failing test. For example,
-if the test that fails is tests/mv/hard-link-1, then you
-would run this command:
-
- env VERBOSE=yes make check -C tests/mv TESTS=hard-link-1 >> log 2>&1
+if the test that fails is tests/df/df-P.sh, then you would
+run this command:
-For some tests, you can get even more detail by including
-DEBUG=yes in the environment:
+ make check TESTS=tests/df/df-P.sh VERBOSE=yes SUBDIRS=. >> log 2>&1
- env DEBUG=yes VERBOSE=yes make check -C tests/mv TESTS=hard-link-1 >> log 2>&1
+For some tests, you can get even more detail by adding DEBUG=yes.
+Then include the contents of the file 'log' in your bug report.
-and then include the contents of the file `log' in your bug report.
***************************************
@@ -163,20 +198,21 @@ If you sent a complete patch and, after a couple weeks you haven't
received any acknowledgement, please ping us. A complete patch includes
a well-written ChangeLog entry, unified (diff -u format) diffs relative
to the most recent test release (or, better, relative to the latest
-sources in the CVS repository), an explanation for why the patch is
+sources in the public repository), an explanation for why the patch is
necessary or useful, and if at all possible, enough information to
reproduce whatever problem prompted it. Plus, you'll earn lots of
karma if you include a test case to exercise any bug(s) you fix.
-Instructions for checking out the latest source via CVS are here:
-
- http://savannah.gnu.org/cvs/?group=coreutils
+Here are instructions for checking out the latest development sources:
+ http://savannah.gnu.org/git/?group=coreutils
If your patch adds a new feature, please try to get some sort of consensus
that it is a worthwhile change. One way to do that is to send mail to
-bug-coreutils@gnu.org including as much description and justification
+coreutils@gnu.org including as much description and justification
as you can. Based on the feedback that generates, you may be able to
-convince us that it's worth adding.
+convince us that it's worth adding. Please also consult the list of
+previously discussed but ultimately rejected feature requests at:
+http://www.gnu.org/software/coreutils/rejected_requests.html
WARNING: Now that we use the ./bootstrap script, you should not run
@@ -188,15 +224,9 @@ subtle bugs.
WARNING: If you modify files like configure.in, m4/*.m4, aclocal.m4,
or any Makefile.am, then don't be surprised if what gets regenerated no
longer works. To make things work, you'll have to be using appropriate
-versions of automake and autoconf. As for what versions are `appropriate',
-use the versions of
-
- * autoconf specified via AC_PREREQ in m4/jm-macros.m4
- * automake specified via AM_INIT_AUTOMAKE in configure.ac
+versions of the tools listed in bootstrap.conf's buildreq string.
-Usually it's fine to use versions that are newer than those specified.
-
-All of these programs except `test' recognize the `--version' option.
+All of these programs except 'test' recognize the '--version' option.
When reporting bugs, please include in the subject line both the package
name/version and the name of the program for which you found a problem.
@@ -204,18 +234,20 @@ For general documentation on the coding and usage standards
this distribution follows, see the GNU Coding Standards,
http://www.gnu.org/prep/standards_toc.html.
+For any copyright year range specified as YYYY-ZZZZ in this package
+note that the range specifies every single year in that closed interval.
+
Mail suggestions and bug reports for these programs to
the address on the last line of --help output.
========================================================================
-Copyright (C) 1998, 2002, 2003, 2004, 2005, 2006 Free Software
-Foundation, Inc.
+Copyright (C) 1998-2016 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.2 or
+under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
-Texts. A copy of the license is included in the ``GNU Free
-Documentation License'' file as part of this distribution.
+Texts. A copy of the license is included in the "GNU Free
+Documentation License" file as part of this distribution.