Admin/lib/Tools/build_doc
author wenzelm
Sat, 25 Jan 2014 16:35:15 +0100
changeset 55135 bc8cf4312ea7
parent 53208 bec95e287d26
child 56429 bc61161a5bd0
permissions -rwxr-xr-x
more user aliases;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
     1
#!/usr/bin/env bash
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
     2
#
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
     3
# Author: Makarius
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
     4
#
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
     5
# DESCRIPTION: build Isabelle documentation
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
     6
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
     7
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
     8
## diagnostics
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
     9
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    10
PRG="$(basename "$0")"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    11
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    12
function usage()
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    13
{
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    14
  echo
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    15
  echo "Usage: isabelle $PRG [OPTIONS] [SESSIONS ...]"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    16
  echo
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    17
  echo "  Options are:"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    18
  echo "    -a           select all doc sessions"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    19
  echo "    -j INT       maximum number of parallel jobs (default 1)"
53208
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    20
  echo "    -s           system build mode"
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    21
  echo
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    22
  echo "  Build Isabelle documentation from (doc) sessions."
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    23
  echo
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    24
  exit 1
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    25
}
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    26
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    27
function fail()
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    28
{
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    29
  echo "$1" >&2
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    30
  exit 2
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    31
}
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    32
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    33
function check_number()
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    34
{
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    35
  [ -n "$1" -a -z "$(echo "$1" | tr -d '[0-9]')" ] || fail "Bad number: \"$1\""
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    36
}
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    37
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    38
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    39
## process command line
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    40
53208
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    41
declare -a BUILD_ARGS=()
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    42
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    43
49131
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    44
# options
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    45
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    46
ALL_DOCS="false"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    47
53208
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    48
while getopts "aj:s" OPT
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    49
do
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    50
  case "$OPT" in
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    51
    a)
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    52
      ALL_DOCS="true"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    53
      ;;
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    54
    j)
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    55
      check_number "$OPTARG"
53208
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    56
      BUILD_ARGS["${#BUILD_ARGS[@]}"]="-j"
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    57
      BUILD_ARGS["${#BUILD_ARGS[@]}"]="$OPTARG"
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    58
      ;;
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    59
    s)
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    60
      BUILD_ARGS["${#BUILD_ARGS[@]}"]="-s"
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    61
      ;;
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    62
    \?)
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    63
      usage
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    64
      ;;
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    65
  esac
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    66
done
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    67
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    68
shift $(($OPTIND - 1))
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    69
49131
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    70
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    71
# arguments
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    72
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    73
if [ "$ALL_DOCS" = true ]; then
53208
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    74
  BUILD_ARGS["${#BUILD_ARGS[@]}"]="-g"
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    75
  BUILD_ARGS["${#BUILD_ARGS[@]}"]="doc"
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    76
else
49073
88fe93ae61cf tuned boundary cases of command-line;
wenzelm
parents: 49005
diff changeset
    77
  [ "$#" -eq 0 ] && usage
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    78
fi
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    79
49131
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    80
BUILD_ARGS["${#BUILD_ARGS[@]}"]="--"
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    81
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    82
while [ "$#" -ne 0 ]; do
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    83
  BUILD_ARGS["${#BUILD_ARGS[@]}"]="$1"
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    84
  shift
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    85
done
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    86
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    87
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    88
## main
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    89
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    90
OUTPUT="$ISABELLE_TMP_PREFIX$$"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    91
mkdir -p "$OUTPUT" || fail "Bad directory: \"$OUTPUT\""
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    92
53208
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    93
"$ISABELLE_TOOL" build -R -b "${BUILD_ARGS[@]}"
49131
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    94
RC=$?
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    95
52740
bceec99254b0 documentation is always in PDF;
wenzelm
parents: 49131
diff changeset
    96
if [ "$RC" = 0 ]; then
bceec99254b0 documentation is always in PDF;
wenzelm
parents: 49131
diff changeset
    97
  "$ISABELLE_TOOL" build -o browser_info=false -o "document=pdf" \
53208
bec95e287d26 prefer build_doc -s to avoid heaps left behind in $ISABELLE_HOME_USER (especially relevant to isatest);
wenzelm
parents: 52740
diff changeset
    98
    -o "document_output=$OUTPUT" -c "${BUILD_ARGS[@]}"
52740
bceec99254b0 documentation is always in PDF;
wenzelm
parents: 49131
diff changeset
    99
  RC=$?
49005
96d5e42e5e3a approximative build of pdf documents in 1 pass instead of 3;
wenzelm
parents: 49002
diff changeset
   100
fi
96d5e42e5e3a approximative build of pdf documents in 1 pass instead of 3;
wenzelm
parents: 49002
diff changeset
   101
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
   102
if [ "$RC" = 0 ]; then
52740
bceec99254b0 documentation is always in PDF;
wenzelm
parents: 49131
diff changeset
   103
  cp -f "$OUTPUT"/*.pdf "$ISABELLE_HOME/doc"
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
   104
fi
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
   105
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
   106
rm -rf "$OUTPUT"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
   107
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
   108
exit $RC