From: Pádraig Brady <P@draigBrady.com>
Date: Thu, 22 Jan 2009 19:34:11 +0000 (+0000)
Subject: doc: shred: Correct docs on default number of overwrites.
X-Git-Tag: v7.1~47
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=10f3e12a0d36ab00e5c402e54466382b47a519e6;p=thirdparty%2Fcoreutils.git

doc: shred: Correct docs on default number of overwrites.

* 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.
---

diff --git a/NEWS b/NEWS
index f1b383e39d..83b8ed9a1f 100644
--- 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 '+'.
diff --git a/doc/Makefile.am b/doc/Makefile.am
index cba3332260..f6f98afa5a 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -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
diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index d8df10760c..d8b90876d1 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -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