Bug 525136 - [RHEL-5][documentation] iscsi and iscsiname kickstart commands not documented
Summary: [RHEL-5][documentation] iscsi and iscsiname kickstart commands not documented
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 5
Classification: Red Hat
Component: anaconda
Version: 5.4
Hardware: All
OS: Linux
low
medium
Target Milestone: rc
: ---
Assignee: Hans de Goede
QA Contact: Release Test Team
URL:
Whiteboard:
Depends On:
Blocks: 525139 600484
TreeView+ depends on / blocked
 
Reported: 2009-09-23 14:10 UTC by Alexander Todorov
Modified: 2013-07-12 00:03 UTC (History)
2 users (show)

Fixed In Version: anaconda-11.1.2.212-1
Doc Type: Bug Fix
Doc Text:
Previously, the iscsi kickstart command was not documented in the kickstart-docs.txt file beyond noting its existence and its options, and the iscsiname command and ignoredisk --onlyuse option were not documented at all. Users had to consult documentation outside anaconda itself to learn how to use these commands and options. In this release, the iscsiname command and ignoredisk --onlyuse option are now documented, and the description of the iscsi command is expanded, reducing the requirement for users to resort to other documentation to use these commands and options. (BZ#525136, BZ#586576)
Clone Of:
: 525139 (view as bug list)
Environment:
Last Closed: 2011-01-13 21:53:00 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
Patch adding more info about iscsi cmds to kickstart-docs.txt (3.03 KB, patch)
2010-03-04 09:58 UTC, Hans de Goede
no flags Details | Diff


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2011:0030 0 normal SHIPPED_LIVE anaconda bug fix and enhancement update 2011-01-12 15:59:28 UTC

Description Alexander Todorov 2009-09-23 14:10:00 UTC
Description of problem:
The iscsi and iscsiname commands are not well documented in kickstart-docs.txt.
While iscsi command is show with its parameters a one line description will be helpful. For example: use this command to attach additional iscsi storage during installation.

iscsiname command is not documented at all, only the command name and the fact that it's optional is present. No indication what it does or how it's supposed to be used.

Version-Release number of selected component (if applicable):
anaconda-11.1.2.195-1

How reproducible:
always

Steps to Reproduce:
1. search for iscsi in /usr/share/doc/anaconda-*/kickstart-docs.txt

Comment 2 Hans de Goede 2010-03-04 09:58:43 UTC
Created attachment 397773 [details]
Patch adding more info about iscsi cmds to kickstart-docs.txt

Comment 3 Hans de Goede 2010-08-11 14:05:43 UTC
This is fixed in anaconda-11.1.2.212-1, moving to modified.

Comment 5 Alexander Todorov 2010-10-04 15:20:59 UTC
In anaconda-11.1.2.216-1 both commands are documented. Moving to VERIFIED.

Comment 6 Ruediger Landmann 2011-01-07 02:43:54 UTC
    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    New Contents:
* Previously, the iscsi kickstart command was not documented in the 
kickstart-docs.txt file beyond noting its existence and its options, and 
the iscsiname command was not documented at all. Users had to consult 
documentation outside anaconda itself to learn how to use these commands. 
In this release, the iscsiname command is now documented, and the 
description of the iscsi command is expanded, reducing the requirement 
for users to resort to other documentation to use these commands. 
(BZ#525136)

Comment 7 Ruediger Landmann 2011-01-12 08:02:07 UTC
    Technical note updated. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    Diffed Contents:
@@ -1,8 +1,9 @@
-* Previously, the iscsi kickstart command was not documented in the 
+Previously, the iscsi kickstart command was not documented in the 
-kickstart-docs.txt file beyond noting its existence and its options, and 
+kickstart-docs.txt file beyond noting its existence and its options, and
-the iscsiname command was not documented at all. Users had to consult 
+the iscsiname command and ignoredisk --onlyuse option were not documented 
-documentation outside anaconda itself to learn how to use these commands. 
+at all. Users had to consult documentation outside anaconda itself to 
-In this release, the iscsiname command is now documented, and the 
+learn how to use these commands and options. In this release, the 
-description of the iscsi command is expanded, reducing the requirement 
+iscsiname command and ignoredisk --onlyuse option are now documented, and 
-for users to resort to other documentation to use these commands. 
+the description of the iscsi command is expanded, reducing the 
-(BZ#525136)+requirement for users to resort to other documentation to use these 
+commands and options. (BZ#525136, BZ#586576)

Comment 9 errata-xmlrpc 2011-01-13 21:53:00 UTC
An advisory has been issued which should help the problem
described in this bug report. This report is therefore being
closed with a resolution of ERRATA. For more information
on therefore solution and/or where to find the updated files,
please follow the link below. You may reopen this bug report
if the solution does not work for you.

http://rhn.redhat.com/errata/RHBA-2011-0030.html


Note You need to log in before you can comment on or make changes to this bug.