Admin/lib/Tools/build_doc
author wenzelm
Fri, 16 Aug 2013 21:33:36 +0200
changeset 53043 8cbfbeb566a4
parent 52740 bceec99254b0
child 53208 bec95e287d26
permissions -rwxr-xr-x
more standard attribute_setup / method_setup -- export key ML operations instead of parsers;
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)"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    20
  echo
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    21
  echo "  Build Isabelle documentation from (doc) sessions."
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    22
  echo
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    23
  exit 1
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    24
}
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
function fail()
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    27
{
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    28
  echo "$1" >&2
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    29
  exit 2
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    30
}
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
function check_number()
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    33
{
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    34
  [ -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
    35
}
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
## process command line
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    39
49131
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    40
# options
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    41
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    42
ALL_DOCS="false"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    43
JOBS=""
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    44
52740
bceec99254b0 documentation is always in PDF;
wenzelm
parents: 49131
diff changeset
    45
while getopts "aj:" OPT
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    46
do
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    47
  case "$OPT" in
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    48
    a)
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    49
      ALL_DOCS="true"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    50
      ;;
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    51
    j)
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    52
      check_number "$OPTARG"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    53
      JOBS="-j $OPTARG"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    54
      ;;
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    55
    \?)
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    56
      usage
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    57
      ;;
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    58
  esac
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    59
done
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    60
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    61
shift $(($OPTIND - 1))
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    62
49131
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    63
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    64
# arguments
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    65
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    66
if [ "$ALL_DOCS" = true ]; then
49131
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    67
  declare -a BUILD_ARGS=(-g doc)
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    68
else
49131
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    69
  declare -a BUILD_ARGS=()
49073
88fe93ae61cf tuned boundary cases of command-line;
wenzelm
parents: 49005
diff changeset
    70
  [ "$#" -eq 0 ] && usage
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    71
fi
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    72
49131
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    73
BUILD_ARGS["${#BUILD_ARGS[@]}"]="--"
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    74
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    75
while [ "$#" -ne 0 ]; do
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    76
  BUILD_ARGS["${#BUILD_ARGS[@]}"]="$1"
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    77
  shift
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    78
done
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    79
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    80
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    81
## main
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    82
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    83
OUTPUT="$ISABELLE_TMP_PREFIX$$"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    84
mkdir -p "$OUTPUT" || fail "Bad directory: \"$OUTPUT\""
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    85
49131
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    86
"$ISABELLE_TOOL" build -R -b $JOBS "${BUILD_ARGS[@]}"
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    87
RC=$?
aa1e2ba3c697 added build option -R;
wenzelm
parents: 49073
diff changeset
    88
52740
bceec99254b0 documentation is always in PDF;
wenzelm
parents: 49131
diff changeset
    89
if [ "$RC" = 0 ]; then
bceec99254b0 documentation is always in PDF;
wenzelm
parents: 49131
diff changeset
    90
  "$ISABELLE_TOOL" build -o browser_info=false -o "document=pdf" \
bceec99254b0 documentation is always in PDF;
wenzelm
parents: 49131
diff changeset
    91
    -o "document_output=$OUTPUT" -c $JOBS "${BUILD_ARGS[@]}"
bceec99254b0 documentation is always in PDF;
wenzelm
parents: 49131
diff changeset
    92
  RC=$?
49005
96d5e42e5e3a approximative build of pdf documents in 1 pass instead of 3;
wenzelm
parents: 49002
diff changeset
    93
fi
96d5e42e5e3a approximative build of pdf documents in 1 pass instead of 3;
wenzelm
parents: 49002
diff changeset
    94
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    95
if [ "$RC" = 0 ]; then
52740
bceec99254b0 documentation is always in PDF;
wenzelm
parents: 49131
diff changeset
    96
  cp -f "$OUTPUT"/*.pdf "$ISABELLE_HOME/doc"
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    97
fi
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    98
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    99
rm -rf "$OUTPUT"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
   100
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
   101
exit $RC