steveklabnik/rustdoc

Flag: target

Open

#142 opened on Aug 10, 2017

View on GitHub
 (3 comments) (0 reactions) (0 assignees) (22 forks)github user discovery
E-Mediumbackendhelp wantedquestion

Repository metrics

Stars
 (104 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

This issue is part of https://github.com/steveklabnik/rustdoc/issues/125

--target:

Using this flag looks like this:

$ rustdoc src/lib.rs --target x86_64-pc-windows-gnu

Similar to the --target flag for rustc, this generates documentation for a target triple that's different than your host triple.

All of the usual caveats of cross-compiling code apply.

Should we keep this flag or not?

Contributor guide

Research direction
Investigate the target flag in rustdoc: understand its purpose, how it works for cross compilation, and the implications of keeping or removing it. Look at the linked issue and any relevant rustc documentation.
Tech stack
rust
Domain
documentationcli
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80