Admin/lib/Tools/build_doc
author wenzelm
Tue, 28 Aug 2012 20:10:53 +0200
changeset 48988 f4d4d6d6702b
parent 48972 196520d51afd
child 49002 8ce0fa01ea86
permissions -rwxr-xr-x
prefer cp over mv, to reduce assumptions about file-system boundaries and GNU vs. non-GNU tools;
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
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    40
ALL_DOCS="false"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    41
JOBS=""
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    42
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    43
while getopts "aj:" OPT
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    44
do
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    45
  case "$OPT" in
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    46
    a)
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    47
      ALL_DOCS="true"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    48
      ;;
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    49
    j)
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    50
      check_number "$OPTARG"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    51
      JOBS="-j $OPTARG"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    52
      ;;
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
      usage
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
  esac
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    57
done
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    58
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    59
shift $(($OPTIND - 1))
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
if [ "$ALL_DOCS" = true ]; then
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    62
  declare -a BUILD_OPTIONS=(-g doc)
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    63
else
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    64
  declare -a BUILD_OPTIONS=()
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    65
fi
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    66
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
## main
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    69
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    70
OUTPUT="$ISABELLE_TMP_PREFIX$$"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    71
mkdir -p "$OUTPUT" || fail "Bad directory: \"$OUTPUT\""
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    72
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    73
RC=0
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    74
for FORMAT in dvi pdf
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    75
do
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    76
  if [ "$RC" = 0 ]; then
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    77
    echo "Document format: $FORMAT"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    78
    "$ISABELLE_TOOL" build -o browser_info=false -o "document=$FORMAT" \
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    79
      -o "document_output=$OUTPUT" -c $JOBS "${BUILD_OPTIONS[@]}" -- "$@"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    80
    RC=$?
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    81
  fi
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    82
done
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    83
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    84
if [ "$RC" = 0 ]; then
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    85
  for FILE in $(find "$OUTPUT" -name "*.eps" -o -name "*.ps")
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    86
  do
48988
f4d4d6d6702b prefer cp over mv, to reduce assumptions about file-system boundaries and GNU vs. non-GNU tools;
wenzelm
parents: 48972
diff changeset
    87
    cp -f "$FILE" "$ISABELLE_HOME/doc"
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    88
  done
48988
f4d4d6d6702b prefer cp over mv, to reduce assumptions about file-system boundaries and GNU vs. non-GNU tools;
wenzelm
parents: 48972
diff changeset
    89
  cp -f "$OUTPUT"/*.dvi "$OUTPUT"/*.pdf "$ISABELLE_HOME/doc"
48972
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    90
fi
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    91
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    92
rm -rf "$OUTPUT"
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    93
196520d51afd more formal build_doc tool (Admin only);
wenzelm
parents:
diff changeset
    94
exit $RC