Changeset 10443

Timestamp:

2018-12-21T15:36:36+01:00 (5 years ago)

Author:

nicolasmartin

Message:

Improve bash script to check the validity of the references included in the manual wrt to NEMO source code
manuals_checking.sh will report

• missing namelists
• vanished references (\mdl, \ngn, \nlst, \rou and \np)
• namelist parameters not following the current conventions: ^[cdlnr]n_*

File:

• NEMO/trunk/doc/bin/manuals_checking.sh (moved) (moved from NEMO/trunk/doc/bin/nlsts_check.sh) (1 diff)

NEMO/trunk/doc/bin/manuals_checking.sh

@@ -1 +1 @@
 #!/bin/sh
 
+#set -evx
+
 if [[ $* != '' ]]; then
-
-    if [[ $1 = 'all' ]]; then
-        models='NEMO SI3 TOP'
-    else
-        models=$1
-    fi
-
+    if [[ $1 = 'all' ]]; then models='NEMO SI3 TOP'; else models=$1; fi
 else
-    models='NEMO'
+    models='NEMO'
 fi
 
+extract_arg() {
+    ## $1: macro name, $2: prefix for filtering args (optional)
+    eval grep -Poh "\\$1{\\$2\\\K[^}]+" ${tex_files} | tr -d '\\' | sort -u
+}
+
 for model in $models; do
-    [[ $model =~ ^(SI3|TOP)$ ]] && continue
-    echo 'Namelists not included in the '$model' manual:'
+    [[ $model =~ ^(SI3|TOP)$ ]] && continue
 
-    for nlst in $( ls namelists ); do
+    tex_files=$( find latex/$model -type f -name *.tex )
 
-        if [[ ! $( grep "\\nlst{$nlst}" ./latex/$model/subfiles/*.tex ) ]]; then
-            printf "$nlst "
+    echo '¤ Missing namelist groups in '$model' manual'
+
+    for nlst in $( ls namelists ); do
+        [[ ! $( grep \\nlst{$nlst} ${tex_files} ) ]] && printf '%s ' $nlst
+    done
+
+    echo; echo
+    echo '¤ Vanished references in '$model' manual (\\autoref{...})'
+
+    for item in 'mdl' 'ngn' 'nlst' 'np' 'rou'; do
+        echo '- '$item':'
+        args_list=$( extract_arg $item )
+
+        for arg in ${args_list}; do
+
+            if   [[ "$item" == 'nlst' && ! -f namelists/$arg ]]; then
+                printf '%15s: ' $arg
+                grep -l \\nlst{$arg} ${tex_files} | sed 's/^.*\///'
+            elif [[ ( "$item" == 'mdl' && ! $( find ../src -type f -name $arg.[Ffh]90  ) ) || \
+                    ( "$item" == 'ngn' && ! $( grep     \&$arg             namelists/* ) ) || \
+                    ( "$item" == 'rou' && ! $( grep -ri "SUBROUTINE *$arg" ../src      ) ) || \
+                    ( "$item" == 'np'  && ! $( grep     " $arg *="         namelists/* ) )      ]]; then
+                printf '%s ' $arg
+            fi
+        
+        done
+
+        [ "$item" != 'nlst' ] && echo
+    done
+
+done
+
+echo
+echo '¤ Namelist parameters unfollowing naming conventions (^[cdlnr]n_*)'
+
+for nlst in $( ls namelists ); do
+    np_list=$( f90nml namelists/$nlst 2> /dev/null | awk '/=/ { print $1 }' )
+    array=()
+
+    for np in ${np_list}; do
+
+        if [[ ! ${np:0:3} =~ ^[cdlnr]n_$ ]]; then
+            array+=$np' '
         fi
 
     done
 
-    echo
+    if (( ${#array[@]} != 0 )); then
+        printf '%15s: ' $nlst
+        echo ${array[@]}
+    fi
 
 done