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

Add mdman for generating man pages. #8577

Merged
merged 7 commits into from
Aug 3, 2020
Merged

Add mdman for generating man pages. #8577

merged 7 commits into from
Aug 3, 2020

Conversation

ehuss
Copy link
Contributor

@ehuss ehuss commented Aug 1, 2020

This introduces a new utility called mdman that converts a markdown-formatted document to a man page. This replaces asciidoctor, with the intent to make it easier to contribute, easier to have consistent formatting across platforms, and easier to generate plain-text documents for use on Windows (for #8456). This also includes a number of formatting fixes.

There is some documentation in the mdman/doc directory explaining how to use it, and the docs in src/doc/README.md have been updated (this explains the structure of the files). The Makefile has been replaced with a simple shell script.

CI has been updated to verify the checked-in docs are up-to-date. Perhaps in the future, these can be generated automatically (perhaps by build.rs?), but since that requires a bit of build system work (like upstream rust), this is deferred till later.

@rust-highfive
Copy link

r? @Eh2406

(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 Aug 1, 2020
Copy link
Member

@alexcrichton alexcrichton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I didn't review mdman too too closely but everything looks pretty reasonable at a first glance, and all the Cargo integration bits look good to me. I'd be happy to basically land this whenever myself, unless you've got something else you'd like to take care of!

@ehuss
Copy link
Contributor Author

ehuss commented Aug 3, 2020

Thanks for taking a look! And sorry it's such a big diff. I did split it up into multiple commits to try to organize things a little. If any issues come up, I'll try to take care of them. I don't have anything else here, so:
@bors r=alexcrichton

@bors
Copy link
Contributor

bors commented Aug 3, 2020

📌 Commit 566706e 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 Aug 3, 2020
@bors
Copy link
Contributor

bors commented Aug 3, 2020

⌛ Testing commit 566706e with merge e928120...

@bors
Copy link
Contributor

bors commented Aug 3, 2020

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

@bors bors merged commit e928120 into rust-lang:master Aug 3, 2020
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 5, 2020
Update cargo

8 commits in 2d5c2381e4e50484bf281fc1bfe19743aa9eb37a..1653f354644834073d6d2541e27fae94588e685e
2020-07-31 21:56:08 +0000 to 2020-08-04 23:14:37 +0000
- Fix close_output test. (rust-lang/cargo#8587)
- clippy fixes, use matches! macro in more places (rust-lang/cargo#8575)
- Display embedded man pages for built-in commands. (rust-lang/cargo#8456)
- Add mdman for generating man pages. (rust-lang/cargo#8577)
- Fix typo 'more then' -> 'more than' in error and comments (rust-lang/cargo#8581)
- cargo login: make login message less ambiguous (rust-lang/cargo#8579)
- Fix broken link in Build Cache chapter. (rust-lang/cargo#8578)
- Fix intra-doc tests for renamed lint. (rust-lang/cargo#8576)
bors added a commit that referenced this pull request Sep 1, 2020
Remove asciidoc attribute in cargo-metadata man page.

I accidentally left this behind during #8577.
@ehuss ehuss added this to the 1.47.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.

6 participants