-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Closed
Labels
A-documenting-cargo-itselfArea: Cargo's documentationArea: Cargo's documentationA-infrastructureArea: infrastructure around the cargo repo, ci, releases, etc.Area: infrastructure around the cargo repo, ci, releases, etc.C-enhancementCategory: enhancementCategory: enhancementS-acceptedStatus: Issue or feature is accepted, and has a team member available to help mentor or reviewStatus: Issue or feature is accepted, and has a team member available to help mentor or review
Description
Problem
From #11646 (comment), people struggle to run src/doc/build-man.sh
on Windows. This might prevent Windows users from contributing Cargo documentations. We may want to find a way making every contributor feel inclusive without introducing more external tool dependencies.
Proposed Solution
Two options off the top of my head:
- EASY: Translate
src/doc/build-man.sh
to Windows batch script or powershell. - EASY: Use a python script instead. See this comment.
- HARD?: Introduce some workflow like
cargo-xtask
(blocked on nested workspaces feature).
Need to take care of crates/mdman/build-man.sh
as well.
Notes
Was reading this article and it reminded me this issue.
Metadata
Metadata
Assignees
Labels
A-documenting-cargo-itselfArea: Cargo's documentationArea: Cargo's documentationA-infrastructureArea: infrastructure around the cargo repo, ci, releases, etc.Area: infrastructure around the cargo repo, ci, releases, etc.C-enhancementCategory: enhancementCategory: enhancementS-acceptedStatus: Issue or feature is accepted, and has a team member available to help mentor or reviewStatus: Issue or feature is accepted, and has a team member available to help mentor or review