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.

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

Report errors instead of panic!() when linkcheck encounters absolute paths #47387

Merged
merged 1 commit into from
Jan 17, 2018

Conversation

Rantanen
Copy link
Contributor

The RBE contained some absolute links that failed the link check in #46196. Diagnosing these issues was needlessly complicated, thanks to the linkchecker just panicing instead of reporting proper errors.

This PR replaces the panic with a proper *errors = true + error message handling.

The linkchecker itself doesn't have any tests so I intentionally didn't touch anything else than the code that previously did the panic!(). A small code quality improvement might be made by binding the Path::new(base).join(url) into a variable before the for-loop and using this resolved url in both the for loop and the error message.

r? @steveklabnik

(If not for any other reason than having r on the #46196.)

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@shepmaster shepmaster added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 13, 2018
@projektir
Copy link
Contributor

This will also make the linkchecker more useful as an all-around tool if we decide to pull it out into a crate.

@steveklabnik
Copy link
Member

Nice, thank you!

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented Jan 15, 2018

📌 Commit f7b4877 has been approved by steveklabnik

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jan 16, 2018
…teveklabnik

Report errors instead of panic!() when linkcheck encounters absolute paths

The RBE contained some absolute links that failed the link check in rust-lang#46196. Diagnosing these issues was needlessly complicated, thanks to the linkchecker just panicing instead of reporting proper errors.

This PR replaces the panic with a proper `*errors = true` + error message handling.

The linkchecker itself doesn't have any tests so I intentionally didn't touch anything else than the code that previously did the `panic!()`. A small code quality improvement might be made by binding the `Path::new(base).join(url)` into a variable before the for-loop and using this resolved url in both the for loop and the error message.

r? @steveklabnik

(If not for any other reason than having r on the rust-lang#46196.)
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jan 16, 2018
…teveklabnik

Report errors instead of panic!() when linkcheck encounters absolute paths

The RBE contained some absolute links that failed the link check in rust-lang#46196. Diagnosing these issues was needlessly complicated, thanks to the linkchecker just panicing instead of reporting proper errors.

This PR replaces the panic with a proper `*errors = true` + error message handling.

The linkchecker itself doesn't have any tests so I intentionally didn't touch anything else than the code that previously did the `panic!()`. A small code quality improvement might be made by binding the `Path::new(base).join(url)` into a variable before the for-loop and using this resolved url in both the for loop and the error message.

r? @steveklabnik

(If not for any other reason than having r on the rust-lang#46196.)
bors added a commit that referenced this pull request Jan 16, 2018
Rollup of 6 pull requests

- Successful merges: #47250, #47302, #47387, #47398, #47436, #47444
- Failed merges:
bors added a commit that referenced this pull request Jan 17, 2018
Rollup of 6 pull requests

- Successful merges: #47250, #47302, #47387, #47398, #47436, #47444
- Failed merges:
kennytm added a commit to kennytm/rust that referenced this pull request Jan 17, 2018
…teveklabnik

Report errors instead of panic!() when linkcheck encounters absolute paths

The RBE contained some absolute links that failed the link check in rust-lang#46196. Diagnosing these issues was needlessly complicated, thanks to the linkchecker just panicing instead of reporting proper errors.

This PR replaces the panic with a proper `*errors = true` + error message handling.

The linkchecker itself doesn't have any tests so I intentionally didn't touch anything else than the code that previously did the `panic!()`. A small code quality improvement might be made by binding the `Path::new(base).join(url)` into a variable before the for-loop and using this resolved url in both the for loop and the error message.

r? @steveklabnik

(If not for any other reason than having r on the rust-lang#46196.)
kennytm added a commit to kennytm/rust that referenced this pull request Jan 17, 2018
…teveklabnik

Report errors instead of panic!() when linkcheck encounters absolute paths

The RBE contained some absolute links that failed the link check in rust-lang#46196. Diagnosing these issues was needlessly complicated, thanks to the linkchecker just panicing instead of reporting proper errors.

This PR replaces the panic with a proper `*errors = true` + error message handling.

The linkchecker itself doesn't have any tests so I intentionally didn't touch anything else than the code that previously did the `panic!()`. A small code quality improvement might be made by binding the `Path::new(base).join(url)` into a variable before the for-loop and using this resolved url in both the for loop and the error message.

r? @steveklabnik

(If not for any other reason than having r on the rust-lang#46196.)
bors added a commit that referenced this pull request Jan 17, 2018
@bors bors merged commit f7b4877 into rust-lang:master Jan 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants