Re: Man page doc for SEEK_DATA/SEEK_HOLE

From: Sunil Mushran
Date: Tue Sep 20 2011 - 12:19:34 EST


On 09/19/2011 10:32 PM, Michael Kerrisk wrote:
Hi Sunil,

On Mon, Sep 19, 2011 at 8:04 PM, Sunil Mushran<sunil.mushran@xxxxxxxxxx> wrote:
On 09/18/2011 12:07 AM, Michael Kerrisk wrote:
Hello Josef,

For Linux 3.1, you've added SEEK_HOLE + SEEK_DATA. I've attempted to
document these as below for the lseek.2 man page. Could you please
review?

Thanks,

Michael


diff --git a/man2/lseek.2 b/man2/lseek.2
index 26943e2..941ea08 100644
--- a/man2/lseek.2
+++ b/man2/lseek.2
@@ -85,6 +85,69 @@ of the file (but this does not change the size of the
file).
If data is later written at this point, subsequent reads of the data
in the gap (a "hole") return null bytes (\(aq\\0\(aq) until
data is actually written into the gap.
+.SS Seeking file data and holes
+Since version 3.1, Linux supports the following additional values for
+.IR whence :
+.TP
+.B SEEK_DATA
+Adjust the file offset to the next region
+in the file greater than or equal to
+.I offset
I would recommend dropping the word next as it is confusing considering the
offset returned could be the offset passed in.
I changed "region" to "location", but otherwise left this unchanged. I
couldn't see a good alternative formulation, and also the next
sentence of the page makes your point clear.

Fine by me.
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/