[Ocfs2-commits] mfasheh commits r2272 - trunk

[svn-commits at oss.oracle.com]

Author: mfasheh
Signed-off-by: manish
Date: 2005-05-17 22:58:14 -0500 (Tue, 17 May 2005)
New Revision: 2272

Modified:
   trunk/README
Log:
* update the readme

Signed-off-by: manish



Modified: trunk/README
===================================================================
--- trunk/README	2005-05-18 02:34:26 UTC (rev 2271)
+++ trunk/README	2005-05-18 03:58:14 UTC (rev 2272)
@@ -1,92 +1,26 @@
-        OCFS Version 2 BETA 10
+OCFS2 filesystem
+==================
+OCFS2 is a shared disk cluster file system with many similarities to
+ext3. You'll want to install the tools in order to at least get
+"mount.ocfs2".
 
-*** WARNING WARNING WARNING ***
-This is BETA software. It should absolutely NOT be run on production
-systems.  If you are looking to run OCFS on a production system, check
-out OCFS version 1.
+Project web page:    http://oss.oracle.com/projects/ocfs2
+Tools web page:      http://oss.oracle.com/projects/ocfs2-tools
+OCFS2 mailing lists: http://oss.oracle.com/projects/ocfs2/mailman/
 
-WHAT IS OCFS2?
- OCFS2 is the latest version of the Oracle Cluster File System
- software. Where OCFS1 was designed specifically "for Oracle Database
- files", OCFS2 supports a shared ORACLE_HOME installation. New features 
- include:
+All code copyright 2005 Oracle except when otherwise noted.
 
- * Shared ORACLE_HOME
- * Improved performance of meta data operations (space allocation, 
-   locking, etc).
- * Improved meta data caching.
- * Improved data caching (for files such as oracle binaries, libraries, etc)
- * Network based DLM is used by default.
- * Improved journaling / node recovery - we now use the Linux Kernel "JBD" 
-   subsystem
- * Keep the same performance for Oracle data files as OCFS1.
- * CDSL for node specific files
- * POSIX compliance
+CREDITS:
+Lots of code taken from ext3 and other projects.
 
-INSTALLING OCFS2
- Step 1: Download and install OCFS2 and OCFS2-Tools
+Authors in alphabetical order:
+Joel Becker   <joel.becker at oracle.com>
+Zach Brown    <zach.brown at oracle.com>
+Mark Fasheh   <mark.fasheh at oracle.com>
+Kurt Hackel   <kurt.hackel at oracle.com>
+Sunil Mushran <sunil.mushran at oracle.com>
+Manish Singh  <manish.singh at oracle.com>
 
- To install you need to download the OCFS2 Beta RPMS for your system
- from the following location:
-
-    http://oss.oracle.com/projects/ocfs2/files/
-
- You will need the module RPM for your kernel version and the
- ocfs2-support rpm for your distribution.
-
- Also, download the latest OCFS2-Tools rpm (version 0.99.4) from the
- following location:
-
-    http://oss.oracle.com/projects/ocfs2-tools/files/
-
- Install the packages using your package manager. The OCFS2 packages
- are designed to co-exist with an existing OCFS1 installation.
-
- Step 2: Configure a cluster
-
- The easiest way to do this is to use the GUI cluster configuration
- utility in ocfs2console.
-
- If you wish to do this by hand, see the file README.O2CB in the
- ocfs2-tools distribution.
-
- Step 3: Create a file system
-
- The example below assumes you want an OCFS2 file system on
- "/dev/sdb1" and are mounting it at "/ocfs2". Replace those values with
- your own.
-
- Creating a new OCFS2 file system is as easy as running the
- "mkfs.ocfs2" program. As a default it picks a block size of 4K and a
- cluster size of 4K and a file system which can contain up to 4
- nodes. You can specify your own options to override the
- defaults (please see the man page). If you're planning to run Oracle
- in a shared home configuration, we recommend you use a cluster size
- between 4K and 16K.
-
-    $ mkfs.ocfs2 /dev/sdb1
-
- Step 4: Mount the file system
-
-    $ mount -t ocfs2 /dev/sdb1 /ocfs2
-
-REPORTING BUGS
- To report OCFS2 bugs, please use bugzilla:
-
-    http://oss.oracle.com/bugzilla/buglist.cgi?product=OCFS2
-
- Please try to be as verbose in bug reports as possible.
-
-KNOWN ISSUES
- People upgrading from previous versions should upgrade all nodes before
- remounting the file system as some incompatible dlm fixes have gone
- in.
-
- Please see bugzilla for an up to date list of issues.
-
-MAILING LISTS
- Please join the OCFS2 mailing lists at: 
-
-    http://oss.oracle.com/projects/ocfs2/mailman/
-
-
+Mount options
+=============
+None that should be manually specified by the user right now.