livepeer/go-livepeer

Unclear which flags are used by which roles

Open

#2,183 opened on Jan 14, 2022

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Go (223 forks)auto 404
area: cligood first issuehelp wantedtype: documentation

Repository metrics

Stars
 (583 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the bug

Currently, it isn't easy to determine which flags (e.g. -maxTicketEV) are used by which role (e.g. -broadcaster or -orchestrator)

To Reproduce

  1. Run ./livepeer --help
  2. See a number of flags, with descriptions of how to use them e.g.:
  -maxTicketEV string
    	The maximum acceptable expected value for PM tickets (default "3000000000000")
  1. Be confused about whether this flag is to be used with -broadcaster role or -orchestrator role.
  2. Try running ./livepeer with the -orchestrator flag and also -maxTicketEV
  3. Discover that setting the -maxTicketEV in this case is ignored
  4. Be confused about why it didn't throw an error saying "you can't use -maxTicketEV with -orchestrator" (or something similar)

Expected behavior

I expect it to be made clear (e.g. in --help) which flags can influence the operations of which role.

Also, if I use a flag with a role where the role ignores the flag, I at least expect to be warned about it :)

Contributor guide

Research direction
Inspect the CLI flag registration code (likely in cmd/livepeer/ or similar) to understand how flags are associated with roles. Then update the help output to indicate which flags apply to which roles, and add warnings when a flag is ignored for a given role.
Tech stack
go
Domain
backend
Issue type
Documentation
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75