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 aliases for functions like getuid() #1693

Merged
merged 1 commit into from
Jun 27, 2022
Merged

Document aliases for functions like getuid() #1693

merged 1 commit into from
Jun 27, 2022

Conversation

rtzoeller
Copy link
Collaborator

@rtzoeller rtzoeller commented Apr 8, 2022 •
edited
Loading

Add the autocfg crate as a build dependency, and introduce has_doc_alias as a conditional compilation symbol.

Closes #1673.

@rtzoeller
Copy link
Collaborator Author

@asomers I'm not sure it's worth adding autocfg just for this, but I think it's a potential option for addressing some of the MSRV-related TODOs without actually bumping the MSRV. Thoughts?

@asomers
Copy link
Member

asomers commented Apr 8, 2022

I guess it would work, but I'm not sure that it's worth the effort. Are any of those MSRV TODOs really very important?

@rtzoeller
Copy link
Collaborator Author

I don't think any are particularly critical - I came across this while revisiting trying to make ipv4addr_to_libc const.

#1673 is essentially the same to do with and without the MSRV check (and you can subsequently clean it up with a regex), so the marginal cost to do it now is low.

@rtzoeller rtzoeller force-pushed the autocfg branch 2 times, most recently from bc0a72c to 4282918 Compare June 1, 2022 01:24
@rtzoeller rtzoeller changed the title WIP: Document aliases for functions like getuid() Document aliases for functions like getuid() Jun 1, 2022
@rtzoeller rtzoeller marked this pull request as ready for review June 1, 2022 01:41
@rtzoeller rtzoeller requested a review from asomers June 19, 2022 01:36
asomers
asomers approved these changes Jun 24, 2022
View reviewed changes
Copy link
Member

@asomers asomers left a comment

Choose a reason for hiding this comment

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

LGTM.

bors r+

bors bot added a commit that referenced this pull request Jun 24, 2022
@bors @rtzoeller
Merge #1693
08110dc 
1693: Document aliases for functions like getuid() r=asomers a=rtzoeller

Add the autocfg crate as a build dependency, and introduce `has_doc_alias` as a conditional compilation symbol.

Closes #1673.

Co-authored-by: Ryan Zoeller <rtzoeller@rtzoeller.com>
@bors
Copy link
Contributor

bors bot commented Jun 24, 2022

Build failed:

@rtzoeller
Copy link
Collaborator Author

I'll fix the cross issues that are popping up.

@rtzoeller
Document aliases for functions like getuid()
1fa1bb1 
Add the autocfg crate as a build dependency, and introduce
has_doc_alias as a conditional compilation symbol.
@rtzoeller
Copy link
Collaborator Author

bors r=asomers

@bors
Copy link
Contributor

bors bot commented Jun 27, 2022

Build succeeded:

@bors bors bot merged commit 0922fd9 into nix-rust:master Jun 27, 2022
@rtzoeller rtzoeller mentioned this pull request Aug 21, 2022
Merged
bors bot added a commit that referenced this pull request Aug 21, 2022
@bors @rtzoeller
Merge #1806
9cbb7eb 
1806: Remove MSRV-related workaround for doc aliases r=asomers a=rtzoeller

Remove the MSRV-related workaround added by #1693, since we now can use doc aliases in all supported versions of Rust.

Closes #1674.

Co-authored-by: Ryan Zoeller <rtzoeller@rtzoeller.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@asomers asomers asomers approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add doc(alias) to functions
2 participants
@rtzoeller @asomers