[PATCH] PMFS: Cleanup to pmfs.txt and README.md

[Vishal Verma]

Looks good to me!

Acked-by: Vishal Verma <vishal.l.verma at linux.intel.com>

On Tue, 2013-05-14 at 15:00 -0600, Ross Zwisler wrote:
> Removed trailing whitespace, added info about IRC channel and removed
> obsolete comment about vm_flags field.
> 
> Signed-off-by: Ross Zwisler <ross.zwisler at linux.intel.com>
> ---
>  Documentation/filesystems/pmfs.txt |   15 +++++++--------
>  README.md                          |   17 ++++++++---------
>  2 files changed, 15 insertions(+), 17 deletions(-)
> 
> diff --git a/Documentation/filesystems/pmfs.txt b/Documentation/filesystems/pmfs.txt
> index fb1f9b3..4ee7a97 100644
> --- a/Documentation/filesystems/pmfs.txt
> +++ b/Documentation/filesystems/pmfs.txt
> @@ -47,12 +47,12 @@ options supported by pmfs. Some of the main options include:
>  wprotect: This option protects pmfs from stray writes (e.g., because of kernel
>  bugs). It makes sure that the file system is mapped read-only into the kernel
>  and makes it writable only for a brief period when writing to it. (EXPERIMENTAL
> -- Use with Caution).  
> +- Use with Caution).
>  
>  jsize: This option specifies the journal size. Default is 4MB.
>  
>  hugemmap: This option enables support for using huge pages in memory-mapped
> -files.  
> +files.
>  
>  backing: This option specifies a disk based file which should be used as a
>  persistent backing store for pmfs during mount and unmount.
> @@ -91,12 +91,12 @@ save the file system to /data/pmfs.img during unmount.
>  The above example assumes that there is a PMFS already present at the specified
>  physical address (create during an earlier mount). It uses that same PMFS
>  instead of loading it from /data/pmfs.img. It, however, saves the file system
> -to /data/pmfs.img during unmount. 
> +to /data/pmfs.img during unmount.
>  
> -For full list of options, please refer to the source code. 
> +For full list of options, please refer to the source code.
>  
> 
> -Using Huge Pages with PMFS 
> +Using Huge Pages with PMFS
>  ==========================
>  
>  PMFS supports the use of huge-pages through the fallocate(), and ftruncate()
> @@ -129,9 +129,6 @@ c) PMFS does not currently support extended attributes.
>  
>  d) PMFS currently only works with x86_64 kernels.
>  
> -e) We ran out of bits in vma's vm_flags field, so we reused a flag that is
> -guaranteed not to be used on x86_64.
> -
>  
>  Contributing
>  ============
> @@ -143,3 +140,5 @@ by sending an email with the Subject line 'subscribe' to
>  linux-pmfs-request at lists.infradead.org.
>  
>  We prefer pull requests as patches sent to the mailing list.
> +
> +Also feel free to join us on the IRC channel #pmfs on irc.oftc.net.
> diff --git a/README.md b/README.md
> index a45a68f..1a828e5 100644
> --- a/README.md
> +++ b/README.md
> @@ -47,12 +47,12 @@ options supported by pmfs. Some of the main options include:
>  wprotect: This option protects pmfs from stray writes (e.g., because of kernel
>  bugs). It makes sure that the file system is mapped read-only into the kernel
>  and makes it writable only for a brief period when writing to it. (EXPERIMENTAL,
> -Use with Caution).  
> +Use with Caution).
>  
>  jsize: This option specifies the journal size. Default is 4MB.
>  
>  hugemmap: This option enables support for using huge pages in memory-mapped
> -files.  
> +files.
>  
>  backing: This option specifies a disk based file which should be used as a
>  persistent backing store for pmfs during mount and unmount.
> @@ -91,12 +91,12 @@ save the file system to /data/pmfs.img during unmount.
>  The above example assumes that there is a PMFS already present at the specified
>  physical address (create during an earlier mount). It uses that same PMFS
>  instead of loading it from /data/pmfs.img. It, however, saves the file system
> -to /data/pmfs.img during unmount. 
> +to /data/pmfs.img during unmount.
>  
> -For full list of options, please refer to the source code. 
> +For full list of options, please refer to the source code.
>  
> 
> -Using Huge Pages with PMFS 
> +Using Huge Pages with PMFS
>  ==========================
>  
>  PMFS supports the use of huge-pages through the fallocate(), and ftruncate()
> @@ -129,9 +129,6 @@ blocksize is 1GB, the file can grow upto 128 PB.
>  
>  * PMFS currently only works with x86_64 kernels.
>  
> -* We ran out of bits in vma’s vm_flags field, so we reused a flag that is
> -guaranteed not to be used on x86_64.
> -
>  
>  Contributing
>  ============
> @@ -142,4 +139,6 @@ You are also encouraged to subscribe to the mailing list
>  by sending an email with the Subject line **subscribe** to
>  linux-pmfs-request at lists.infradead.org.
>  
> -We prefer pull requests as patches sent to the mailing list.
> \ No newline at end of file
> +We prefer pull requests as patches sent to the mailing list.
> +
> +Also feel free to join us on the IRC channel #pmfs on irc.oftc.net.