From: Andrew Deason <adeason@sinenomine.net>
Date: Mon, 4 Nov 2013 16:04:42 +0000 (-0600)
Subject: doc: Fix livesys output formatting
X-Git-Tag: upstream/1.8.0_pre1^2~920
X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=477f270656171da1cc69902b6b5917d79e19bd3d;p=packages%2Fo%2Fopenafs.git

doc: Fix livesys output formatting

If we indent text here, the formatting codes are not interpreted, and
the text is output "raw". So currently, we actually see
"I<system_type>" in this section, which is a bit confusing.

Saying the actual output with string substitutions and stuff here
doesn't seem very helpful when the output doesn't have any constant
text in it. Just describe what the output is instead; an example
immediately follows if this is unclear.

Change-Id: Ib3e0f0c5143afa2dd41a655ff3908c791026a426
Reviewed-on: http://gerrit.openafs.org/10411
Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
Tested-by: Derrick Brashear <shadow@your-file-system.com>
---

diff --git a/doc/man-pages/pod1/livesys.pod b/doc/man-pages/pod1/livesys.pod
index 80203dd9f..265bf2480 100644
--- a/doc/man-pages/pod1/livesys.pod
+++ b/doc/man-pages/pod1/livesys.pod
@@ -39,9 +39,8 @@ B<sys>.
 
 =head1 OUTPUT
 
-The machine's system type appears as a text string:
-
-   I<system_type>
+The machine's system type appears as a text string, by itself, on a single
+line.
 
 =head1 EXAMPLES