15a2072
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
15a2072
From: Robert Marshall <rmarshall@redhat.com>
15a2072
Date: Tue, 26 Jan 2016 10:28:35 -0500
15a2072
Subject: [PATCH] Clean up grub-setpassword documentation (#1290799)
15a2072
15a2072
The output for --help had some errors. Corrected those and polished the
15a2072
text to be a little easier to follow. Carried verbage over to man page
15a2072
to maintain internal consistency.
15a2072
15a2072
Resolves: rhbz#1290799
15a2072
---
15a2072
 util/grub-setpassword.8  |  2 +-
15a2072
 util/grub-setpassword.in | 15 +++++++--------
15a2072
 2 files changed, 8 insertions(+), 9 deletions(-)
15a2072
15a2072
diff --git a/util/grub-setpassword.8 b/util/grub-setpassword.8
15a2072
index 49200a848b7..dc91dd6697b 100644
15a2072
--- a/util/grub-setpassword.8
15a2072
+++ b/util/grub-setpassword.8
15a2072
@@ -19,7 +19,7 @@ Display program usage and exit.
15a2072
 -v, --version
15a2072
 Display the current version.
15a2072
 .TP
15a2072
--o, --output[=\fIDIRECTORY PATH\fR]
15a2072
+-o, --output=<\fIDIRECTORY\fR>
15a2072
 Choose the file path to which user.cfg will be written.
15a2072
 
15a2072
 .SH SEE ALSO
15a2072
diff --git a/util/grub-setpassword.in b/util/grub-setpassword.in
15a2072
index fb9d3a3b6f9..c8c0fa4199d 100644
15a2072
--- a/util/grub-setpassword.in
15a2072
+++ b/util/grub-setpassword.in
15a2072
@@ -16,15 +16,14 @@ grub_mkpasswd="${bindir}/@grub_mkpasswd_pbkdf2@"
15a2072
 # Print the usage.
15a2072
 usage () {
15a2072
     cat <
15a2072
-Usage: $0 [OPTION] [SOURCE]
15a2072
-Run GRUB script in a Qemu instance.
15a2072
-
15a2072
-  -h, --help              print this message and exit
15a2072
-  -v, --version           print the version information and exit
15a2072
-  -o, --output_path       choose a custom output path for user.cfg
15a2072
-
15a2072
+Usage: $0 [OPTION]
15a2072
 $0 prompts the user to set a password on the grub bootloader. The password
15a2072
-is written to a file named user.cfg.
15a2072
+is written to a file named user.cfg which lives in the GRUB directory
15a2072
+located by default at ${grubdir}.
15a2072
+
15a2072
+  -h, --help                     print this message and exit
15a2072
+  -v, --version                  print the version information and exit
15a2072
+  -o, --output_path <DIRECTORY>  put user.cfg in a user-selected directory
15a2072
 
15a2072
 Report bugs at https://bugzilla.redhat.com.
15a2072
 EOF