doc: shred: Correct docs on default number of overwrites.
authorPádraig Brady <P@draigBrady.com>
Thu, 22 Jan 2009 19:34:11 +0000 (19:34 +0000)
committerPádraig Brady <P@draigBrady.com>
Thu, 22 Jan 2009 23:42:51 +0000 (23:42 +0000)
* NEWS: Mention the change to the default number of passes.
* doc/Makefile.am: Update constants.texi with the default
number of passes shred uses, so that the documentation
will automatically reflect any future changes.
* doc/coreutils.texi (shred invocation): Update the description
of the --iterations option to have the correct default number,
while still conveying that there are 25 internal patterns
that may be useful.

NEWS
doc/Makefile.am
doc/coreutils.texi

diff --git a/NEWS b/NEWS
index f1b383e..83b8ed9 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -41,6 +41,8 @@ GNU coreutils NEWS                                    -*- outline -*-
   du: -H (initially equivalent to --si) is now equivalent to
   --dereference-args, and thus works as POSIX requires
 
+  shred: now does 3 overwrite passes by default rather than 25.
+
   ls -l now marks SELinux-only files with the less obtrusive '.',
   rather than '+'.  A file with any other combination of MAC and ACL
   is still marked with a '+'.
index cba3332..f6f98af 100644 (file)
@@ -29,10 +29,13 @@ EXTRA_DIST = perm.texi getdate.texi constants.texi fdl.texi
 # old systems.
 AM_MAKEINFOFLAGS = --no-split
 
-constants.texi: $(top_srcdir)/src/tail.c
+constants.texi: $(top_srcdir)/src/tail.c $(top_srcdir)/src/shred.c
        LC_ALL=C \
        sed -n -e 's/^#define \(DEFAULT_MAX[_A-Z]*\) \(.*\)/@set \1 \2/p' \
          $(top_srcdir)/src/tail.c > t-$@
+       LC_ALL=C \
+       sed -n -e 's/.*\(DEFAULT_PASSES\)[ =]* \([0-9]*\).*/@set SHRED_\1 \2/p'\
+         $(top_srcdir)/src/shred.c >> t-$@
        mv t-$@ $@
 
 MAINTAINERCLEANFILES = constants.texi
index d8df107..d8b9087 100644 (file)
@@ -8445,10 +8445,10 @@ Override file permissions if necessary to allow overwriting.
 @opindex -n @var{number}
 @opindex --iterations=@var{number}
 @cindex iterations, selecting the number of
-By default, @command{shred} uses 25 passes of overwrite.  This is enough
-for all of the useful overwrite patterns to be used at least once.
-You can reduce this to save time, or increase it if you have a lot of
-time to waste.
+By default, @command{shred} uses @value{SHRED_DEFAULT_PASSES} passes of
+overwrite. You can reduce this to save time, or increase it if you think it's
+appropriate. After 25 passes all of the internal overwrite patterns will have
+been used at least once.
 
 @item --random-source=@var{file}
 @opindex --random-source