classification
Title: doc: termios and ioctl reference links
Type: Stage:
Components: Documentation Versions: Python 2.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, georg.brandl, techtonik
Priority: normal Keywords: patch

Created on 2010-04-24 16:09 by techtonik, last changed 2010-10-29 10:07 by admin.

Files
File name Uploaded Description Edit
____.reference-termios-specification-for-flags.diff techtonik, 2010-04-24 16:09 review
8519.reference-termios-specification-for-flags.diff techtonik, 2010-04-24 16:42 review
Messages (6)
msg104094 - (view) Author: anatoly techtonik (techtonik) Date: 2010-04-24 16:09
The patch adds link to reference with various flags for termios functions and fcntl.ioctl call.
msg104095 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-04-24 16:14
Note that there can be any whitespace in reST markup, e.g. you can put a newline betweeen “`thing” and “<link>`_”, thus avoiding too long lines. I think you can put a newline in a “<link>” too, they will be removed.

Regards
msg104096 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-04-24 16:29
The POSIX reference is OK; I'm hesitant to put a Linux-specific reference in though.  Also, ioctls are not limited to tty operations.  IMO a :manpage:`ioctl(2)` would suffice.
msg104098 - (view) Author: anatoly techtonik (techtonik) Date: 2010-04-24 16:42
Éric, thanks, attached reStructured patch.

Georg, ioctl(2) is useless, because it doesn't contain the information people need in addition to Python manual, i.e. various examples (like how to get console size) and constants (like TIOCGWINSZ) that are hard to find otherwise.
msg104100 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-04-24 16:57
ioctl(2) usually has "see also" entries that list the available ioctls, such as ioctl_list on linux.

If you want to link to examples like getting console size, the manpage isn't very helpful either, since you have to figure out how exactly to call ioctl.  Linking to a pertinent recipe e.g. in the Cookbook, or including the example right there makes much more sense.
msg104106 - (view) Author: anatoly techtonik (techtonik) Date: 2010-04-24 17:22
I do not mind if you include a better link with ioctl constants explained or have ideas for examples. I hope you agree the ioctl(2) man page contains much less useful information than http://www.kernel.org/doc/man-pages/online/pages/man4/tty_ioctl.4.html

But I see your point that ioctl is not used solely for tty. Perhaps there could be two links. Removing tty_ioctl constants reference is not an option for me, because the whole stuff is complicated and for me it was very hard to find these console functions for Linux. There is no other way to work with Linux console from Python.
History
Date User Action Args
2010-10-29 10:07:21adminsetassignee: georg.brandl -> docs@python
2010-06-07 00:39:43brian.curtinsettitle: [patch] doc: termios and ioctl reference links -> doc: termios and ioctl reference links
2010-06-05 16:04:10techtoniksetnosy: + docs@python
2010-04-24 17:22:20techtoniksetmessages: + msg104106
2010-04-24 16:57:16georg.brandlsetmessages: + msg104100
2010-04-24 16:42:37techtoniksetfiles: + 8519.reference-termios-specification-for-flags.diff

messages: + msg104098
2010-04-24 16:29:57georg.brandlsetmessages: + msg104096
2010-04-24 16:14:28eric.araujosetnosy: + eric.araujo
messages: + msg104095
2010-04-24 16:09:49techtonikcreate