From 10f3e12a0d36ab00e5c402e54466382b47a519e6 Mon Sep 17 00:00:00 2001 From: Pádraig Brady Date: Thu, 22 Jan 2009 19:34:11 +0000 Subject: 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. --- doc/Makefile.am | 5 ++++- doc/coreutils.texi | 8 ++++---- 2 files changed, 8 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index cba333226..f6f98afa5 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 d8df10760..d8b90876d 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 -- cgit v1.2.3-70-g09d2