Re: [PATCH] documentation: xip documentation update

[Marco Stornelli <marco.stornelli@coritel.it>]

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

Fix xip documentation with the comments of Randy Dunlap.
Signed-off-by: Marco Stornelli <marco.stornelli@gmail.com>
---

--- linux-2.6.26.3/Documentation/filesystems/xip.txt.orig	2008-08-20 20:11:37.000000000 +0200
+++ linux-2.6.26.3/Documentation/filesystems/xip.txt	2008-09-23 13:45:42.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.



Randy Dunlap ha scritto:
> On Mon, 22 Sep 2008 11:37:52 +0200 Marco Stornelli wrote:
> 
>> From: Marco Stornelli <marco.stornelli@gmail.com>
>>
>> xip documentation updated
>> Signed-off-by: Marco Stornelli <marco.stornelli@gmail.com>
>> ---
>>
>> --- linux-2.6.26.5/Documentation/filesystems/xip.txt.orig	2008-08-20 20:11:37.000000000 +0200
>> +++ linux-2.6.26.5/Documentation/filesystems/xip.txt	2008-09-22 11:27:46.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 is in charge to assign values to
> 
> How about:
>                                     This function assigns values to the kmem and
>    pfn parameters.
> 
>> +the pointers kmem and pfn. 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.
> 
> 
> Thanks.
> 
> ---
> ~Randy
>