steveklabnik/rustdoc

Flag: configuration flags

Open

#134 opened on Aug 10, 2017

View on GitHub
 (2 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

--cfg: passing configuration flags

Using this flag looks like this:

$ rustdoc src/lib.rs --cfg feature="foo"

This flag accepts the same values as rustc --cfg, and uses it to configure compilation. The example above uses feature, but any of the cfg values are acceptable.

Should we keep this flag or not?

Contributor guide

Research direction
Research the current usage of the cfg flag in rustdoc and its necessity. Look into related discussions and documentation to determine if it should be kept.
Tech stack
rust
Domain
tooling
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Fresh
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.
50