LDP: Update original to LDP v3.68

[linuxjm/LDP_man-pages.git] / original / man2 / posix_fadvise.2

diff --git a/original/man2/posix_fadvise.2 b/original/man2/posix_fadvise.2
index 740e691..b918f45 100644 (file)
--- a/original/man2/posix_fadvise.2
+++ b/original/man2/posix_fadvise.2
@@ -1,6 +1,6 @@
-.\" Hey Emacs! This file is -*- nroff -*- source.
-.\"
 .\" Copyright 2003 Abhijit Menon-Sen <ams@wiw.org>
+.\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
 .\" preserved on all copies.
@@ -20,11 +20,12 @@
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
 .\" 2005-04-08 mtk, noted kernel version and added BUGS
 .\" 2010-10-09, mtk, document arm_fadvise64_64()
 .\"
-.TH POSIX_FADVISE 2 2010-10-09 "Linux" "Linux Programmer's Manual"
+.TH POSIX_FADVISE 2 2014-05-03 "Linux" "Linux Programmer's Manual"
 .SH NAME
 posix_fadvise \- predeclare an access pattern for file data
 .SH SYNOPSIS
@@ -83,7 +84,7 @@ The specified data will be accessed in the near future.
 .TP
 .B POSIX_FADV_DONTNEED
 The specified data will not be accessed in the near future.
-.SH "RETURN VALUE"
+.SH RETURN VALUE
 On success, zero is returned.
 On error, an error number is returned.
 .SH ERRORS
@@ -108,7 +109,7 @@ the underlying system call is called
 Library support has been provided since glibc version 2.2,
 via the wrapper function
 .BR posix_fadvise ().
-.SH "CONFORMING TO"
+.SH CONFORMING TO
 POSIX.1-2001.
 Note that the type of the
 .I len
@@ -150,18 +151,25 @@ call
 or
 .BR fdatasync (2)
 first.
-.SS arm_fadvise()
-The ARM architecture
-needs 64-bit arguments to be aligned in a suitable pair of registers.
-On this architecture, the call signature of
+.SS Architecture-specific variants
+Some architectures require
+64-bit arguments to be aligned in a suitable pair of registers (see
+.BR syscall (2)
+for further detail).
+On such architectures, the call signature of
 .BR posix_fadvise ()
-is flawed, since it forces a register to be wasted as padding between the
+shown in the SYNOPSIS would force
+a register to be wasted as padding between the
 .I fd
 and
-.I len
+.I offset
 arguments.
-Therefore, since Linux 2.6.14, ARM defines a different
-system call that orders the arguments suitably:
+Therefore, these architectures define a version of the
+system call that orders the arguments suitably,
+but otherwise is otherwise exactly the same as
+.BR posix_fadvise ().
+
+For example, since Linux 2.6.14, ARM has the following system call:
 .PP
 .in +4n
 .nf
@@ -170,18 +178,28 @@ system call that orders the arguments suitably:
 .fi
 .in
 .PP
-The behavior of this system call is otherwise exactly the same as
-.BR posix_fadvise ().
-No library support is provided for this system call in glibc.
-.\" No ARM support in glibc.
+These architecture-specific details are generally
+hidden from applications by the glibc
+.BR posix_fadvise ()
+wrapper function,
+which invokes the appropriate architecture-specific system call.
 .SH BUGS
 In kernels before 2.6.6, if
 .I len
 was specified as 0, then this was interpreted literally as "zero bytes",
 rather than as meaning "all bytes through to the end of the file".
-.SH "SEE ALSO"
+.SH SEE ALSO
 .BR readahead (2),
 .BR sync_file_range (2),
 .BR posix_fallocate (3),
 .BR posix_madvise (3)
 .\" FIXME . Write a posix_fadvise(3) page.
+.SH COLOPHON
+This page is part of release 3.68 of the Linux
+.I man-pages
+project.
+A description of the project,
+information about reporting bugs,
+and the latest version of this page,
+can be found at
+\%http://www.kernel.org/doc/man\-pages/.