Add doc for va_list APIs #146925
Merged
Add doc for va_list APIs #146925
Conversation
This file contains hidden or 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
Collaborator
rustbot
added
S-waiting-on-review
Collaborator
RalfJung
reviewed
Sep 23, 2025
DiuDiu777
force-pushed
the
va-doc-fix
branch
from
f151fb8 to
9c6f170
Compare
tgross35
requested changes
Oct 3, 2025
library/core/src/intrinsics/mod.rs
Outdated
Comment on lines
3331
to
3333
| /// You must check the following invariants before you call this function: | ||
| /// | ||
| /// - `ap` must not be used to access variable arguments after this call |
Contributor
There was a problem hiding this comment.
This can be simplified to just:
/// `ap` must not be used to access variable arguments after this call
library/core/src/ffi/va_list.rs
Outdated
| /// | ||
| /// - has a type that is ABI-compatible with the type `T` | ||
| /// - has a value that is a properly initialized value of type `T` | ||
| /// - there is a next variable argument available (i.e., the number of arguments already read from `ap` is less than the total number passed) |
Contributor
There was a problem hiding this comment.
Please rewrap to 100 chars (same in intrinsics/mod.rs)
rustbot
added
S-waiting-on-author
Contributor
Author
|
Done! r? @tgross35 |
Collaborator
|
Requested reviewer is already assigned to this pull request. Please choose another assignee. |
tgross35
approved these changes
Nov 19, 2025
Contributor
Collaborator
bors
added
S-waiting-on-bors
tgross35
reviewed
Nov 19, 2025
Comment on lines
+248
to
+250
| /// - there is a next variable argument available. | ||
| /// - the next argument's type must be ABI-compatible with the type `T`. | ||
| /// - the next argument must have a properly initialized value of type `T`. |
Contributor
There was a problem hiding this comment.
Usually list items start with an uppercase letter, but this is preexisting so 🤷
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Nov 19, 2025
Add doc for va_list APIs I observed that [PR146521](rust-lang#146521) submitted two weeks ago resolved some documentation issues related to `VaListImpl`, similar to the previous [PR136969](rust-lang#136969). This PR specifically adds requirements about argument availability for `VaListImpl::arg`, and also adds safety descriptions to the three associated intrinsic APIs.
bors
added a commit
that referenced
this pull request
Nov 19, 2025
Rollup of 7 pull requests Successful merges: - #146341 (minimal dirfd implementation (1/4)) - #146925 (Add doc for va_list APIs) - #147035 (alloc: fix `Debug` implementation of `ExtractIf`) - #147173 (Add support for hexagon-unknown-qurt target) - #149041 (ignore unsized types in mips64 and sparc64 callconvs) - #149056 (fix the fragment_in_dst_padding_gets_overwritten test on s390x) - #149095 (rustc-dev-guide subtree update) r? `@ghost` `@rustbot` modify labels: rollup
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Nov 19, 2025
Add doc for va_list APIs I observed that [PR146521](rust-lang#146521) submitted two weeks ago resolved some documentation issues related to `VaListImpl`, similar to the previous [PR136969](rust-lang#136969). This PR specifically adds requirements about argument availability for `VaListImpl::arg`, and also adds safety descriptions to the three associated intrinsic APIs.
bors
added a commit
that referenced
this pull request
Nov 20, 2025
Rollup of 6 pull requests Successful merges: - #146925 (Add doc for va_list APIs) - #147035 (alloc: fix `Debug` implementation of `ExtractIf`) - #147173 (Add support for hexagon-unknown-qurt target) - #149041 (ignore unsized types in mips64 and sparc64 callconvs) - #149056 (fix the fragment_in_dst_padding_gets_overwritten test on s390x) - #149095 (rustc-dev-guide subtree update) r? `@ghost` `@rustbot` modify labels: rollup
Zalathar
added a commit
to Zalathar/rust
that referenced
this pull request
Nov 20, 2025
Add doc for va_list APIs I observed that [PR146521](rust-lang#146521) submitted two weeks ago resolved some documentation issues related to `VaListImpl`, similar to the previous [PR136969](rust-lang#136969). This PR specifically adds requirements about argument availability for `VaListImpl::arg`, and also adds safety descriptions to the three associated intrinsic APIs.
bors
added a commit
that referenced
this pull request
Nov 20, 2025
Rollup of 9 pull requests Successful merges: - #146925 (Add doc for va_list APIs) - #147035 (alloc: fix `Debug` implementation of `ExtractIf`) - #147173 (Add support for hexagon-unknown-qurt target) - #148261 (rustc_public: Make Id types !Send / !Sync) - #149041 (ignore unsized types in mips64 and sparc64 callconvs) - #149043 ( rustdoc-json: add rlib path to ExternalCrate to enable robust crate resolution) - #149056 (fix the fragment_in_dst_padding_gets_overwritten test on s390x) - #149095 (rustc-dev-guide subtree update) - #149108 ([AIX][ppc64le-linux-gnu] Add Amy Kwan to target maintainers) r? `@ghost` `@rustbot` modify labels: rollup
Zalathar
added a commit
to Zalathar/rust
that referenced
this pull request
Nov 20, 2025
Add doc for va_list APIs I observed that [PR146521](rust-lang#146521) submitted two weeks ago resolved some documentation issues related to `VaListImpl`, similar to the previous [PR136969](rust-lang#136969). This PR specifically adds requirements about argument availability for `VaListImpl::arg`, and also adds safety descriptions to the three associated intrinsic APIs.
bors
added a commit
that referenced
this pull request
Nov 20, 2025
Rollup of 10 pull requests Successful merges: - #146925 (Add doc for va_list APIs) - #147035 (alloc: fix `Debug` implementation of `ExtractIf`) - #147173 (Add support for hexagon-unknown-qurt target) - #148261 (rustc_public: Make Id types !Send / !Sync) - #148831 (Bump compiler dependencies) - #149041 (ignore unsized types in mips64 and sparc64 callconvs) - #149056 (fix the fragment_in_dst_padding_gets_overwritten test on s390x) - #149071 (Add test scaffolding for the `remote-test-client`) - #149095 (rustc-dev-guide subtree update) - #149108 ([AIX][ppc64le-linux-gnu] Add Amy Kwan to target maintainers) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
that referenced
this pull request
Nov 20, 2025
Rollup of 9 pull requests Successful merges: - #146925 (Add doc for va_list APIs) - #147035 (alloc: fix `Debug` implementation of `ExtractIf`) - #147173 (Add support for hexagon-unknown-qurt target) - #148261 (rustc_public: Make Id types !Send / !Sync) - #149041 (ignore unsized types in mips64 and sparc64 callconvs) - #149056 (fix the fragment_in_dst_padding_gets_overwritten test on s390x) - #149071 (Add test scaffolding for the `remote-test-client`) - #149095 (rustc-dev-guide subtree update) - #149108 ([AIX][ppc64le-linux-gnu] Add Amy Kwan to target maintainers) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
that referenced
this pull request
Nov 20, 2025
Rollup merge of #146925 - DiuDiu777:va-doc-fix, r=tgross35 Add doc for va_list APIs I observed that [PR146521](#146521) submitted two weeks ago resolved some documentation issues related to `VaListImpl`, similar to the previous [PR136969](#136969). This PR specifically adds requirements about argument availability for `VaListImpl::arg`, and also adds safety descriptions to the three associated intrinsic APIs.
github-actions bot
pushed a commit
to rust-lang/rustc-dev-guide
that referenced
this pull request
Nov 24, 2025
Rollup of 9 pull requests Successful merges: - rust-lang/rust#146925 (Add doc for va_list APIs) - rust-lang/rust#147035 (alloc: fix `Debug` implementation of `ExtractIf`) - rust-lang/rust#147173 (Add support for hexagon-unknown-qurt target) - rust-lang/rust#148261 (rustc_public: Make Id types !Send / !Sync) - rust-lang/rust#149041 (ignore unsized types in mips64 and sparc64 callconvs) - rust-lang/rust#149056 (fix the fragment_in_dst_padding_gets_overwritten test on s390x) - rust-lang/rust#149071 (Add test scaffolding for the `remote-test-client`) - rust-lang/rust#149095 (rustc-dev-guide subtree update) - rust-lang/rust#149108 ([AIX][ppc64le-linux-gnu] Add Amy Kwan to target maintainers) r? `@ghost` `@rustbot` modify labels: rollup
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
I observed that PR146521 submitted two weeks ago resolved some documentation issues related to
VaListImpl, similar to the previous PR136969.This PR specifically adds requirements about argument availability for
VaListImpl::arg, and also adds safety descriptions to the three associated intrinsic APIs.