From 872b044f789626b5532748c88fd9d26f551f0c3d Mon Sep 17 00:00:00 2001 From: adv Date: Thu, 5 Jul 2018 01:11:58 +0200 Subject: #853 Adapting Boot.lib library for doxygen --- client/engine/Boot.lib | 85 ++++++++++++++++++++++++++++++++------------------ 1 file changed, 54 insertions(+), 31 deletions(-) diff --git a/client/engine/Boot.lib b/client/engine/Boot.lib index dfbda10d..e9ddf38e 100755 --- a/client/engine/Boot.lib +++ b/client/engine/Boot.lib @@ -625,6 +625,8 @@ ps aux > /dev/null | grep $! | grep -E "T|S" | kill -9 $! > /dev/null } + +#/** # ogWindowsRegisterPartition int_ndisk int_partiton str_volume int_disk int_partition #@brief Registra una partición en windows con un determinado volumen. #@param int_ndisk nº de orden del disco a registrar @@ -699,7 +701,7 @@ ps aux > /dev/null | grep $! | grep -E "T|S" | kill -9 $! > /dev/null } - +#/** # ogGrubInstallMbr int_disk_GRUBCFG int_partition_GRUBCFG #@brief Instala el grub el el MBR del primer disco duro (FIRSTSTAGE). El fichero de configuración grub.cfg ubicado según parametros disk y part(SECONDSTAGE). Admite sistemas Windows. #@param int_disk_SecondStage @@ -804,7 +806,7 @@ grub-install --force --root-directory=${SECONDSTAGE}${PREFIXSECONDSTAGE} $FIRSTS } - +#/** # ogGrubInstallPartition int_disk_SECONDSTAGE int_partition_SECONDSTAGE bolean_Check_Os_installed_and_Configure_2ndStage #@brief Instala y actualiza el gestor grub en el bootsector de la particion indicada #@param int_disk_SecondStage @@ -955,9 +957,7 @@ fi } -### -#En pruebas -## + #/** # ogSetLinuxName int_ndisk int_nfilesys [str_name] #@brief Establece el nombre del equipo en los ficheros hostname y hosts. @@ -1081,9 +1081,7 @@ MNTDIR=$(ogMount $1 $2) || return $? #@author Antonio J. Doblas Viso. Universidad de Malaga. #@date 2017-06-17 #*/ ## -#*/ ## -#*/ function ogGrubAddOgLive () { @@ -1153,8 +1151,9 @@ MENUENTRY="menuentry "OpenGnsys" --class opengnsys --class gnu --class os { \n #/** # ogGrubHidePartitions num_disk num_part +#@brief ver ogBootLoaderHidePartitions #@see ogBootLoaderHidePartitions -#*/ +#*/ ## function ogGrubHidePartitions () { # Si se solicita, mostrar ayuda. @@ -1169,8 +1168,9 @@ function ogGrubHidePartitions () #/** # ogBurgHidePartitions num_disk num_part +#@brief ver ogBootLoaderHidePartitions #@see ogBootLoaderHidePartitions -#*/ +#*/ ## function ogBurgHidePartitions () { # Si se solicita, mostrar ayuda. @@ -1197,7 +1197,11 @@ function ogBurgHidePartitions () #@version 1.1 Se generaliza la función para grub y burg #@author Irina Gomez, ETSII Universidad de Sevilla #@date 2017-10-20 +#@version 1.1.1 Se incluye comentarios en codigo para autodocuemtnacion con Doxygen +#@author Antonio J. Doblas Viso, EVLT Univesidad de Malaga. +#@date 2018-07-05 #*/ + function ogBootLoaderHidePartitions () { local FUNC DIRMOUNT GFCFILE PARTTABLETYPE WINENTRY ENTRY PART TEXT LINE2 PART2 HIDDEN @@ -1241,9 +1245,10 @@ function ogBootLoaderHidePartitions () sed -i '/parttool/d' $CFGFILE PARTTABLETYPE=$(ogGetPartitionTableType $1 | tr [:upper:] [:lower:]) - +# /* (comentario de bloque para Doxygen) # Entradas de Windows: numero de linea y particion. De mayor a menor. WINENTRY=$(awk '/menuentry.*Windows/ {gsub(/\)\"/, ""); print NR":"$6} ' $CFGFILE | sed -e '1!G;h;$!d' -e s/[a-z\/]//g) + #*/ (comentario para bloque Doxygen) # Particiones de Windows, pueden no estar en el grub. WINPART=$(fdisk -l $(ogDiskToDev $1)|awk '/NTFS/ {print substr($1,9,1)}' |sed '1!G;h;$!d') # Modifico todas las entradas de Windows. @@ -1269,7 +1274,8 @@ function ogBootLoaderHidePartitions () #/** # ogGrubDeleteEntry num_disk num_part num_disk_delete num_part_delete -#@see ogBootLoaderDeleteEntry +#@brief ver ogBootLoaderDeleteEntry +#@see ogBootLoaderDeleteEntry #*/ function ogGrubDeleteEntry () { @@ -1285,6 +1291,7 @@ function ogGrubDeleteEntry () #/** # ogBurgDeleteEntry num_disk num_part num_disk_delete num_part_delete +#@brief ver ogBootLoaderDeleteEntry #@see ogBootLoaderDeleteEntry #*/ function ogBurgDeleteEntry () @@ -1314,7 +1321,8 @@ function ogBurgDeleteEntry () #@version 1.1 Se generaliza la función para grub y burg #@author Irina Gomez, ETSII Universidad de Sevilla #@date 2017-10-20 -#*/ +#*/ ## + function ogBootLoaderDeleteEntry () { local FUNC DIRMOUNT CFGFILE DEVICE MENUENTRY DELETEENTRY ENDENTRY ENTRY @@ -1378,7 +1386,7 @@ function ogBootLoaderDeleteEntry () done } - +#/** # ogBurgInstallMbr int_disk_GRUBCFG int_partition_GRUBCFG #@param bolean_Check_Os_installed_and_Configure_2ndStage true | false[default] #@brief Instala y actualiza el gestor grub en el MBR del disco duro donde se encuentra el fichero grub.cfg. Admite sistemas Windows. @@ -1397,6 +1405,9 @@ function ogBootLoaderDeleteEntry () #@version 1.1.0 - Refactorizar fichero de configuacion #@author Antonio J. Doblas Viso. Universidad de Malaga. #@date 2018-01-24 +#@version 1.1.1 - Se incluye comentarios en codigo para autodocuemtnacion con Doxygen +#@author Antonio J. Doblas Viso. Universidad de Malaga. +#@date 2018-07-05 #*/ ## function ogBurgInstallMbr () @@ -1433,7 +1444,7 @@ FIRSTSTAGE=$(ogDiskToDev 1) SECONDSTAGE=$(ogMount $DISK $PART) # prepara el directorio principal de la segunda etapa (y copia los binarios) -[ -d ${SECONDSTAGE}/boot/burg/ ] || mkdir -p ${SECONDSTAGE}/boot/burg/; cp -prv /boot/burg/* ${SECONDSTAGE}/boot/burg/ 2>&1>/dev/null; cp -prv $OGLIB/burg/* ${SECONDSTAGE}/boot/burg/ 2>&1>/dev/null; +[ -d ${SECONDSTAGE}/boot/burg/ ] || mkdir -p ${SECONDSTAGE}/boot/burg/; cp -prv /boot/burg/* ${SECONDSTAGE}/boot/burg/ 2>&1>/dev/null; cp -prv $OGLIB/burg/* ${SECONDSTAGE}/boot/burg/ 2>&1>/dev/null; #*/ ## (comentario Dogygen) #*/ ## (comentario Dogygen) #Copiamos el tema mkdir -p ${SECONDSTAGE}/boot/burg/themes/OpenGnsys @@ -1470,6 +1481,7 @@ mkdir -p ${SECONDSTAGE}${PREFIXSECONDSTAGE}/boot/burg/ FILECFG=${SECONDSTAGE}${PREFIXSECONDSTAGE}/boot/burg/burg.cfg +#/* ## (comentario Dogygen) cat > "$FILECFG" << EOF set theme_name=OpenGnsys @@ -1552,7 +1564,7 @@ fi EOF - +#*/ ## (comentario Dogygen) #Preparar configuración segunda etapa: crear entrada del sistema operativo grubSyntax "$KERNELPARAM" >> "$FILECFG" @@ -1564,8 +1576,9 @@ burg-install --force --root-directory=${SECONDSTAGE} $FIRSTSTAGE 2>&1>/dev/null #/** # ogGrubDefaultEntry int_disk_GRUGCFG int_partition_GRUBCFG int_disk_default_entry int_npartition_default_entry +#@brief ver ogBootLoaderDefaultEntry #@see ogBootLoaderDefaultEntry -#*/ +#*/ ## function ogGrubDefaultEntry () { # Si se solicita, mostrar ayuda. @@ -1580,8 +1593,9 @@ function ogGrubDefaultEntry () #/** # ogBurgDefaultEntry int_disk_BURGCFG int_partition_BURGCFG int_disk_default_entry int_npartition_default_entry +#@brief ver ogBootLoaderDefaultEntry #@see ogBootLoaderDefaultEntry -#*/ +#*/ ## function ogBurgDefaultEntry () { # Si se solicita, mostrar ayuda. @@ -1666,17 +1680,16 @@ DEFAULTENTRY=$(grep -n -m 1 menuentry.*$DEVICE $CFGFILE| cut -d: -f1) MENUENTRY="$(grep -n -e menuentry $CFGFILE| cut -d: -f1 | grep -n $DEFAULTENTRY |cut -d: -f1)" # Las líneas empiezan a contar desde cero let MENUENTRY=$MENUENTRY-1 - sed --regexp-extended -i s/"set default=\"?[0-9]*\"?"/"set default=\"$MENUENTRY\""/g $CFGFILE - MSG="MSG_HELP_$FUNC" echo "${!MSG%%\.}: $@" } #/** # ogGrubOgliveDefaultEntry num_disk num_part +#@brief ver ogBootLoaderOgliveDefaultEntry #@see ogBootLoaderOgliveDefaultEntry -#*/ +#*/ ## function ogGrubOgliveDefaultEntry () { # Si se solicita, mostrar ayuda. @@ -1691,8 +1704,9 @@ function ogGrubOgliveDefaultEntry () #/** # ogBurgOgliveDefaultEntry num_disk num_part +#@brief ver ogBootLoaderOgliveDefaultEntry #@see ogBootLoaderOgliveDefaultEntry -#*/ +#*/ ## function ogBurgOgliveDefaultEntry () { # Si se solicita, mostrar ayuda. @@ -1776,8 +1790,9 @@ echo "${!MSG%%\.}: $@" #/** # ogGrubSetTheme num_disk num_part str_theme +#@brief ver ogBootLoaderSetTheme #@see ogBootLoaderSetTheme -#*/ +#*/ ## function ogGrubSetTheme () { # Si se solicita, mostrar ayuda. @@ -1793,8 +1808,9 @@ function ogGrubSetTheme () #/** # ogBurgSetTheme num_disk num_part str_theme +#@brief ver ogBootLoaderSetTheme #@see ogBootLoaderSetTheme -#*/ +#*/ ## function ogBurgSetTheme () { # Si se solicita, mostrar ayuda. @@ -1900,8 +1916,9 @@ sed --regexp-extended -i s/"$THEME"/"$NEWTHEME"/g $CFGFILE #/** # ogGrubSetAdminKeys num_disk num_part str_theme +#@brief ver ogBootLoaderSetTheme #@see ogBootLoaderSetTheme -#*/ +#*/ ## function ogGrubSetAdminKeys () { # Si se solicita, mostrar ayuda. @@ -1917,8 +1934,9 @@ function ogGrubSetAdminKeys () #/** # ogBurgSetAdminKeys num_disk num_part str_bolean +#@brief ver ogBootLoaderSetAdminKeys #@see ogBootLoaderSetAdminKeys -#*/ +#*/ ## function ogBurgSetAdminKeys () { # Si se solicita, mostrar ayuda. @@ -2015,8 +2033,9 @@ esac #/** # ogGrubSetTimeOut num_disk num_part int_timeout_seconds +#@brief ver ogBootLoaderSetTimeOut #@see ogBootLoaderSetTimeOut -#*/ +#*/ ## function ogGrubSetTimeOut () { # Si se solicita, mostrar ayuda. @@ -2032,9 +2051,11 @@ function ogGrubSetTimeOut () #/** # ogBurgSetTimeOut num_disk num_part str_bolean +#@brief ver ogBootLoaderSetTimeOut #@see ogBootLoaderSetTimeOut -#*/ -function ogBurgSetTimeOut { +#*/ ## +function ogBurgSetTimeOut () +{ # Si se solicita, mostrar ayuda. if [ "$*" == "help" ]; then ogHelp "$FUNCNAME" "$FUNCNAME int_ndiskSecondStage int_partitionSecondStage str_timeout_seconds" \ @@ -2114,8 +2135,9 @@ sed -i s/timeout=.*$/timeout=$TIMEOUT/g $CFGFILE #/** # ogGrubSetResolution num_disk num_part int_resolution +#@brief ver ogBootLoaderSetResolution #@see ogBootLoaderSetResolution -#*/ +#*/ ## function ogGrubSetResolution () { # Si se solicita, mostrar ayuda. @@ -2132,8 +2154,9 @@ function ogGrubSetResolution () #/** # ogBurgSetResolution num_disk num_part str_bolean +#@brief ver ogBootLoaderSetResolution #@see ogBootLoaderSetResolution -#*/ +#*/ ## function ogBurgSetResolution () { # Si se solicita, mostrar ayuda. @@ -2248,7 +2271,7 @@ fi sed -i s/gfxmode=.*$/gfxmode=$NEWRESOLUTION/g $CFGFILE } - +#/** # ogRefindInstall int_ndisk bool_autoconfig #@brief Instala y actualiza el gestor rEFInd en la particion EFI #@param int_ndisk -- cgit v1.2.3-18-g5258