Skip to content
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.

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

Jump to bottom

fix os.sendfile() documentation regarding the type of file descriptor #61731

Closed
neologix mannequin opened this issue Mar 23, 2013 · 3 comments
Closed

fix os.sendfile() documentation regarding the type of file descriptor #61731

neologix mannequin opened this issue Mar 23, 2013 · 3 comments
Labels
docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@neologix
Copy link
Mannequin

neologix mannequin commented Mar 23, 2013

BPO 17529
Nosy @pitrou
Files
  • sendfile_doc.diff
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2013-05-01.13:17:36.381>
created_at = <Date 2013-03-23.12:14:47.641>
labels = ['type-bug', 'docs']
title = 'fix os.sendfile() documentation regarding the type of file descriptor'
updated_at = <Date 2013-05-01.13:17:36.381>
user = 'https://bugs.python.org/neologix'

    bugs.python.org fields:

    activity = <Date 2013-05-01.13:17:36.381>
actor = 'neologix'
assignee = 'docs@python'
closed = True
closed_date = <Date 2013-05-01.13:17:36.381>
closer = 'neologix'
components = ['Documentation']
creation = <Date 2013-03-23.12:14:47.641>
creator = 'neologix'
dependencies = []
files = ['29561']
hgrepos = []
issue_num = 17529
keywords = ['patch']
message_count = 3.0
messages = ['185040', '185045', '188221']
nosy_count = 4.0
nosy_names = ['pitrou', 'neologix', 'docs@python', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue17529'
versions = ['Python 3.3', 'Python 3.4']
    @neologix
    Copy link
    Mannequin Author

    neologix mannequin commented Mar 23, 2013

    os.sendfile() documentation states:
    """
    On Solaris, out may be the file descriptor of a regular file or the file descriptor of a socket. On all other platforms, out must be the file descriptor of an open socket.
    """

    This isn't true for Linux anymore (changed somewhere around 2.6.33), so it would probably be better to rephrase to something like "all platforms support sockets as out file descriptor, and some platforms allow other types (e.g. regular files) as well".

    @neologix neologix mannequin assigned docspython Mar 23, 2013
    @neologix neologix mannequin added docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error labels Mar 23, 2013
    @neologix neologix mannequin changed the title fix os.senfile() documentation regarding the type of file descriptor fix os.sendfile() documentation regarding the type of file descriptor Mar 23, 2013
    @pitrou
    Copy link
    Member

    pitrou commented Mar 23, 2013

    Sounds good to me.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented May 1, 2013

    New changeset 4f45f9cde9b4 by Charles-Francois Natali in branch '3.3':
    Issue bpo-17529: Fix os.sendfile() documentation regarding the type of file
    http://hg.python.org/cpython/rev/4f45f9cde9b4

    New changeset 538055b28ba6 by Charles-Francois Natali in branch 'default':
    Issue bpo-17529: Fix os.sendfile() documentation regarding the type of file
    http://hg.python.org/cpython/rev/538055b28ba6

    @neologix neologix mannequin closed this as completed May 1, 2013
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    1 participant
    @pitrou