livepeer/go-livepeer

Unclear which flags are used by which roles

Aberta

#2.183 aberto em 14 de jan. de 2022

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Go (223 forks)auto 404
area: cligood first issuehelp wantedtype: documentation

Métricas do repositório

Stars
 (583 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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 :)

Guia do colaborador

Direção de pesquisa
Inspecione o código de registro de flags da CLI (provavelmente em cmd/livepeer/ ou similar) para entender como as flags são associadas às funções. Em seguida, atualize a saída de help para indicar quais flags se aplicam a quais funções e adicione avisos quando uma flag é ignorada para uma determinada função.
Pilha de tecnologia
go
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Go
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75