prctl.2: ffix

[thirdparty/man-pages.git] / man2 / alloc_hugepages.2

diff --git a/man2/alloc_hugepages.2 b/man2/alloc_hugepages.2
index 9b7930a4830cb171b1805aaecdd707ca54a5ce37..0a341bf353e9d607f7247e579af14f8662a5a374 100644 (file)
--- a/man2/alloc_hugepages.2
+++ b/man2/alloc_hugepages.2
@@ -1,7 +1,6 @@
-.\" Hey Emacs! This file is -*- nroff -*- source.
-.\"
 .\" Copyright 2003 Andries E. Brouwer (aeb@cwi.nl)
 .\"
+.\" %%%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.
@@ -21,8 +20,9 @@
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
-.TH ALLOC_HUGEPAGES 2 2007-05-31 "Linux" "Linux Programmer's Manual"
+.TH ALLOC_HUGEPAGES 2 2017-09-15 "Linux" "Linux Programmer's Manual"
 .SH NAME
 alloc_hugepages, free_hugepages \- allocate or free huge pages
 .SH SYNOPSIS
@@ -31,7 +31,7 @@ alloc_hugepages, free_hugepages \- allocate or free huge pages
 .BI "                      int " prot ", int " flag );
 .\" asmlinkage unsigned long sys_alloc_hugepages(int key, unsigned long addr,
 .\" unsigned long len, int prot, int flag);
-.sp
+.PP
 .BI "int free_hugepages(void *" addr );
 .\" asmlinkage int sys_free_hugepages(unsigned long addr);
 .fi
@@ -43,30 +43,30 @@ and
 were introduced in Linux 2.5.36 and removed again in 2.5.54.
 They existed only on i386 and ia64 (when built with
 .BR CONFIG_HUGETLB_PAGE ).
-In Linux 2.4.20 the syscall numbers exist,
+In Linux 2.4.20, the syscall numbers exist,
 but the calls fail with the error
 .BR ENOSYS .
-.LP
-On i386 the memory management hardware knows about ordinary pages (4 KiB)
-and huge pages (2 or 4 MiB).
+.PP
+On i386 the memory management hardware knows about ordinary pages (4\ KiB)
+and huge pages (2 or 4\ MiB).
 Similarly ia64 knows about huge pages of
 several sizes.
 These system calls serve to map huge pages into the
 process's memory or to free them again.
 Huge pages are locked into memory, and are not swapped.
-.LP
+.PP
 The
 .I key
-parameter is an identifier.
+argument is an identifier.
 When zero the pages are private, and
 not inherited by children.
 When positive the pages are shared with other applications using the same
 .IR key ,
 and inherited by child processes.
-.LP
+.PP
 The
 .I addr
-parameter of
+argument of
 .BR free_hugepages ()
 tells which page is being freed: it was the return value of a
 call to
@@ -74,27 +74,27 @@ call to
 (The memory is first actually freed when all users have released it.)
 The
 .I addr
-parameter of
+argument of
 .BR alloc_hugepages ()
 is a hint, that the kernel may or may not follow.
 Addresses must be properly aligned.
-.LP
+.PP
 The
 .I len
-parameter is the length of the required segment.
+argument is the length of the required segment.
 It must be a multiple of the huge page size.
-.LP
+.PP
 The
 .I prot
-parameter specifies the memory protection of the segment.
+argument specifies the memory protection of the segment.
 It is one of
 .BR PROT_READ ,
 .BR PROT_WRITE ,
 .BR PROT_EXEC .
-.LP
+.PP
 The
 .I flag
-parameter is ignored, unless
+argument is ignored, unless
 .I key
 is positive.
 In that case, if
@@ -106,8 +106,7 @@ with the given key existed.
 If this flag is not set, then
 .B ENOENT
 is returned when no segment with the given key exists.
-.IR
-.SH "RETURN VALUE"
+.SH RETURN VALUE
 On success,
 .BR alloc_hugepages ()
 returns the allocated virtual address, and
@@ -121,29 +120,30 @@ is set appropriately.
 .B ENOSYS
 The system call is not supported on this kernel.
 .SH FILES
+.TP
 .I /proc/sys/vm/nr_hugepages
 Number of configured hugetlb pages.
 This can be read and written.
-.LP
+.TP
 .I /proc/meminfo
 Gives info on the number of configured hugetlb pages and on their size
 in the three variables HugePages_Total, HugePages_Free, Hugepagesize.
-.SH "CONFORMING TO"
+.SH CONFORMING TO
 These calls are specific to Linux on Intel processors, and should not be
 used in programs intended to be portable.
 .SH NOTES
 These system calls are gone;
 they existed only in Linux 2.5.36 through to 2.5.54.
-Now the hugetlbfs file system can be used instead.
+Now the hugetlbfs filesystem can be used instead.
 Memory backed by huge pages (if the CPU supports them) is obtained by
 using
 .BR mmap (2)
-to map files in this virtual file system.
-.LP
+to map files in this virtual filesystem.
+.PP
 The maximal number of huge pages can be specified using the
 .B hugepages=
 boot parameter.
-
+.PP
 .\" requires CONFIG_HUGETLB_PAGE (under "Processor type and features")
 .\" and CONFIG_HUGETLBFS (under "Filesystems").
 .\" mount -t hugetlbfs hugetlbfs /huge