TOC(heading=Índice)?

API de funciones

Introducción

Para el desarrollo de la interfaz de programación del proyecto deben seguirse estas reglas de estilo:

• Las reglas de la API se cumplirán independientemente del lenguaje de programación utilizado.
• La documentación del código debe se r compatible con ​Doxygen.
• Debe incluirse toda la información necesaria en las cabeceras de las funciones (descripción, formato, salidas, notas, etc.).
• Deben incluirse comentarios descriptivos en los bloques de código.
• Las funciones devolverán un código de salida al estilo Unix, que indique si se ha ejecutado correctamente o se ha producido alguno de los tipos de errores definidos. En caso de error, también mostrará el mensaje correspondiente.
• Todos los nombres de funciones y variables deben estar escritos en inglés, deben ser descriptivos y fáciles de recordar.
• Nombres de funciones al estilo Rembo-C (sólo con las iniciales en mayúsculas), pero sin copiarlos de Rembo-C. Según se estime oportuno, los nombres de funciones podrán tener un prefijo indicativo del proyecto o del componente del proyecto al que pertenece.
• Las constantes y variables globales deben ir escritas en mayúsculas.

Parámetros

Los parámetros de las funciones deben estar unificados, ésto es, deben ser comprensibles según su tipo y su contexto.

Tipos de parámetros:

• Disco: identificado por su número de orden.
• Partición: número de orden de la partición.
  • Identificador de partición: dupla de valores formada por disco y partición (2 parámetros).
• Sistema de archivos: mnemónico predefinido identificador del tipo de sistema de archivos.
• Tamaño: número entero con el tamaño de la partición en KB.
  • Definición de partición: pareja de valores formada por sistema de archivos y tamaño, separados por ":" (1 parámetro compuesto).
• Repositorio: dirección IP del repositorio de imágenes.
• Caché local: dirección IP del cliente local o localhost
• Camino: camino de un fichero relativo a su partición, a su repositorio o su caché local.
  • Camino completo: parámetro compuesto por identificador de partición o repositorio y el camino relativo de un fichero (2 o 3 parámetros).
• Fichero de imagen: ...
• ...

Errores y mensajes

(códigos de error y mensajes de salida)

Funciones del motor de clonación

(lista de funciones para clonar "a mano" o desde scripts)

Funciones del gestor web

(lista de funciones ejecutadas por el gestor web)