Skip to contentSkip to conversation

documentation: xip documentation update

PATCH RESEND Superseded Marco Stornelli 2 participants 3 messages Nov 6, 2008 Documentation

lore
Share & tools
lore

Marco Stornelli

author
#0 lore raw

PATCH RESEND 1/1 documentation: xip documentation update

From: Marco Stornelli <[email protected]>

xip documentation updated

Signed-off-by Marco Stornelli <[email protected]>

---

Documentation/filesystems/xip.txt renamed from Documentation/filesystems/xip.txt.orig +5 -4
@@ -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.
#1 lore raw

Marco,

A few comments below.

Quoted 9 lines · Marco Stornelli

From: Marco Stornelli <[email protected]>

xip documentation updated

Signed-off-by Marco Stornelli <[email protected]>

---

Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200 The block device operation is optional, · line 43

Quoted 9 lines
Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200 renamed from Documentation/filesystems/xip.txt.orig 2008-08-20 20:11:37.000000000 +0200 +1 -4
@@ -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/?

Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200 The block device operation is optional, · line 46

Quoted 3 lines
Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200 renamed from Documentation/filesystems/xip.txt.orig 2008-08-20 20:11:37.000000000 +0200 +3 -0
+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.)

Quoted 4 lines
Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200 renamed from Documentation/filesystems/xip.txt.orig 2008-08-20 20:11:37.000000000 +0200 +1 -0
+blocks if needed.
 
 This address space operation is mutually exclusive with readpage&writepage that

do page cache read/write operations.

Cheers,

Michael

Signature · 5 lines
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
author
#2 lore raw
Quoted 18 lines · Michael Kerrisk

Marco,

A few comments below.

Quoted 12 lines · Marco Stornelli

From: Marco Stornelli <[email protected]>

xip documentation updated

Signed-off-by Marco Stornelli <[email protected]>

---

Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200 renamed from Documentation/filesystems/xip.txt.orig 2008-08-20 20:11:37.000000000 +0200 +0 -0
@@ -39,10 +39,11 @@ The block device operation is optional,
 today:
 - dcssblk: s390 dcss block device driver
Quoted 8 lines

Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200 The block device operation is optional, · line 43

Quoted 6 lines
Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200 renamed from Documentation/filesystems/xip.txt.orig 2008-08-20 20:11:37.000000000 +0200 +1 -4
-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".

Quoted 8 lines

Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200 The block device operation is optional, · line 46

Quoted 4 lines
Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200 renamed from Documentation/filesystems/xip.txt.orig 2008-08-20 20:11:37.000000000 +0200 +3 -0
+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.

Quoted 10 lines
Quoted 5 lines
Documentation/filesystems/xip.txt 2008-11-06 12:47:48.000000000 +0200 renamed from Documentation/filesystems/xip.txt.orig 2008-08-20 20:11:37.000000000 +0200 +1 -0
+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.