From 4de5d450bd8de3f5c4699d5613c6d595ef13c4e4 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Dec 02 2010 16:16:40 +0000 Subject: Update function names inside Manual functionality files. --- diff --git a/Scripts/Bash/Functions/Manual/manual.sh b/Scripts/Bash/Functions/Manual/manual.sh index f0f33d3..3208279 100755 --- a/Scripts/Bash/Functions/Manual/manual.sh +++ b/Scripts/Bash/Functions/Manual/manual.sh @@ -1,8 +1,8 @@ #!/bin/bash # -# help.sh -- This function provides documentation features to +# manual.sh -- This function provides documentation features to # centos-art.sh script. Here we initialize documentation variables and -# call help_getActions functions. +# call manual_getActions functions. # # Copyright (C) 2009, 2010 Alain Reguera Delgado # @@ -25,7 +25,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help { +function manual { # Define documentation base directory structure. MANUALS_DIR[0]='/home/centos/artwork/trunk/Manuals' @@ -58,7 +58,7 @@ function help { MANUALS_FILE[11]=${MANUALS_DIR[2]}/repository-chapter-index.texi # Define documentation entry. - ENTRY=$(help_getEntry) + ENTRY=$(manual_getEntry) # Define directory used to store chapter's documentation entries. # At this point, we need to take a desition about @@ -77,6 +77,6 @@ function help { CHAPTERNAME=$(basename $ENTRYCHAPTER) # Initialize documentation functions and path patterns. - help_getActions + manual_getActions } diff --git a/Scripts/Bash/Functions/Manual/manual_checkChapter.sh b/Scripts/Bash/Functions/Manual/manual_checkChapter.sh index 6422bac..5795624 100755 --- a/Scripts/Bash/Functions/Manual/manual_checkChapter.sh +++ b/Scripts/Bash/Functions/Manual/manual_checkChapter.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_checkChapter.sh -- This function checks chapter structure. If +# manual_checkChapter.sh -- This function checks chapter structure. If # it doesn't exist, create it. Inside CentOS Artwork Repository # chapters are the base structure used to organize documentation. # @@ -25,7 +25,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_checkChapter { +function manual_checkChapter { # Check chapter's directory existence. if [[ ! -d $ENTRYCHAPTER ]];then @@ -34,9 +34,9 @@ function help_checkChapter { cli_printMessage "$ENTRYCHAPTER" "AsResponseLine" cli_printMessage "`gettext "Do you want to continue?"`" "AsYesOrNoRequestLine" - help_updateChaptersFiles - help_updateChaptersMenu - help_updateChaptersNodes + manual_updateChaptersFiles + manual_updateChaptersMenu + manual_updateChaptersNodes fi diff --git a/Scripts/Bash/Functions/Manual/manual_checkEntry.sh b/Scripts/Bash/Functions/Manual/manual_checkEntry.sh index 4ad11d0..c51341a 100755 --- a/Scripts/Bash/Functions/Manual/manual_checkEntry.sh +++ b/Scripts/Bash/Functions/Manual/manual_checkEntry.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_checkEntry.sh -- This function checks the documentation entry +# manual_checkEntry.sh -- This function checks the documentation entry # existence. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,7 +24,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_checkEntry { +function manual_checkEntry { # Check entry to edit and create it if it doesn't exist. if [[ ! -f $ENTRY ]];then @@ -33,7 +33,7 @@ function help_checkEntry { cli_printMessage "$ENTRY" "AsResponseLine" cli_printMessage "`gettext "Do you want to continue?"`" "AsYesOrNoRequestLine" - help_createEntry + manual_createEntry fi diff --git a/Scripts/Bash/Functions/Manual/manual_checkLanguageLayout.sh b/Scripts/Bash/Functions/Manual/manual_checkLanguageLayout.sh index e75b9e4..b412f73 100755 --- a/Scripts/Bash/Functions/Manual/manual_checkLanguageLayout.sh +++ b/Scripts/Bash/Functions/Manual/manual_checkLanguageLayout.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_checkLanguageLayout.sh -- This function checks the language +# manual_checkLanguageLayout.sh -- This function checks the language # layout used to store texinfo documentation inside CentOS Artwork # Repository. If the language layout doesn't exists inside the # documentation structure, ask the user to create it. @@ -26,7 +26,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_checkLanguageLayout { +function manual_checkLanguageLayout { if [[ ! -d ${MANUALS_DIR[2]} ]];then @@ -34,7 +34,7 @@ function help_checkLanguageLayout { cli_printMessage "${MANUALS_DIR[2]}" "AsResponseLine" cli_printMessage "`gettext "Do you want to continue?"`" "AsYesOrNoRequestLine" - help_createLanguageLayout + manual_createLanguageLayout cli_commitRepoChanges fi diff --git a/Scripts/Bash/Functions/Manual/manual_createEntry.sh b/Scripts/Bash/Functions/Manual/manual_createEntry.sh index 820ffc5..5871ddb 100755 --- a/Scripts/Bash/Functions/Manual/manual_createEntry.sh +++ b/Scripts/Bash/Functions/Manual/manual_createEntry.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_createEntry.sh -- This function creates a new documentation +# manual_createEntry.sh -- This function creates a new documentation # entry based on action value (ACTIONVAL). # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,15 +24,15 @@ # $Id$ # ---------------------------------------------------------------------- -function help_createEntry { +function manual_createEntry { # Check chapter structure for this entry. - help_checkChapter + manual_checkChapter # Update chapter-menu for this entry. - help_updateMenu + manual_updateMenu # Update chapter-nodes (based on chapter-menu). - help_updateNodes + manual_updateNodes } diff --git a/Scripts/Bash/Functions/Manual/manual_createLanguageLayout.sh b/Scripts/Bash/Functions/Manual/manual_createLanguageLayout.sh index a194ad8..cce9ef1 100755 --- a/Scripts/Bash/Functions/Manual/manual_createLanguageLayout.sh +++ b/Scripts/Bash/Functions/Manual/manual_createLanguageLayout.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_createLanguageLayout.sh -- This function creates texinfo's main +# manual_createLanguageLayout.sh -- This function creates texinfo's main # documentation structure for an specific language. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -22,7 +22,7 @@ # # ---------------------------------------------------------------------- -function help_createLanguageLayout { +function manual_createLanguageLayout { # Define variables as local to avoid conflicts outside local COUNTER=0 diff --git a/Scripts/Bash/Functions/Manual/manual_editEntry.sh b/Scripts/Bash/Functions/Manual/manual_editEntry.sh index faa3d03..ffe178d 100755 --- a/Scripts/Bash/Functions/Manual/manual_editEntry.sh +++ b/Scripts/Bash/Functions/Manual/manual_editEntry.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_editEntry.sh -- This function edits documentation entry based +# manual_editEntry.sh -- This function edits documentation entry based # on entry pattern. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,21 +24,21 @@ # $Id$ # ---------------------------------------------------------------------- -function help_editEntry { +function manual_editEntry { # Check chapter existence. In order to create/edit a section the # chapter of that section needs to exist first. If the chapter # hasn't been created, where are you going to store the section # files? Put the chapter's checker here. - help_checkChapter + manual_checkChapter # Check section existence. - help_checkEntry + manual_checkEntry # Use default text editor to edit the documentation entry. eval $EDITOR $ENTRY # Re-build output files to propagate recent changes. - help_updateOutputFiles + manual_updateOutputFiles } diff --git a/Scripts/Bash/Functions/Manual/manual_getActions.sh b/Scripts/Bash/Functions/Manual/manual_getActions.sh index 0316987..9ac3205 100755 --- a/Scripts/Bash/Functions/Manual/manual_getActions.sh +++ b/Scripts/Bash/Functions/Manual/manual_getActions.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_getActions.sh -- This function initializes documentation +# manual_getActions.sh -- This function initializes documentation # functionalities, using action value as reference. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,30 +24,30 @@ # $Id$ # ---------------------------------------------------------------------- -function help_getActions { +function manual_getActions { - help_checkLanguageLayout + manual_checkLanguageLayout case $ACTIONNAM in --search ) - help_searchIndex + manual_searchIndex ;; --edit ) - help_editEntry + manual_editEntry ;; --remove ) - help_removeEntry + manual_removeEntry ;; --update ) - help_updateOutputFiles + manual_updateOutputFiles ;; --read ) - help_searchNode + manual_searchNode ;; * ) diff --git a/Scripts/Bash/Functions/Manual/manual_getEntry.sh b/Scripts/Bash/Functions/Manual/manual_getEntry.sh index 5b83bd4..2af6bdc 100755 --- a/Scripts/Bash/Functions/Manual/manual_getEntry.sh +++ b/Scripts/Bash/Functions/Manual/manual_getEntry.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_getEntry.sh -- This function builds a documentation entry based +# manual_getEntry.sh -- This function builds a documentation entry based # on action value (ACTIONVAL) variable. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,7 +24,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_getEntry { +function manual_getEntry { # Define variables as local to avoid conflicts outside. local DIR='' diff --git a/Scripts/Bash/Functions/Manual/manual_getNode.sh b/Scripts/Bash/Functions/Manual/manual_getNode.sh index 8799ba4..e80b4dc 100755 --- a/Scripts/Bash/Functions/Manual/manual_getNode.sh +++ b/Scripts/Bash/Functions/Manual/manual_getNode.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_getNode.sh -- This function cleans up the action value +# manual_getNode.sh -- This function cleans up the action value # (ACTIONVAL) directory to make a node name from it. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,7 +24,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_getNode { +function manual_getNode { local NODE=$(echo "$ACTIONVAL" \ | sed -r 's!^/home/centos/artwork/!!' \ diff --git a/Scripts/Bash/Functions/Manual/manual_removeEntry.sh b/Scripts/Bash/Functions/Manual/manual_removeEntry.sh index 6dc779d..db93d92 100755 --- a/Scripts/Bash/Functions/Manual/manual_removeEntry.sh +++ b/Scripts/Bash/Functions/Manual/manual_removeEntry.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_removeEntry.sh -- This function removes a documentation entry +# manual_removeEntry.sh -- This function removes a documentation entry # from your working copy documentation structure. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,7 +24,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_removeEntry { +function manual_removeEntry { # Define variables as local to avoid conflicts outside. local ENTRIES='' @@ -46,7 +46,7 @@ function help_removeEntry { # Re-define location to match the chapter's root directory. This # applies when you try to remove the whole chapter from the - # working copy (e.g., centos-art help --remove=/home/centos/artwork/trunk/). + # working copy (e.g., centos-art manual --remove=/home/centos/artwork/trunk/). if [[ $ENTRY =~ "${MANUALS_FILE[7]}$" ]];then LOCATION=$(dirname $ENTRY) fi @@ -124,8 +124,8 @@ function help_removeEntry { # Update section's menu and nodes to reflect the fact that # documentation entry has been removed. - help_updateMenu "remove-entry" - help_updateNodes + manual_updateMenu "remove-entry" + manual_updateNodes done @@ -133,11 +133,11 @@ function help_removeEntry { # This is mainly applied when one of the chapters (e.g., trunk/, # tags/, or branches/) is removed. if [[ ! -d $ENTRYCHAPTER ]];then - help_updateChaptersMenu 'remove-entry' - help_updateChaptersNodes + manual_updateChaptersMenu 'remove-entry' + manual_updateChaptersNodes fi # Update manuals' related output files. - help_updateOutputFiles + manual_updateOutputFiles } diff --git a/Scripts/Bash/Functions/Manual/manual_searchIndex.sh b/Scripts/Bash/Functions/Manual/manual_searchIndex.sh index c18db53..6c97652 100644 --- a/Scripts/Bash/Functions/Manual/manual_searchIndex.sh +++ b/Scripts/Bash/Functions/Manual/manual_searchIndex.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_searchIndex.sh -- This function does an index search inside the +# manual_searchIndex.sh -- This function does an index search inside the # info document. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,7 +24,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_searchIndex { +function manual_searchIndex { # Define search pattern format. local PATTERN='^[[:alnum:],]+$' diff --git a/Scripts/Bash/Functions/Manual/manual_searchNode.sh b/Scripts/Bash/Functions/Manual/manual_searchNode.sh index 0b20a6c..f85e8df 100755 --- a/Scripts/Bash/Functions/Manual/manual_searchNode.sh +++ b/Scripts/Bash/Functions/Manual/manual_searchNode.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_searchNode.sh -- This function does a node search inside the +# manual_searchNode.sh -- This function does a node search inside the # info document. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,15 +24,15 @@ # $Id$ # ---------------------------------------------------------------------- -function help_searchNode { +function manual_searchNode { # Check entry inside documentation structure. If the entry # exits use the info reader to open the info file at the # specified node. Otherwise, ask the user for create it. if [[ -f "$ENTRY" ]];then - /usr/bin/info --node="$(help_getNode)" --file=${MANUALS_FILE[4]} + /usr/bin/info --node="$(manual_getNode)" --file=${MANUALS_FILE[4]} else - help_editEntry + manual_editEntry fi } diff --git a/Scripts/Bash/Functions/Manual/manual_updateChaptersFiles.sh b/Scripts/Bash/Functions/Manual/manual_updateChaptersFiles.sh index d857e36..3cf5013 100755 --- a/Scripts/Bash/Functions/Manual/manual_updateChaptersFiles.sh +++ b/Scripts/Bash/Functions/Manual/manual_updateChaptersFiles.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_updateChaptersFiles.sh -- This function updates chapter related +# manual_updateChaptersFiles.sh -- This function updates chapter related # files. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,7 +24,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_updateChaptersFiles { +function manual_updateChaptersFiles { # Define chapter's generic structure. local CHAPTERBODY="\ diff --git a/Scripts/Bash/Functions/Manual/manual_updateChaptersMenu.sh b/Scripts/Bash/Functions/Manual/manual_updateChaptersMenu.sh index d3a61b4..34ac8b3 100755 --- a/Scripts/Bash/Functions/Manual/manual_updateChaptersMenu.sh +++ b/Scripts/Bash/Functions/Manual/manual_updateChaptersMenu.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_updateChaptersMenu.sh - This function updates chapter menu. +# manual_updateChaptersMenu.sh - This function updates chapter menu. # # Copyright (C) 2009, 2010 Alain Reguera Delgado # @@ -23,7 +23,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_updateChaptersMenu { +function manual_updateChaptersMenu { local ACTION=$1 local MENUCHAPTERS='' diff --git a/Scripts/Bash/Functions/Manual/manual_updateChaptersNodes.sh b/Scripts/Bash/Functions/Manual/manual_updateChaptersNodes.sh index 2459151..65489de 100755 --- a/Scripts/Bash/Functions/Manual/manual_updateChaptersNodes.sh +++ b/Scripts/Bash/Functions/Manual/manual_updateChaptersNodes.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_updateChaptersNodes.sh - This function updates nodes of +# manual_updateChaptersNodes.sh - This function updates nodes of # chapters based on menu of chapters. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,7 +24,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_updateChaptersNodes { +function manual_updateChaptersNodes { # Build list "nodes of chapters" based on menu of chapters. local CHAPTERNODES=$(cat ${MANUALS_FILE[2]} \ diff --git a/Scripts/Bash/Functions/Manual/manual_updateMenu.sh b/Scripts/Bash/Functions/Manual/manual_updateMenu.sh index 625a04d..0231aea 100755 --- a/Scripts/Bash/Functions/Manual/manual_updateMenu.sh +++ b/Scripts/Bash/Functions/Manual/manual_updateMenu.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_updateMenu.sh -- This function updates menu lines inside +# manual_updateMenu.sh -- This function updates menu lines inside # texinfo chapters. If this function is called with the # 'remove-entry' string as first argument, then the menu line related # to the entry being processed is removed. If this function is called @@ -30,7 +30,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_updateMenu { +function manual_updateMenu { # Specify which action to do inside chapter's menu. local ACTION="$1" @@ -58,7 +58,7 @@ function help_updateMenu { ;; 'update-entry' | * ) # Add menu line to chapter's menu. This is the default - # behaivour if no argument is passed to help_updateMenu + # behaivour if no argument is passed to manual_updateMenu # function. MENU="$MENU $MENULINE" diff --git a/Scripts/Bash/Functions/Manual/manual_updateNodes.sh b/Scripts/Bash/Functions/Manual/manual_updateNodes.sh index 4e127ea..9d196ea 100755 --- a/Scripts/Bash/Functions/Manual/manual_updateNodes.sh +++ b/Scripts/Bash/Functions/Manual/manual_updateNodes.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_updateNodes.sh -- This function updates chapter's nodes +# manual_updateNodes.sh -- This function updates chapter's nodes # definition using the chapter's menu as reference. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,7 +24,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_updateNodes { +function manual_updateNodes { # Retrive nodes' entries from chapter-menu.texi file. local NODES=$(cat $ENTRYCHAPTER/${MANUALS_FILE[8]} \ diff --git a/Scripts/Bash/Functions/Manual/manual_updateOutputFileHtml.sh b/Scripts/Bash/Functions/Manual/manual_updateOutputFileHtml.sh index ef961a4..ed5e4f6 100755 --- a/Scripts/Bash/Functions/Manual/manual_updateOutputFileHtml.sh +++ b/Scripts/Bash/Functions/Manual/manual_updateOutputFileHtml.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_updateOutputFileHtml.sh -- This function updates manuals' html +# manual_updateOutputFileHtml.sh -- This function updates manuals' html # related output files. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,7 +24,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_updateOutputFileHtml { +function manual_updateOutputFileHtml { # Output action message cli_printMessage "`gettext "Updating manual's html output"`" 'AsResponseLine' diff --git a/Scripts/Bash/Functions/Manual/manual_updateOutputFileInfo.sh b/Scripts/Bash/Functions/Manual/manual_updateOutputFileInfo.sh index 43f7951..053bb9c 100755 --- a/Scripts/Bash/Functions/Manual/manual_updateOutputFileInfo.sh +++ b/Scripts/Bash/Functions/Manual/manual_updateOutputFileInfo.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_updateOutputFileInfo.sh -- This function updates manual's info +# manual_updateOutputFileInfo.sh -- This function updates manual's info # output related file. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,7 +24,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_updateOutputFileInfo { +function manual_updateOutputFileInfo { # Output action message. cli_printMessage "`gettext "Updating manual's info output"`" 'AsResponseLine' diff --git a/Scripts/Bash/Functions/Manual/manual_updateOutputFilePlaintext.sh b/Scripts/Bash/Functions/Manual/manual_updateOutputFilePlaintext.sh index b6bdb1b..74a5506 100755 --- a/Scripts/Bash/Functions/Manual/manual_updateOutputFilePlaintext.sh +++ b/Scripts/Bash/Functions/Manual/manual_updateOutputFilePlaintext.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_updateOutputFilePlaintext.sh -- This function updates manuals' +# manual_updateOutputFilePlaintext.sh -- This function updates manuals' # plaintext related output file. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,7 +24,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_updateOutputFilePlaintext { +function manual_updateOutputFilePlaintext { # Output action message. cli_printMessage "`gettext "Updating manual's plaintext output"`" 'AsResponseLine' diff --git a/Scripts/Bash/Functions/Manual/manual_updateOutputFiles.sh b/Scripts/Bash/Functions/Manual/manual_updateOutputFiles.sh index 6a95ed0..9df3763 100755 --- a/Scripts/Bash/Functions/Manual/manual_updateOutputFiles.sh +++ b/Scripts/Bash/Functions/Manual/manual_updateOutputFiles.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# help_updateOutputFiles.sh -- This function updates manuals' related +# manual_updateOutputFiles.sh -- This function updates manuals' related # output files. # # Copyright (C) 2009, 2010 Alain Reguera Delgado @@ -24,7 +24,7 @@ # $Id$ # ---------------------------------------------------------------------- -function help_updateOutputFiles { +function manual_updateOutputFiles { # Add division line to differentiate action output visually. echo '----------------------------------------------------------------------' @@ -34,16 +34,16 @@ function help_updateOutputFiles { # paths incorrectly. pushd /home/centos/artwork > /dev/null - help_updateOutputFileInfo - help_updateOutputFileHtml - help_updateOutputFilePlaintext + manual_updateOutputFileInfo + manual_updateOutputFileHtml + manual_updateOutputFilePlaintext # Remove the working copy root directory from directory stack. popd > /dev/null # Re-define output variable in order for cli_commitRepoChanges # functionality to receive the correct location to apply - # subversion commands. Inside `help' functionality, the correct + # subversion commands. Inside `manual' functionality, the correct # place to commit changes is not the initial value of ACTIONVAL # but the directory path where documentation changes take place # under.