Mark and document pty::ptsname() as unsafe #744
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Looks good, but please add a CHANGELOG entry, too. Also, you should update the commit message. |
|
Would thread local be global? |
nelsonjchen
added a commit
to nelsonjchen/nix
that referenced
this pull request
Aug 24, 2017
nelsonjchen
force-pushed
the
mark_unsafe_ptsname
branch
from
f38a15a
to
373fa36
Compare
nelsonjchen
added a commit
to nelsonjchen/nix
that referenced
this pull request
Aug 24, 2017
|
Ah, it would be. Let me update the commit message. |
nelsonjchen
force-pushed
the
mark_unsafe_ptsname
branch
from
373fa36
to
c02eda1
Compare
|
As far as Rust is concerned a thread-local global variable is still a global variable. Using a thread-local variable does not make |
asomers
requested changes
Aug 24, 2017
CHANGELOG.md
Outdated
| @@ -45,6 +45,8 @@ This project adheres to [Semantic Versioning](http://semver.org/). | |||
| - `MapFlags`, `MmapAdvise`, and `MsFlags` expose some more variants and only | |||
| officially-supported variants are provided for each target. | |||
| ([#731](https://github.com/nix-rust/nix/pull/731)) | |||
| - Marked `pty::ptsname` function to be as `unsafe` | |||
src/pty.rs
Outdated
| /// | ||
| /// This value is useful for opening the slave pty once the master has already been opened with | ||
| /// `posix_openpt()`. | ||
| /// | ||
| /// On some platforms, `ptsname()` mutates global variables and is *not* threadsafe. |
nelsonjchen
force-pushed
the
mark_unsafe_ptsname
branch
from
c02eda1
to
f9b16a3
Compare
|
@asomers Changes are done. |
Susurrus
suggested changes
Aug 24, 2017
src/pty.rs
Outdated
| /// | ||
| /// This value is useful for opening the slave pty once the master has already been opened with | ||
| /// `posix_openpt()`. | ||
| /// | ||
| /// `ptsname()` mutates global variables and is *not* threadsafe. |
There was a problem hiding this comment.
This should go in a section named "Safety". See here for details.
There was a problem hiding this comment.
Ah, that certainly wasn't in my original reading of the Book. I've added that. 👍
`ptsname()` mutates global variables and mutating global variables is always considered `unsafe` by Rust. Reference: nix-rust#742 (comment)
nelsonjchen
force-pushed
the
mark_unsafe_ptsname
branch
from
f9b16a3
to
505bed3
Compare
|
@Susurrus Changes are done |
Susurrus
approved these changes
Aug 25, 2017
|
@asomers Are you okay to sign off on this? LGTM! |
asomers
approved these changes
Aug 25, 2017
|
bors r+ |
bors bot
added a commit
that referenced
this pull request
Aug 25, 2017
744: Mark and document pty::ptsname() as unsafe r=asomers a=nelsonjchen On some platforms, `ptsname()` mutates global variables and mutating global variables is always considered `unsafe` by Rust. Reference: #742 (comment)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
On some platforms,
ptsname()mutates global variables and mutatingglobal variables is always considered
unsafeby Rust.Reference:
#742 (comment)