Patchwork [Open-FCoE] fcoe-utils: Fix README problems

login
register
mail settings
Submitter Robert Love
Date May 9, 2013, 9:58 p.m.
Message ID <20130509215814.7220.34166.stgit@fritz>
Download mbox | patch
Permalink /patch/38/
State Accepted
Headers show

Comments

Robert Love - May 9, 2013, 9:58 p.m.
This patch fixes some typos and confusing text in the README file.

Signed-off-by: Robert Love <robert.w.love@intel.com>
---
 README |   46 ++++++++++++++++++++--------------------------
 1 file changed, 20 insertions(+), 26 deletions(-)

Patch

diff --git a/README b/README
index cc28bf0..5f4f4ae 100644
--- a/README
+++ b/README
@@ -8,23 +8,22 @@  The FCoE Management Tools included in this package are
 
 Requirements:
 
-        The HBAAPI library and the HBAAPI vendor library source must be build
-and installed before you can build the management tools. The HBAAPI vendor
-library, libhbalinux, may be downloaded from www.Open-FCoE.org. The instructions
-in the package describes how to download and build the libraries.  See the man
-pages for other requirements.
+        The HBAAPI library and the HBAAPI vendor library source must be built
+and installed before you can build the management tools. Both the HBAAPI library,
+libHBAAPI, and the HBAAPI vendor library, libhbalinux, may be downloaded from
+www.Open-FCoE.org. The instructions in the package describe how to download and
+build the libraries.
 
 Best Practices :
 
 Any newly discovered disk can be mounted using udev rules, autofs and possibly by
-other methods as needed but if a fcoe disk is needed during boot by any of other
-system startup service followed by fcoe service start then such fcoe disk needs to
-be mounted along fcoe service start before service requiring fcoe disk gets to start
-at boot. The fcoe disk mounting at boot can be automated by adding fcoe disk
-mounting code to fcoe service start code at /etc/init.d/fcoe and this code should
-be per system configuration for either a simple formatted fcoe disk, lvm
-or muti-path device node etc, below is a sample code as an example to mount a fcoe
-disk having ext3 file system using /etc/fstab entries.
+other methods as needed. However, if a fcoe disk is needed by any other system service
+that follows the fcoe service then the disk will need to be mounted at some point
+after the fcoe service, but before the service that requires the disk. That mounting
+could possibly be added to the fcoe service script itself, or to a new service script
+that would run after fcoe, but before the script that requires the fcoe disk.
+The following is an example of how to mount a fcoe disk formatted with an ext3 file
+system using /etc/fstab.
 
 	mount_fcoe_disks_from_fstab()
 	{
@@ -60,21 +59,16 @@  disk having ext3 file system using /etc/fstab entries.
 	    mount -a 2>/dev/null
 	}
 
-	Above mount_fcoe_disks_from_fstab function should be invoked after
-fcoemon daemon is started by fcoe service script to mount any fcoe disk
+	The mount_fcoe_disks_from_fstab function should be invoked after the
+fcoemon daemon is started by the fcoe service script to mount any fcoe disk
 specified by path in /etc/fstab as:-
 
 	/dev/disk/by-path/fc-0xXX:0xXX /mnt/fcoe-disk1 ext3  defaults,_netdev    0 0
 	/dev/disk/by-path/fc-0xYY:0xYY /mnt/fcoe-disk2 ext3  defaults,_netdev    0 0
 
-	These entries with "fc-" and "_netdev" sub-strings enables
-mount_fcoe_disks_from_fstab to identify fcoe disks mount entries to wait for a
-their fcoe disk to show up within specified timeout period, the timeout is
-set to 20 seconds but can be changed per typical fcoe disk discovery time in
-a system, see man fstab(5) for for more details on above entries.
-
-	This timeout is needed since currently fcoe service start does not
-know when fcoe disk discovery is going to finish, therefore a timed wait
-would ensure that a fcoe service start will wait for only specified timeout
-or till all fcoe disk from /etc/fstab present before proceeding to mount
-fcoe disks per their /etc/fstab entries in this example.
+	The /dev/disk/by-path entries with "fc-" and "_netdev" in their names
+enables mount_fcoe_disks_from_fstab to identify the fcoe disks so that it can
+wait for the fcoe disks to be discovered. If they are not added to the system
+within the timeout period the function will exit, the timeout is set to 20
+seconds but can be changed to suit the environment. See man fstab(5) for for
+more details on mounting filesystems.