Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vstinner merged 5 commits into from
Oct 20, 2018
Merged

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

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a478cb0
Add restriction on the offset parameter for mmap.flush
pablogsal Feb 11, 2018
8a65d8a
Correct style
pablogsal Feb 12, 2018
2d90d92
fixup! Correct style
pablogsal Aug 22, 2018
f334ea4
Add formatting for ALLOCATIONGRANULARITY occurrences
pablogsal Aug 24, 2018
39488c5
Explain that ALLOCATIONGRANULARITY is the same as PAGESIZE in Unix
pablogsal Aug 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions Doc/library/mmap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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])
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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`.
Copy link
Member

@serhiy-storchaka serhiy-storchaka Mar 28, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update also the formatting of other mention of these constants.


**(Windows version)** A nonzero value returned indicates success; zero
indicates failure.
Expand Down