Versión 1.0.4, #531: Retoques en ayudas y en código para Doxygen.

git-svn-id: https://opengnsys.es/svn/branches/version1.0@3230 a21b9725-9963-47de-94b9-378ad31fedc9
2012-06-21 08:49:05 +00:00 · 2012-06-21 08:49:05 +00:00 · 6e390b1296
parent 4f48dcefdf
commit 6e390b1296
5 changed files with 34 additions and 102 deletions
--- a/client/engine/Disk.lib
+++ b/client/engine/Disk.lib
@ -251,7 +251,7 @@ sgdisk $DELOPTIONS $OPTIONS $DISK 2>/dev/null && partprobe $DISK
 #@author  Universidad de Huelva
 #@date    2012/03/06
 #*/ ##
-function ogCreatePartitionTable()
+function ogCreatePartitionTable ()
 {
 # Variables locales.
 local DISK PTTYPE CREATE CREATEPTT
@ -633,7 +633,7 @@ echo $TYPE

 #/**
 #         ogGetLastSector int_ndisk [int_npart]
-#@brief   Devuelve el último sector usable del disco o una partición.
+#@brief   Devuelve el último sector usable del disco o de una partición.
 #@param   int_ndisk      nº de orden del disco
 #@param   int_npart      nº de orden de la partición (opcional)
 #@return  Último sector usable.
@ -858,12 +858,12 @@ esac
 #@param   int_ndisk       nº de orden del disco
 #@return  str_tabletype - Tipo de tabla de paritiones
 #@warning Salidas de errores no determinada
-#@note    tabletype: { MSDOS, GPT }
+#@note    tabletype = { MSDOS, GPT }
 #@note    Requisitos: parted
 #@version 1.0.4 - Primera versión para OpenGnSys
 #@author  Universidad de Huelva
 #@date    2012/03/01
-#*/
+#*/ ##
 function ogGetPartitionTableType ()
 {
 # Variables locales.
@ -872,7 +872,7 @@ local DISK
 # Si se solicita, mostrar ayuda.
 if [ "$*" == "help" ]; then
    ogHelp "$FUNCNAME" "$FUNCNAME int_ndisk" \
-           "$FUNCNAME 1"
+           "$FUNCNAME 1  =>  MSDOS"
    return
 fi
 # Error si no se recibe 1 parámetro.
@ -1143,7 +1143,8 @@ parted -s $DISK set $2 boot on 2>/dev/null
 #@author  Universidad de Huelva
 #@date    2012/03/13
 #*/ ##
-function ogSetPartitionId() {
+function ogSetPartitionId ()
+{
 # Variables locales
 local DISK PART PTTYPE ID

--- a/client/engine/FileSystem.lib
+++ b/client/engine/FileSystem.lib
@ -30,7 +30,7 @@
 #@version 1.0.4 - Soportar HFS/HFS+.
 #@author  Ramon Gomez, ETSII Universidad de Sevilla
 #@date    2012-05-21
-#*/
+#*/ ##
 function ogCheckFs ()
 {
 # Variables locales.
@ -106,7 +106,7 @@ return $ERRCODE
 #@version 0.9 - Primera adaptacion para OpenGNSys.
 #@author  Ramon Gomez, ETSII Universidad de Sevilla
 #@date    2009-09-23
-#*/
+#*/ ##
 function ogExtendFs ()
 {
 # Variables locales.
@ -164,7 +164,7 @@ return $ERRCODE
 #/**
 #         ogFormat int_ndisk int_npartition | CACHE
 #@see     ogFormatFs ogFormatCache
-#*/
+#*/ ##
 function ogFormat ()
 {
 case "$*" in
@ -828,7 +828,7 @@ esac
 #/**
 #         ogUnlock int_ndisk int_npartition
 #@see     ogUnlockPartition
-#*/
+#*/ ##
 function ogUnlock ()
 {
 ogUnlockPartition "$@"
@ -873,7 +873,7 @@ rm -f $LOCKFILE
 #/**
 #         ogUnmount int_ndisk int_npartition
 #@see     ogUnmountFs
-#*/
+#*/ ##
 function ogUnmount ()
 {
 ogUnmountFs "$@"
--- a/client/engine/Image.lib
+++ b/client/engine/Image.lib
@ -787,82 +787,3 @@ IMGFILE=$(ogGetPath "$1" "$2.img") || return $?
 ogGetImageInfo $IMGFILE | awk -F: '{print $4}'
 }

-
-#/**
-#         ogGetImageFs str_repo path_image
-#@brief   Devuelve el tipo de sistema de archivos almacenado en un fichero de imagen.
-#@param   str_repo    repositorio de imágenes o caché local
-#@param   path_image  camino de la imagen
-#@return  str_imgtype - mnemónico del tipo de sistema de archivos
-#@exception OG_ERR_FORMAT   formato incorrecto.
-#@exception OG_ERR_NOTFOUND fichero de imagen no encontrado.
-#@todo    Comprobar salidas para todos los tipos de sistemas de archivos.
-#/**
-function ogGetImageFsUS ()
-{
-local IMGFILE IMGTYPE
-IMGTYPE=$(ogGetImageType "$1" "$2")
-IMGFILE=$(ogGetPath "$1" "$2.$IMGTYPE") || return $?
-[ -r "$IMGFILE" ] || ogRaiseError OG_ERR_NOTFOUND "$IMGFILE" || return $?
-case "$IMGTYPE" in
-    img) # Partimage.
-         partimage -B gui=no imginfo "$IMGFILE" 2>&1 | \
-                awk '/^Filesystem/ {sub(/\.\.+/," "); if ($2=="ntfs") print NTFS;
-                                                      else { sub(/fs$/,""); print toupper($2);} }'
-         ;;
-    pgz) # Partclone / GZip
-         gzip -dc "$IMGFILE" | partclone.chkimg -C -s - 2>&1 | \
-                awk '/^File system/ {if ($2=="EXTFS") print "EXT3"; else print $3;}'
-         ;;
-    *)   # Error si el fichero de imagen no es accesible.
-         ogRaiseError OG_ERR_NOTFOUND "$IMGFILE"
-         return $?  ;;
-esac
-}
-
-
-#         ogGetImageSize str_repo path_image
-#@brief   Devuelve el tamaño del sistema de archivos almacenado en un fichero de imagen.
-#@param   str_repo    repositorio de imágenes o caché local
-#@param   path_image  camino de la imagen
-#@return  int_size  - tamaño (en KB)
-#@exception OG_ERR_FORMAT   formato incorrecto.
-#@exception OG_ERR_NOTFOUND fichero de imagen no encontrado.
-#*/
-#@warning En pruebas iniciales
-#@todo    Definición de parámetros y salidas.
-#@version 0.1 - Primera versión muy en pruebas para OpenGNSys
-#@author  Ramon Gomez, ETSII Universidad de Sevilla
-#@date    2009/09/11
-#*/ ##
-function ogGetImageSizeUS ()
-{
-# Variables locales
-local IMGFILE IMGTYPE
-
-# Si se solicita, mostrar ayuda.
-if [ "$*" == "help" ]; then
-    ogHelp "$FUNCNAME" "$FUNCNAME path_dir str_image int_ndisk int_npart" \
-           "$FUNCNAME 1 1 REPO /aula1/winxp  ==>  5642158"
-    return
-fi
-# Error si no se reciben menos de 2 parámetros.
-[ $# -ne 2 ] && ogRaiseError $OG_ERR_FORMAT && return $?
-# Devuelve el tamaño de la imagen en KB.
-IMGTYPE=$(ogGetImageType "$1" "$2")
-IMGFILE=$(ogGetPath "$1" "$2.$IMGTYPE")
-case "$IMGTYPE" in
-    img) # Partimage.
-         partimage -B gui=no imginfo "$IMGFILE" 2>&1 | \
-                awk '/Partition size/ {sub(/\.\.+/," "); ps=$3} END {print ps*1024*1024;}'
-         ;;
-    pgz) # Partclone / GZip
-         gzip -dc "$IMGFILE" | partclone.chkimg -C -s - 2>&1 | \
-                awk -F: '/Block size/ {bs=$2} /Used block/ {ub=$2} END {print bs*ub/1024}'
-         ;;
-    *)   # Error si el fichero de imagen no es accesible.
-         ogRaiseError OG_ERR_NOTFOUND "$IMGFILE"
-         return $?  ;;
-esac
-}
-
--- a/client/engine/PostConf.lib
+++ b/client/engine/PostConf.lib
@ -26,7 +26,6 @@
 #@author  Jonathan Alonso Martinez - Universidad Autonoma de Barcelona
 #@date    2012-04-16
 #*/ ##
-
 function ogAddCmd ()
 {
 local MOUNTPOINT CMDFILE
@ -69,7 +68,6 @@ EOF
 #@author  Jonathan Alonso Martinez - Universidad Autonoma de Barcelona
 #@date    2012-04-16
 #*/ ##
-
 function ogDomainScript ()
 {
 local CMDDIR
@ -91,7 +89,7 @@ CMDDIR=$(ogGetPath "$MOUNTPOINT/windows/system32")
 # Añadimos en el cmd que se ejecutara al arranque, el comando de ejecutar el script que añade al dominio.
 ogAddCmd $1 $2 "$3" "CSCRIPT joindomain.vbs"
 # Eliminamos el script porque tiene el usuario de administrador de dominio en claro
-ogAddCmd $1 $2 "$3" "del /Q C:\Windows\System32\joindomain.vbs"
+ogAddCmd $1 $2 "$3" "DEL /Q C:\Windows\System32\joindomain.vbs"
 # Metemos unas claves de registro para que el dominio salga seleccionado por defecto
 ogAddCmd $1 $2 "$3" "REG ADD \"HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Winlogon\" /v DefaultDomainName /t REG_SZ /d \"$3\" /f"

@ -136,7 +134,7 @@ EOF
 #@version 1.0.4 - Primera adaptación para OpenGnSys.
 #@author  Ramon Gomez, ETSII Universidad de Sevilla
 #@date    2012-04-10
-#*/
+#*/ ##
 function ogInstallLinuxClient ()
 {
 # Variables locales.
@ -195,7 +193,7 @@ ogUnlock $1 $2


 #/**
-#         ogInstallMiniSetup
+#         ogInstallMiniSetup int_ndisk int_npartition str_filename [str_admuser str_admpassword bool_autologin [str_autouser str_autopassword] ]
 #@brief   Metafunción para instalar archivo que se ejecutará en el arranque de Windows.
 #@see     ogInstallFirstBoot ogInstallRunonce
 #*/ ##
@ -344,7 +342,7 @@ ogSetRegistryValue $MOUNTPOINT software '\Microsoft\Windows NT\CurrentVersion\Wi
 #@version 1.0.4 - Primera adaptación para OpenGnSys.
 #@author  Ramon Gomez, ETSII Universidad de Sevilla
 #@date    2012-04-11
-#*/
+#*/ ##
 function ogInstallWindowsClient ()
 {
 # Variables locales.
--- a/client/shared/etc/lang.es_ES.conf
+++ b/client/shared/etc/lang.es_ES.conf
@ -69,6 +69,7 @@ MSG_ERRLOADUDEB="$MSG_ERROR: No se puede cargar el paquete udeb %s."
 MSG_LOADUDEBS="Cargar paquetes udeb."

 # Mensajes de descripción breve de las funciones de la API.
+MSG_HELP_ogAddCmd="Añade comandos al fichero creado por la función ogInstalMiniSetup."
 MSG_HELP_ogAddRegistryKey="Añade una nueva clave al registro de Windows."
 MSG_HELP_ogAddRegistryValue="Añade un nuevo valor al registro de Windows."
 MSG_HELP_ogBoot="Arranca un sistema operativo instalado."
@ -80,6 +81,8 @@ MSG_HELP_ogCreateCache="Reserva espacio para la partición de caché al final de
 MSG_HELP_ogCreateImage="Genera una imagen exacta de un sistema operativo instalado localmente."
 MSG_HELP_ogCreateMbrImage="Genera una imagen del sector de arranque (MBR)."
 MSG_HELP_ogCreatePartitions="Define la estructura de particiones de un disco."
+MSG_HELP_ogCreatePartitionTable="Genera una tabla de particiones en caso de que no sea valida."
+MSG_HELP_ogDeleteCache="Elimina la partición de caché local."
 MSG_HELP_ogDeleteFile="Borra un fichero de un espacio de almacenamiento."
 MSG_HELP_ogDeletePartitionTable="Elimina la tabla de particiones del disco"
 MSG_HELP_ogDeleteRegistryKey="Borra una clave vacía del registro de Windows."
@ -96,20 +99,25 @@ MSG_HELP_ogFormatFs=$MSG_HELP_ogFormat
 MSG_HELP_ogGetArch="Devuelve el tipo de arquitectura del cliente."
 MSG_HELP_ogGetCacheSize="Devuelve el tamaño de la partición de caché local."
 MSG_HELP_ogGetCacheSpace="Devuelve el espacio máximo disponible que puede ser reservado para la partición de caché local."
+MSG_HELP_ogGetDiskSize="Devuelve el tamaño del disco."
 MSG_HELP_ogGetFsSize="Devuelve el tamaño de un sistema de archivos."
 MSG_HELP_ogGetFsType="Devuelve el mnemónico de tipo de sistema de archivos."
+MSG_HELP_ogGetGroupDir="Devuelve el cmaino del directorio por defecto para el grupo del cliente."
+MSG_HELP_ogGetGroupName="Devuelve el nombre del grupo al que pertenece el cliente."
 MSG_HELP_ogGetHivePath="Devuelve el camino completo del fichero de una sección del registro de Windows."
 MSG_HELP_ogGetHostname="Devuelve el nombre de la máquina local."
 MSG_HELP_ogGetIpAddress="Devuelve la dirección IP del cliente."
 MSG_HELP_ogGetImageSize="Devuelve el tamaño de una imagen de sistema."
+MSG_HELP_ogGetLastSector="Devuelve el último sector usable del disco o de una partición."
 MSG_HELP_ogGetMacAddress="Devuelve la dirección Ethernet del cliente."
 MSG_HELP_ogGetMountPoint="Devuelve el directorio donde está montado un sistema de archivos local."
 MSG_HELP_ogGetOsType="Devuelve el tipo de un sistema operativo instalado."
 MSG_HELP_ogGetOsVersion="Devuelve el tipo y la versión de un sistema operativo instalado."
-MSG_HELP_ogGetParentPath=$"Devuelve el camino completo del directorio padre de un fichero de sistema OpenGnSys."
+MSG_HELP_ogGetParentPath="Devuelve el camino completo del directorio padre de un fichero de sistema OpenGnSys."
 MSG_HELP_ogGetPartitionActive="Indica cual es la partición marcada como activa en un disco."
 MSG_HELP_ogGetPartitionId="Devuelve el identificador de tipo de una partición."
 MSG_HELP_ogGetPartitionSize="Devuelve el tamaño de una partición."
+MSG_HELP_ogGetPartitionTableType="Devuelve el tipo de tabla de particiones del disco"
 MSG_HELP_ogGetPartitionType="Devuelve el mnemónico de tipo de una partición."
 MSG_HELP_ogGetPath="Devuelve el camino completo de un fichero de sistema OpenGnSys."
 MSG_HELP_ogGetRegistryValue="Devuelve el dato de un valor del registro de Windows."
@ -119,6 +127,9 @@ MSG_HELP_ogGetWindowsName="Devuelve el nombre del cliente guardado en el registr
 MSG_HELP_ogHelp="Muestra mensajes de ayudas para las funciones."
 MSG_HELP_ogHidePartition="Oculta una partición de Windows."
 MSG_HELP_ogIdToType="Devuelve el mnemónico asociado al identificador de tipo de partición."
+MSG_HELP_ogInstallLinuxClient="Instala el cliente OpenGnSys en un sistema operativo GNU/Linux."
+MSG_HELP_ogInstallMiniSetup="Instala un archivo que se ejecutará en el arranque de Windows."
+MSG_HELP_ogInstallWindowsClient="Instala el cliente OpenGnSys en un sistema operativo Window."
 MSG_HELP_ogIsFormated="Comprueba si un sistema de archivos está formateado."
 MSG_HELP_ogIsLocked="Comprueba si una partición está bloqueada por una operación de uso exclusivo."
 MSG_HELP_ogIsImageLocked="Comprueba si una imagen está bloqueada por una operación de uso exclusivo."
@ -164,10 +175,10 @@ MSG_HELP_ogUpdatePartitionTable="Actualiza informacion tabla particiones del dis


 # Mensajes de descripción breve de la interfaz.
-MSG_INTERFACE_START="[START Interface ] Ejecutar comando: "
+MSG_INTERFACE_START="[START Interface] Ejecutar comando: "
 MSG_INTERFACE_END="[END Interface] Comando terminado con este código: "

-# SCRIPTS  messages.
+# Mensajes de scripts.
 MSG_SCRIPTS_START=" INICIO scripts : "
 MSG_SCRIPTS_END=" FIN scripts: "

@ -175,11 +186,11 @@ MSG_SCRIPTS_TASK_SLEEP="Esperando para iniciar"
 MSG_SCRIPTS_TASK_START="Iniciando"
 MSG_SCRIPTS_TASK_ERR="Error"

-# scripts createImage
+# Script createImage.
 MSG_SCRIPTS_FILE_RENAME=" Renombrar fichero-imagen previo: "
 MSG_SCRIPTS_CREATE_SIZE=" Calcular espacio (KB) requerido para almacenarlo y el disponible: "

-#scripts updateCache
+# Script updateCache.
 MSG_SCRIPTS_UPDATECACHE_DOUPDATE="Comprobamos si Actualizacion - existe una imagen con igual nombre pero distinto sum-"
 MSG_SCRIPTS_UPDATECACHE_CHECKSIZECACHE="Comprobar que el tamaño de la cache es mayor que el fichero a descargar."
 MSG_SCRIPTS_UPDATECACHE_IFNOTCACHEDO="Comprobar el espacio libre de la cache y actuar según engine.cfg"
@ -197,5 +208,6 @@ MSG_SCRIPTS_OS_CONFIGURE="Iniciar la configuracion del sistema restaurado"
 MSG_SCRIPTS_TIME_TOTAL="tiempo total del proceso"
 MSG_SCRIPTS_TIME_PARTIAL="tiempo parcial del subproceso"

-#HTTPLOG
+# HTTPLOG
 MSG_HTTPLOG_NOUSE="No apague este ordenador por favor"
+