bazelbuild/bazel

Document %workspace% and other token expansions

Open

#13.480 aberto em 16 de mai. de 2021

Ver no GitHub
 (0 comments) (1 reaction) (0 assignees)Java (4.465 forks)batch import
P2help wantedteam-Documentationteam-ExternalDepstype: documentation (cleanup)

Métricas do repositório

Stars
 (25.384 stars)
Métricas de merge de PR
 (Mesclagem média 22d 20h) (77 fundiu PRs em 30d)

Description

The %workspace% token is mentioned in the user manual under the --package_path flag. It would be way easier to find if expansion tokens were documented in a separate section.

It would also be useful to document

  • where the expansion tokens are expanded (i.e. which files and flags they are valid in)
  • whether there are an other expansion tokens

The description of %workspace% is confusing, since it refers to a "Bazel directory", which seems to mean a directory literally named "bazel". I can't find a precise definition of this term, an it is not mentioned in the concepts page. IIUC a workspace would be a directory containing a "WORKSPACE" file, but that doesn't seem to be what this expansion variable means.

Guia do colaborador

Direção de pesquisa
Examine o código fonte e a documentação do Bazel para entender todas as expansões de token como %workspace%, depois escreva uma seção dedicada no manual do usuário.
Pilha de tecnologia
java
Domain
documentationdeveloper experience
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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85