[beta] rustdoc: semi-revert libsyntax doctest parsing if a macro is wrapping main #57019
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
| Ping @rust-lang/rustdoc, can someone review this? |
pietroalbini added the S-waiting-on-review 
| I feel like this is getting more and more hackish code. But at least it does the job. Thanks! @bors: r+ |
| 📌 Commit 339148d has been approved by |
bors added S-waiting-on-bors bors added a commit that referenced this pull request Jan 5, 2019
…=GuillaumeGomez [beta] rustdoc: semi-revert libsyntax doctest parsing if a macro is wrapping main Fixes #56898 This is a patch to doctest parsing on beta (that i plan to "forward-port" to master) that reverts to the old text-based `fn main` scan if it found a macro invocation in the doctest but did not find a main function. This should solve situations like `allocator_api` which wrap their main functions in a macro invocation, but doesn't solve something like the initial version of `quicli` which used a macro to *generate* the main function. (Properly doing the latter involves running macro expansion before checking, which is a bit too involved for a beta fix.)
| ☀️ Test successful - status-appveyor, status-travis |
This was referenced Jan 7, 2019
Centril added a commit to Centril/rust that referenced this pull request Jan 12, 2019
…-parsing, r=GuillaumeGomez rustdoc: use text-based doctest parsing if a macro is wrapping main This is a "forward-port" of rust-lang#57019, intended to get rust-lang#56898 on nightly, since it's now fixed on beta (and already worked on stable). To recap: * The libsyntax-based doctest parsing now checks to see whether there is a top-level macro invocation in the doctest while it's checking for `fn main` and an `extern crate` statement. * If it finds a macro invocation and *didn't* find `fn main`, then it performs the older text-based scan to allow doctests like the ones in `allocator_api` to still compile. A "proper" fix will involve changing how `make_test` works to call it later in the `run_test` function, after the initial steps of compilation have completed. I've filed [a separate issue](rust-lang#57415) for that, though.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 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.
Fixes #56898
This is a patch to doctest parsing on beta (that i plan to "forward-port" to master) that reverts to the old text-based
fn mainscan if it found a macro invocation in the doctest but did not find a main function. This should solve situations likeallocator_apiwhich wrap their main functions in a macro invocation, but doesn't solve something like the initial version ofquicliwhich used a macro to generate the main function. (Properly doing the latter involves running macro expansion before checking, which is a bit too involved for a beta fix.)