Repositorios, espacios de trabajo, paquetes y destinos

Informar un problema Ver fuente

Bazel compila software a partir del código fuente organizado en árboles de directorios llamados repositorios. El lugar de trabajo consta de un conjunto definido de repositorios. Los archivos de origen en repositorios se organizan en una jerarquía anidada de paquetes, en la que cada paquete es un directorio que contiene un conjunto de archivos de origen relacionados y un archivo BUILD. En el archivo BUILD, se especifica qué salidas de software se pueden compilar desde la fuente.

Repositorios

Los archivos de origen que se usan en una compilación de Bazel se organizan en repositorios (a menudo abreviados como repositorios). Un repositorio es un árbol de directorios con un archivo de marcador de límite en su raíz. Un archivo de marcador de límite puede ser MODULE.bazel, REPO.bazel o, en contextos heredados, WORKSPACE o WORKSPACE.bazel.

El repositorio en el que se ejecuta el comando actual de Bazel se denomina repositorio principal. Otros repositorios (externos) se definen según las reglas del repositorio. Consulta la descripción general de las dependencias externas para obtener más información.

Espacio de trabajo

Un lugar de trabajo es el entorno que comparten todos los comandos de Bazel que se ejecutan desde el mismo repositorio principal. Abarca el repositorio principal y el conjunto de todos los repositorios externos definidos.

Ten en cuenta que, históricamente, los conceptos de “repositorio” y “lugar de trabajo” se combinaron. A menudo, el término “lugar de trabajo” se usó para referirse al repositorio principal y, a veces, se usó como sinónimo de “repositorio”.

Paquetes

La unidad principal de organización de código en un repositorio es el paquete. Un paquete es una colección de archivos relacionados y una especificación de cómo se pueden usar para producir artefactos de salida.

Un paquete se define como un directorio que contiene un archivo BUILD llamado BUILD o BUILD.bazel. Un paquete incluye todos los archivos en su directorio, además de todos los subdirectorios debajo, excepto aquellos que contienen un archivo BUILD. A partir de esta definición, ningún archivo o directorio puede formar parte de dos paquetes diferentes.

Por ejemplo, en el siguiente árbol de directorios, hay dos paquetes, my/app, y el subpaquete my/app/tests. Ten en cuenta que my/app/data no es un paquete, sino un directorio que pertenece al paquete my/app.

src/my/app/BUILD
src/my/app/app.cc
src/my/app/data/input.txt
src/my/app/tests/BUILD
src/my/app/tests/test.cc

Destinos

Un paquete es un contenedor de destinos, que se definen en el archivo BUILD del paquete. La mayoría de los objetivos son uno de dos tipos principales: files y rules.

Además, los archivos se dividen en dos tipos. Por lo general, los archivos fuente se escriben con el esfuerzo de otras personas y se registran en el repositorio. Los archivos generados, a veces llamados archivos derivados o archivos de salida, no se registran, pero se generan a partir de archivos fuente.

El segundo tipo de objetivo se declara con una regla. Cada instancia de regla especifica la relación entre un conjunto de archivos de entrada y un conjunto de archivos de salida. Las entradas a una regla pueden ser archivos de origen, pero también pueden ser las salidas de otras reglas.

Si la entrada a una regla es un archivo de origen o un archivo generado, en la mayoría de los casos, no tiene importancia; lo que importa es solo el contenido de ese archivo. Esto facilita el reemplazo de un archivo fuente complejo por un archivo generado producido por una regla, como cuando la carga de mantener manualmente un archivo altamente estructurado se vuelve demasiado agotadora y alguien escribe un programa para derivarlo. No se requiere ningún cambio a los consumidores de ese archivo. Por el contrario, un archivo generado se puede reemplazar con facilidad por un archivo de origen solo con cambios locales.

Las entradas a una regla también pueden incluir otras reglas. El significado preciso de estas relaciones suele ser bastante complejo y depende del lenguaje o las reglas, pero de forma intuitiva es simple: una regla de una biblioteca C++ A podría tener otra regla de biblioteca C++ B para una entrada. El efecto de esta dependencia es que los archivos de encabezado de B están disponibles para A durante la compilación, los símbolos de B están disponibles para A durante la vinculación y los datos del tiempo de ejecución de B están disponibles para A durante la ejecución.

Una variante de todas las reglas es que los archivos que genera una regla siempre pertenecen al mismo paquete que la regla en sí; no es posible generar archivos en otro paquete. Sin embargo, no es inusual que las entradas de una regla provengan de otro paquete.

Los grupos de paquetes son conjuntos de paquetes cuyo propósito es limitar la accesibilidad de ciertas reglas. Los grupos de paquetes se definen con la función package_group. Tienen tres propiedades: la lista de paquetes que contienen, su nombre y otros grupos de paquetes que incluyen. Las únicas formas permitidas de hacer referencia a ellas son desde el atributo visibility de las reglas o desde el atributo default_visibility de la función package. No generan ni consumen archivos. Para obtener más información, consulta la documentación de package_group.

Etiquetas