reference
reference copied to clipboard
Reformat inline-assembly chapter as a spec chapter.
This rewrites the inline-assembly chapter to use the agreed upon style and mdbook-spec extensions. It also more formally defines certain portions and adds several more examples.
@Amanieu: We on the spec team would appreciate if you could have a look at this PR.
The context here is that we're reformatting and reworking Reference chapters to make them more "spec like". Principally, that means that we're adding an identifier to each block. Since each identifier has a name, that means reworking things a bit such that "one idea" falls within each such block.
We 1) want to be sure you know this is going on, and 2) are happy with how it turned out, especially as there was some reworking, rewording, and the addition of some new content.
We're using this chapter as a model for reworking other ones (so please bear with us a bit as this is the first).
Approved review. I say we aim for getting a 50% or more checkbox approval here before merging.
- [x] @JoelMarcey
- [ ] @ehuss
- [ ] @traviscross
- [ ] @m-ou-se
- [ ] @pnkfelix
- [x] @Amanieu
Let's use rfcbot here. We should FCP this since it's the model for other chapters.
I'm going to propose FCP merge, even though I still need to review carefully, because I certainly want this in some form. And I'll check Joel's box as he's checked off above.
(I'll file a concern to hold space for that review.)
(We'll see if rfcbot works with T-spec here. It's the first go of this, at least in this repo.)
@rfcbot fcp merge
Team member @traviscross has proposed to merge this. The next step is review by the rest of the tagged team members:
- [x] @JoelMarcey
- [ ] @ehuss
- [ ] @m-ou-se
- [ ] @pnkfelix
- [x] @traviscross
Concerns:
- decide-on-issue-1550-first (https://github.com/rust-lang/reference/pull/1523#issuecomment--2040277305)
- tc-wants-to-review-carefully (https://github.com/rust-lang/reference/pull/1523#issuecomment--2059680904)
Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!
See this document for info about what commands tagged team members can give me.
@rfcbot concern tc-wants-to-review-carefully
Discussion re. [asm.invocation.prefix-instr] and [asm.invocation.global-section] https://rust-lang.zulipchat.com/#narrow/stream/216763-project-inline-asm/topic/.60.2Esection.60.20directives.2E
I'm quickly adding "Terms used in the Specification" to the glossary in order to resolve some of the above wording concerns. We'll need the terms defined anyways, and we might as well have them sooner rather than later.
@rfcbot concern decide-on-issue-1550-first
Let's decide, first, on the FCP in:
- https://github.com/rust-lang/reference/pull/1550
This can be closed now, correct?