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.

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

Jump to bottom

Document and test new socket options #57465

Closed
vstinner opened this issue Oct 24, 2011 · 4 comments
Closed

Document and test new socket options #57465

vstinner opened this issue Oct 24, 2011 · 4 comments
Labels
docs Documentation in the Doc dir tests Tests in the Lib/test dir

Comments

@vstinner
Copy link
Member

BPO 13256
Nosy @vstinner
Files
  • socket_options_doc.patch
    		•

    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-01-03.02:52:18.356>
created_at = <Date 2011-10-24.11:46:15.242>
labels = ['tests', 'docs']
title = 'Document and test new socket options'
updated_at = <Date 2013-01-03.02:52:18.355>
user = 'https://github.com/vstinner'

    bugs.python.org fields:

    activity = <Date 2013-01-03.02:52:18.355>
actor = 'vstinner'
assignee = 'docs@python'
closed = True
closed_date = <Date 2013-01-03.02:52:18.356>
closer = 'vstinner'
components = ['Documentation', 'Tests']
creation = <Date 2011-10-24.11:46:15.242>
creator = 'vstinner'
dependencies = []
files = ['23516']
hgrepos = []
issue_num = 13256
keywords = ['patch']
message_count = 4.0
messages = ['146294', '146295', '146361', '178908']
nosy_count = 2.0
nosy_names = ['vstinner', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = 'wont fix'
stage = 'needs patch'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue13256'
versions = ['Python 3.3']
    @vstinner
    Copy link
    Member Author

    The commit c64216addd7f for issue bpo-6560 added various socket option, but some of them are not well documented or tested.

    Authentication:

    • SO_PASSCRED, SO_PEERCRED, LOCAL_PEERCRED
    • SCM_RIGHTS, SCM_CREDENTIALS, SCM_CREDS

    SCTP:

    • socket.IPPROTO_SCTP is not mentioned in socket.socket() doc (but it's tested)

    etc.

    @vstinner
    Copy link
    Member Author

    Another issue: the "version added" tag is not used, it's not possible to know that socket.SO_PEERCRED was added in Python 3.3.

    @pitrou pitrou added docs Documentation in the Doc dir tests Tests in the Lib/test dir labels Oct 24, 2011
    @vstinner
    Copy link
    Member Author

    For bpo-12619, I added socket.SO_BINDTODEVICE constant.

    @vstinner
    Copy link
    Member Author

    vstinner commented Jan 3, 2013

    I created this issue for myself (as a reminder), but sorry I'm not really motivated to work on the documentation, nor test. Document socket options is not trivial because the exact definition depends on the platform.

    I close the issue.

    @vstinner vstinner closed this as completed Jan 3, 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 tests Tests in the Lib/test dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @vstinner @pitrou