Bug 770195

Summary:	Section 32.4 - Kickstart options for "firewall" keyword is incorrect
Product:	Red Hat Enterprise Linux 6	Reporter:	Kwan Lowe <kwan>
Component:	doc-Installation_Guide	Assignee:	Jack Reed <jreed>
Status:	CLOSED CURRENTRELEASE	QA Contact:	ecs-bugs
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	6.0	CC:	jskeoch, pbokoc
Target Milestone:	rc	Keywords:	Documentation
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2013-02-25 23:34:08 UTC	Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:

Description Kwan Lowe 2011-12-24 01:59:29 UTC

Description of problem:
Many of the kickstart options are missing BNF notation of syntax. For example, the iscsi, logging and monitor keywords do not have BNFs. This is inconsistent with the rest of the section.




How reproducible:


Steps to Reproduce:
1.
2.
3.
  
Actual results:
The text from the "logging" section, for example:
logging (optional)
This command controls the error logging of anaconda during installation. It has no effect on the installed system.
--host= — Send logging information to the given remote host, which must be running a syslogd process configured to accept remote logging.
--port= — If the remote syslogd process uses a port other than the default, it may be specified with this option.
--level= — One of debug, info, warning, error, or critical.
Specify the minimum level of messages that appear on tty3. All messages will still be sent to the log file regardless of this level, however.
Version-Release number of selected component (if applicable):

Expected results:

logging [--host=<host>] [--port=<port>] [--level= "debug"|"info" ] 

( :)  The BNF above is not "correct" either )

Additional info:

Comment 2 Jack Reed 2012-03-06 03:26:08 UTC

Due to time constraints, pushing to 6.4 because this is a fairly meticulous formatting issue.

Comment 3 Jack Reed 2012-10-19 03:11:42 UTC

Thanks very much for reporting this. I can certainly see the inconsistency.

For the 6.4 documentation, I've added BNF notation to the three you've mentioned: iscsi, monitor, and logging, especially because they were the three most in need of tidying up (iscsi in particular). 

I can see there are a few other candidates, and I will fix them up as time commitments allow.

Here's the new notation I've added:

iscsi --ipaddr=<ipaddr> [options]
logging [--host=<host>] [--port=<port>] [--level=debug|info|error|critical]
monitor --monitor=<monitorname>|--hsync|vsync=<frequency> [--noprobe]

Comment 6 Jack Reed 2013-02-25 23:34:08 UTC

This bug has been verified and implemented for 6.4, so I am changing the status to CLOSED CURRENT RELEASE.