tests: remove df/total
[platform/upstream/coreutils.git] / README
diff --git a/README b/README
index 64a565c..157432e 100644 (file)
--- a/README
+++ b/README
@@ -7,17 +7,21 @@ arbitrary limits.
 
 The programs that can be built with this package are:
 
-  [ 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 shred 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 base64 basename cat chcon chgrp chmod chown chroot cksum comm 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
+  od paste pathchk pinky pr printenv printf ptx pwd readlink rm rmdir
+  runcon seq sha1sum sha224sum sha256sum sha384sum sha512sum shred shuf
+  sleep sort split stat stty su 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
@@ -54,9 +58,45 @@ 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
+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
+
 
 ***********************
 HPUX 11.x build failure
@@ -79,6 +119,18 @@ Here is one possible patch to correct the problem:
 +#ifndef __LP64__
 
 
+************************
+OSF/1 4.0d build failure
+------------------------
+
+If you use /usr/bin/make on an OSF/1 4.0d system, it will fail due
+to the presence of the "[" target.  That version of make appears to
+treat "[" as some syntax relating to locks.  To work around that,
+the best solution is to use GNU make.  Otherwise, simply remove
+all mention of "[$(EXEEXT)" from src/Makefile.
+
+
+
 **********************
 Running tests as root:
 ----------------------
@@ -94,7 +146,7 @@ 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
@@ -108,17 +160,22 @@ Reporting bugs:
 
 IMPORTANT: if you take the time to report a test failure,
 please be sure to include the output of running `make check'
-in verbose mode for each each failing test.  For example,
+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
 
+For some tests, you can get even more detail by including
+DEBUG=yes in the environment:
+
+  env DEBUG=yes VERBOSE=yes make check -C tests/mv TESTS=hard-link-1 >> log 2>&1
+
 and then include the contents of the file `log' in your bug report.
 
 ***************************************
 
-There are pretty many tests, but nowhere near as many as we need.
+There are many tests, but nowhere near as many as we need.
 Additions and corrections are very welcome.
 
 If you see a problem that you've already reported, feel free to re-report
@@ -128,14 +185,13 @@ 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
@@ -144,6 +200,12 @@ as you can.  Based on the feedback that generates, you may be able to
 convince us that it's worth adding.
 
 
+WARNING:  Now that we use the ./bootstrap script, you should not run
+autoreconf manually.  Doing that will overwrite essential source files
+with older versions, which may make the package unbuildable or introduce
+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
@@ -165,3 +227,16 @@ http://www.gnu.org/prep/standards_toc.html.
 
 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.
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.2 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.