Commit 027664a3 authored by Pablo Galindo's avatar Pablo Galindo Committed by Victor Stinner

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

Add restriction on the offset parameter for mmap.flush.

Explain that ALLOCATIONGRANULARITY is the same as PAGESIZE in Unix.
parent 13ae4d44
...@@ -65,7 +65,7 @@ To map anonymous memory, -1 should be passed as the fileno along with the length ...@@ -65,7 +65,7 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
*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=MAP_SHARED, prot=PROT_WRITE|PROT_READ, access=ACCESS_DEFAULT[, offset]) .. class:: mmap(fileno, length, flags=MAP_SHARED, prot=PROT_WRITE|PROT_READ, access=ACCESS_DEFAULT[, offset])
...@@ -94,8 +94,8 @@ To map anonymous memory, -1 should be passed as the fileno along with the length ...@@ -94,8 +94,8 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
*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
...@@ -189,7 +189,8 @@ To map anonymous memory, -1 should be passed as the fileno along with the length ...@@ -189,7 +189,8 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
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`.
``None`` is returned to indicate success. An exception is raised when the ``None`` is returned to indicate success. An exception is raised when the
call failed. call failed.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment