diff options
| author | Pablo Galindo <Pablogsal@gmail.com> | 2018-10-20 00:37:55 (GMT) |
|---|---|---|
| committer | Victor Stinner <vstinner@redhat.com> | 2018-10-20 00:37:55 (GMT) |
| commit | 027664a3d5ebad575aafe5fcc572e3b05f7f24e5 (patch) | |
| tree | 57bc41cc6bdff3f9a66f6b7710250242dce471bf /Doc | |
| parent | 13ae4d44381a647aadd09b70b24833052659be41 (diff) | |
| download | cpython-027664a3d5ebad575aafe5fcc572e3b05f7f24e5.zip cpython-027664a3d5ebad575aafe5fcc572e3b05f7f24e5.tar.gz cpython-027664a3d5ebad575aafe5fcc572e3b05f7f24e5.tar.bz2 | |
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.
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/mmap.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/library/mmap.rst b/Doc/library/mmap.rst index c8ae7a6..0f895d7 100644 --- a/Doc/library/mmap.rst +++ b/Doc/library/mmap.rst @@ -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 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]) @@ -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 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 - ALLOCATIONGRANULARITY. + defaults to 0. *offset* must be a multiple of :const:`ALLOCATIONGRANULARITY` + which is equal to :const:`PAGESIZE` on Unix systems. To ensure validity of the created memory mapping the file specified 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 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 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 call failed. |