Skip to content

src/doc/build-man.sh is not able to run on platforms missing sh #11717

Closed
@weihanglo

Description

@weihanglo

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

No one assigned

    Labels

    A-documenting-cargo-itselfArea: Cargo's documentationA-infrastructureArea: infrastructure around the cargo repo, ci, releases, etc.C-enhancementCategory: enhancementS-acceptedStatus: Issue or feature is accepted, and has a team member available to help mentor or review

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions