Pular para o conteúdo principal

build

Página gerada do fonte

Gerada por tools/gerar_documentacao.py. Definição: tools/gerar_documentacao.py:77.

Extrai o inventário e escreve páginas MDX e dados JSON públicos.

Tipo: função Python · Visibilidade: pública · Arquivo: tools/gerar_documentacao.py.

Assinatura e expansão​

def build(root: Path, output: Path, repo_url: str, commit: str) -> dict:

Parâmetros formais: root: Path, output: Path, repo_url: str, commit: str.

Como funciona​

Extrai o inventário e escreve páginas MDX e dados JSON públicos.

Implementação​

def build(root: Path, output: Path, repo_url: str, commit: str) -> dict:
"""Extrai o inventário e escreve páginas MDX e dados JSON públicos."""
inventory = collect(root)
contracts = json.loads((root / "tools" / "documentacao" / "contratos.json").read_text(encoding="utf-8"))
renderer = Renderer(inventory, contracts, repo_url, commit)
return renderer.write(output)

Nomes internos referenciados: collect.

Como este símbolo aparece nos testes​

4 ocorrência(s) em 2 arquivo(s) de teste. Os links apontam para linhas exatas; os trechos mostram o contexto local. Uma menção não prova que todos os ramos foi executado.

tests/run_checkout_limpo.sh​

Contexto: run_checkout_limpo.sh. Linhas: 99, 107, 110. Tipo de evidência: código; via build.

Linhas 97–101 · abrir contexto
# comando M0 de uma linha, como no README
if ( cd "$DEST" && ${CC:-cc} -std=c11 -Wall -Wextra -I include \
docs/exemplos/ola_mundo.c build/libbasicgol.a -lm -o ola_m0 \
> "$TMP/m0.log" 2>&1 && [ "$(./ola_m0)" = "Ola, mundo!" ] ); then
ok "comando M0 de uma linha do README compila e imprime 'Ola, mundo!'"

Ver no GitHub

Linhas 105–112 · abrir contexto

# fluxo M1 de duas etapas
if ( cd "$DEST" && build/basicgolc docs/exemplos/controle_lacos.c -o /tmp/gerado.c \
> "$TMP/m1.log" 2>&1 \
&& ${CC:-cc} -std=c11 -Wall -Wextra -I include /tmp/gerado.c \
build/libbasicgol.a -lm -o /tmp/gerado_m1 >> "$TMP/m1.log" 2>&1 ); then
ok "fluxo M1 de duas etapas do README (transpila e compila o C gerado)"
else

Ver no GitHub

tests/run_msvc.sh​

Contexto: run_msvc.sh. Linhas: 33. Tipo de evidência: código; via build.

Linhas 31–35 · abrir contexto
T_BASICGOLC="${T_BASICGOLC:-build/basicgolc.exe}"
T_LIBRARY="${T_LIBRARY:-build/libbasicgol.lib}"
BUILD=build/exemplos-msvc
TMP=$(mktemp -d "${TMPDIR:-/tmp}/basicgol-msvc.XXXXXX")
trap 'rm -rf "$TMP"' EXIT

Ver no GitHub

Evidência indireta​

Estes símbolos chamam/encaminham para este nome. As referências deles ajudam a rastrear o caminho, mas não substituem um teste específico deste símbolo.

Compiladores, padrão C e sistema operacional​

Nenhum ramo condicional externo foi detectado para este símbolo. A implementação é compartilhada no fonte; isso não certifica compiladores ou sistemas não executados.

  • Script Python: usa a biblioteca padrão e pathlib/subprocess quando aplicável; caminhos não devem depender do separador de um único OS.
Não confunda implementação com certificação

A matriz histórica distingue executado, compilado, avaliado e não testado. Consulte a matriz, os compiladores e os logs atuais dos workflows antes de chamar um alvo de suportado.

Perguntas frequentes​

Perguntas reunidas a partir da definição, do contrato editorial e dos testes de build. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.

Em uma frase, o que build faz?​

Extrai o inventário e escreve páginas MDX e dados JSON públicos.

Qual é a assinatura e o tipo de retorno de build?​

Assinatura extraída de tools/gerar_documentacao.py; visibilidade pública.

def build(root: Path, output: Path, repo_url: str, commit: str) -> dict:

Como build aparece em código real deste repositório?​

Uso extraído de tests/run_checkout_limpo.sh:97, com as linhas vizinhas preservadas:

# comando M0 de uma linha, como no README
if ( cd "$DEST" && ${CC:-cc} -std=c11 -Wall -Wextra -I include \
docs/exemplos/ola_mundo.c build/libbasicgol.a -lm -o ola_m0 \
> "$TMP/m0.log" 2>&1 && [ "$(./ola_m0)" = "Ola, mundo!" ] ); then
ok "comando M0 de uma linha do README compila e imprime 'Ola, mundo!'"

Onde build é exercitado nos testes?​

Há 4 ocorrência(s) em 2 arquivo(s): tests/run_checkout_limpo.sh, tests/run_msvc.sh. Os links da seção de evidência apontam para a linha exata; uma menção não prova que todos os ramos foram executados.

build depende de compilador, padrão C ou sistema operacional?​

build é uma função Python: requer Python 3.10+ e biblioteca padrão, sem compilador C.

O que acontece em caso de falha ou uso inválido?​

Não há ressalva editorial específica para este nome. O comportamento em falha é o do corpo/expansão mostrado acima; não invente validação que o fonte não faz.