traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

bpo-32798: Add restriction on the offset parameter for mmap.flush in the docs (GH-5621) 

Add restriction on the offset parameter for mmap.flush.

Explain that ALLOCATIONGRANULARITY is the same as PAGESIZE in Unix.
(cherry picked from commit 027664a3d5)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
This commit is contained in:
Miss Islington (bot) 2018-10-19 17:49:37 -07:00 committed by GitHub
parent b0f7fa1dda
commit 2bad7acdfe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Doc/library/mmap.rst
View File

@ -68,7 +68,7 @@ memory but does not update the underlying file.
*offset* may be specified as a non-negative integer offset. mmap references *offset* may be specified as a non-negative integer offset. mmap references
will be relative to the offset from the beginning of the file. *offset* will be relative to the offset from the beginning of the file. *offset*
defaults to 0. *offset* must be a multiple of the ALLOCATIONGRANULARITY. defaults to 0. *offset* must be a multiple of the :const:`ALLOCATIONGRANULARITY`.
.. class:: mmap(fileno, length[, flags[, prot[, access[, offset]]]]) .. class:: mmap(fileno, length[, flags[, prot[, access[, offset]]]])
@ -97,8 +97,8 @@ memory but does not update the underlying file.
*offset* may be specified as a non-negative integer offset. mmap references *offset* may be specified as a non-negative integer offset. mmap references
will be relative to the offset from the beginning of the file. *offset* will be relative to the offset from the beginning of the file. *offset*
defaults to 0. *offset* must be a multiple of the PAGESIZE or defaults to 0. *offset* must be a multiple of :const:`ALLOCATIONGRANULARITY`
ALLOCATIONGRANULARITY. which is equal to :const:`PAGESIZE` on Unix systems.
To ensure validity of the created memory mapping the file specified To ensure validity of the created memory mapping the file specified
by the descriptor *fileno* is internally automatically synchronized by the descriptor *fileno* is internally automatically synchronized
@ -171,7 +171,8 @@ memory but does not update the underlying file.
use of this call there is no guarantee that changes are written back before use of this call there is no guarantee that changes are written back before
the object is destroyed. If *offset* and *size* are specified, only the object is destroyed. If *offset* and *size* are specified, only
changes to the given range of bytes will be flushed to disk; otherwise, the changes to the given range of bytes will be flushed to disk; otherwise, the
whole extent of the mapping is flushed. whole extent of the mapping is flushed. *offset* must be a multiple of the
:const:`PAGESIZE` or :const:`ALLOCATIONGRANULARITY`.
**(Windows version)** A nonzero value returned indicates success; zero **(Windows version)** A nonzero value returned indicates success; zero
indicates failure. indicates failure.