refs #17044 - update foreman-debug man page for -s option change

Fobhep · Nov 7, 2016 · 45f8b47 · 45f8b47
1 parent 74002ce
commit 45f8b47
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 6 deletions.
diff --git a/man/foreman-debug.8.asciidoc b/man/foreman-debug.8.asciidoc
@@ -11,7 +11,7 @@ SYNOPSIS
 --------
 foreman-debug [OPTIONS]
 
-foreman-debug -d /output/dir -a -m 9000 -v
+foreman-debug -d /output/dir -a -v
 
 foreman-debug -h
 
@@ -42,7 +42,7 @@ The following options are available:
   -d DIR  Directory to place the tarball in (default /tmp/foreman-XYZ)
   -g      Skip generic info (CPU, memory, firewall etc.)
   -a      Do not generate a tarball from the resulting directory
-  -m NUM  Maximum lines to keep for each file (default 5000)
+  -s SIZE Maximum log set size in MB (current and rotated files, default 10 MB)
   -j PRG  Filter with provided program when creating a tarball
   -p      Additionally print all passwords which are being filtered
   -q      Quiet mode
@@ -60,7 +60,7 @@ following environment variables can be defined:
  - DIR: Directory to place the tarball in (string)
  - NOGENERIC:  Skip generic info (0 or 1)
  - NOTAR:  Do not create tarballs (0 or 1)
- - MAXLINES: Maximum lines to keep for files (integer)
+ - MAXSIZE: Maximum log set size in bytes (integer)
  - COMPRESS: Compress program to pipe the tarball through (string)
  - PRINTPASS: Print passwords which are filtered out to stdout (0 or 1)
  - QUIET: Quiet mode (0 or 1)

diff --git a/script/foreman-debug b/script/foreman-debug
@@ -22,11 +22,10 @@ OPTIONS:
   -d DIR  Directory to place the tarball in (default /tmp/foreman-XYZ)
   -g      Skip generic info (CPU, memory, firewall etc.)
   -a      Do not generate a tarball from the resulting directory
-  -m NUM  Maximum lines to keep for each file, deprecated, use -s
+  -s SIZE Maximum log set size in MB (current+rotated files, defaults to 10 MB)
   -j PRG  Filter with provided program when creating a tarball
   -p      Additionally print password patterns being filtered out
   -q      Quiet mode
-  -s SIZE Maximum log set size in MB (current+rotated files, defaults to 10 MB)
   -v      Verbose mode
   -u      Upload tarball$UPLOAD_INFO
   -h      Shows this message
@@ -181,7 +180,7 @@ while getopts "d:gam:s:j:uqpvhx" opt; do
       VERBOSE=1
       ;;
     m)
-      error "Warning: -m option is deprecated, use -s option"
+      error "Warning: -m option has no effect, use -s option"
       ;;
     j)
       COMPRESS="$OPTARG"