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

Fix man page links inside option blocks. #8793

Merged
merged 2 commits into from
Oct 17, 2020
Merged

Conversation

ehuss
Copy link
Contributor

@ehuss ehuss commented Oct 17, 2020

Links inside {{#option}} blocks were erroneously being converted to absolute links when emitting the md format because they were being rendered as HTML. This wasn't intended and caused some links to fail. It also causes problems for offline viewing (since the links are to an external website).

Also, man-page links like {{man "cargo-foo" 1}} were linking to .md extension, but since they are processed as markdown into HTML, mdbook's .md to .html translation wasn't getting applied. The simple fix is to always use .html.

This revealed a legitimate error in a link in cargo-publish.md which had the wrong anchor link (#registrydefault).

This also revealed that the CI check that the man pages are in sync wasn't working quite right (it was not checking the etc/man directory for changes).

The check that generated files are in sync wasn't correctly checking
the etc/man directory.
@rust-highfive
Copy link

r? @alexcrichton

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 17, 2020
@alexcrichton
Copy link
Member

@bors: r+

@bors
Copy link
Contributor

bors commented Oct 17, 2020

📌 Commit 1a86f23 has been approved by alexcrichton

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 17, 2020
@bors
Copy link
Contributor

bors commented Oct 17, 2020

⌛ Testing commit 1a86f23 with merge af64bd6...

@bors
Copy link
Contributor

bors commented Oct 17, 2020

☀️ Test successful - checks-actions
Approved by: alexcrichton
Pushing af64bd6 to master...

@bors bors merged commit af64bd6 into rust-lang:master Oct 17, 2020
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Oct 22, 2020
Update cargo

3 commits in 79b397d72c557eb6444a2ba0dc00a211a226a35a..dd83ae55c871d94f060524656abab62ec40b4c40
2020-10-15 14:41:21 +0000 to 2020-10-20 19:31:26 +0000
- Support glob patterns for package/target selection (rust-lang/cargo#8752)
- Update env_logger requirement from 0.7.0 to 0.8.1 (rust-lang/cargo#8795)
- Fix man page links inside `option` blocks. (rust-lang/cargo#8793)
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Oct 23, 2020
Update cargo

3 commits in 79b397d72c557eb6444a2ba0dc00a211a226a35a..dd83ae55c871d94f060524656abab62ec40b4c40
2020-10-15 14:41:21 +0000 to 2020-10-20 19:31:26 +0000
- Support glob patterns for package/target selection (rust-lang/cargo#8752)
- Update env_logger requirement from 0.7.0 to 0.8.1 (rust-lang/cargo#8795)
- Fix man page links inside `option` blocks. (rust-lang/cargo#8793)
@ehuss ehuss added this to the 1.49.0 milestone Feb 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants