[PATCH] [RESEND] documentation: xip documentation update

[PATCH] [RESEND] documentation: xip documentation update

[Marco Stornelli]

From: Marco Stornelli <marco.stornelli@gmail.com>

xip documentation updated
Signed-off-by: Marco Stornelli <marco.stornelli@gmail.com>
---

--- a/Documentation/filesystems/xip.txt.orig	2008-08-20 20:11:37.000000000 +0200
+++ b/Documentation/filesystems/xip.txt	2008-11-06 12:47:48.000000000 +0200
@@ -39,10 +39,11 @@ The block device operation is optional,
 today:
 - dcssblk: s390 dcss block device driver
 
-An address space operation named get_xip_page is used to retrieve reference
-to a struct page. To address the target page, a reference to an address_space,
-and a sector number is provided. A 3rd argument indicates whether the
-function should allocate blocks if needed.
+An address space operation named get_xip_mem is used to retrieve reference
+to a page frame number and a kernel address. To obtain these values a reference
+to an address_space is provided. This function assigns values to the kmem and
+pfn parameters. The 3rd argument indicates whether the function should allocate
+blocks if needed.
 
 This address space operation is mutually exclusive with readpage&writepage that
 do page cache read/write operations.

Re: [PATCH] [RESEND] documentation: xip documentation update

[Michael Kerrisk]

Marco,

A few comments below.

On Thu, Nov 6, 2008 at 10:33 AM, Marco Stornelli
<marco.stornelli@coritel.it> wrote:
> From: Marco Stornelli <marco.stornelli@gmail.com>
>
> xip documentation updated
> Signed-off-by: Marco Stornelli <marco.stornelli@gmail.com>
> ---
>
> --- a/Documentation/filesystems/xip.txt.orig    2008-08-20 20:11:37.000000000 +0200
> +++ b/Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200
> @@ -39,10 +39,11 @@ The block device operation is optional,
>  today:
>  - dcssblk: s390 dcss block device driver
>
> -An address space operation named get_xip_page is used to retrieve reference
> -to a struct page. To address the target page, a reference to an address_space,
> -and a sector number is provided. A 3rd argument indicates whether the

> -function should allocate blocks if needed.
> +An address space operation named get_xip_mem is used to retrieve reference

s/reference/a reference/?

> +to a page frame number and a kernel address. To obtain these values a reference
> +to an address_space is provided. This function assigns values to the kmem and
> +pfn parameters. The 3rd argument indicates whether the function should allocate

It's a taste thing, but I would write "third" not "3rd".  (I
appreciate that the existing text already used "3rd", but maybe that
should be fixed.)

> +blocks if needed.
>
>  This address space operation is mutually exclusive with readpage&writepage that
>  do page cache read/write operations.

Cheers,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
git://git.kernel.org/pub/scm/docs/man-pages/man-pages.git
man-pages online: http://www.kernel.org/doc/man-pages/online_pages.html
Found a bug? http://www.kernel.org/doc/man-pages/reporting_bugs.html

Re: [PATCH] [RESEND] documentation: xip documentation update

[Marco Stornelli]

Michael Kerrisk wrote:
> Marco,
> 
> A few comments below.
> 
> On Thu, Nov 6, 2008 at 10:33 AM, Marco Stornelli
> <marco.stornelli@coritel.it> wrote:
>> From: Marco Stornelli <marco.stornelli@gmail.com>
>>
>> xip documentation updated
>> Signed-off-by: Marco Stornelli <marco.stornelli@gmail.com>
>> ---
>>
>> --- a/Documentation/filesystems/xip.txt.orig    2008-08-20 20:11:37.000000000 +0200
>> +++ b/Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200
>> @@ -39,10 +39,11 @@ The block device operation is optional,
>>  today:
>>  - dcssblk: s390 dcss block device driver
>>
>> -An address space operation named get_xip_page is used to retrieve reference
>> -to a struct page. To address the target page, a reference to an address_space,
>> -and a sector number is provided. A 3rd argument indicates whether the
> 
>> -function should allocate blocks if needed.
>> +An address space operation named get_xip_mem is used to retrieve reference
> 
> s/reference/a reference/?

Ok, it should actually be "references".

> 
>> +to a page frame number and a kernel address. To obtain these values a reference
>> +to an address_space is provided. This function assigns values to the kmem and
>> +pfn parameters. The 3rd argument indicates whether the function should allocate
> 
> It's a taste thing, but I would write "third" not "3rd".  (I
> appreciate that the existing text already used "3rd", but maybe that
> should be fixed.)

Ok.

> 
>> +blocks if needed.
>>
>>  This address space operation is mutually exclusive with readpage&writepage that
>>  do page cache read/write operations.
> 
> Cheers,
> 
> Michael
> 


I wait for other comments before re-send the patch.

[PATCH] [RESEND] documentation: xip documentation update

[Marco Stornelli]

From: Marco Stornelli <marco.stornelli@gmail.com>

xip documentation updated
Signed-off-by: Marco Stornelli <marco.stornelli@gmail.com>
---

--- a/Documentation/filesystems/xip.txt.orig	2008-08-20 20:11:37.000000000 +0200
+++ b/Documentation/filesystems/xip.txt	2008-11-06 12:47:48.000000000 +0200
@@ -39,10 +39,11 @@ The block device operation is optional,
 today:
 - dcssblk: s390 dcss block device driver
 
-An address space operation named get_xip_page is used to retrieve reference
-to a struct page. To address the target page, a reference to an address_space,
-and a sector number is provided. A 3rd argument indicates whether the
-function should allocate blocks if needed.
+An address space operation named get_xip_mem is used to retrieve references
+to a page frame number and a kernel address. To obtain these values a reference
+to an address_space is provided. This function assigns values to the kmem and
+pfn parameters. The third argument indicates whether the function should allocate
+blocks if needed.
 
 This address space operation is mutually exclusive with readpage&writepage that
 do page cache read/write operations.