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

bpo-35924: Document a workaround for a curses bug #13209

Merged
merged 1 commit into from May 17, 2019

Conversation

abadger
Copy link
Contributor

@abadger abadger commented May 8, 2019

The ncurses library has a bug which can provoke a segfault when a window
is resized. The bug is provoked when a string with embedded newlines is
added via addstr(). This commit documents that problem in the curses
python library documentation and relates how to workaround the problem
in the calling code.

It will likely be years before every vendor upgrades their ncurses library even once upstream fixes the bug so it seems like a good idea to document the issue and a workaround.

Related to https://bugs.python.org/issue35924

Note that merging this change should not close the bug report as it only documents a workaround.

https://bugs.python.org/issue35924

The ncurses library has a bug which can provoke a segfault when a window
is resized.  The bug is provoked when a string with embedded newlines is
added via addstr().  This commit documents that problem in the curses
python library documentation and relates how to workaround the problem
in the calling code.

Related to https://bugs.python.org/issue35924
@abadger
Copy link
Contributor Author

abadger commented May 13, 2019

The bug has now been fixed in upstream ncurses. I think merging this documentation change would be sufficient to close the bug on our side.

Copy link
Contributor

@lisroach lisroach left a comment

Choose a reason for hiding this comment

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

Thanks for all the work you did for this!

@lisroach lisroach merged commit e7b1136 into python:master May 17, 2019
@abadger abadger deleted the hint-on-curses-bug branch May 18, 2019 03:13
@abadger
Copy link
Contributor Author

abadger commented May 18, 2019

I'm just happy to help :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants