begriffs open source - cmsis/blob - gen_pack.sh

   1 #!/usr/bin/env bash
   2 # Version: 2.7
   3 # Date: 2023-06-06
   4 # This bash script generates a CMSIS Software Pack:
   5 #
   6
   7 set -o pipefail
   8
   9 # Set version of gen pack library
  10 # For available versions see https://github.com/Open-CMSIS-Pack/gen-pack/tags.
  11 # Use the tag name without the prefix "v", e.g., 0.7.0
  12 REQUIRED_GEN_PACK_LIB="0.8.3"
  13
  14 # Set default command line arguments
  15 DEFAULT_ARGS=(-c "v")
  16
  17 # Pack warehouse directory - destination
  18 # Default: ./output
  19 #
  20 # PACK_OUTPUT=./output
  21
  22 # Temporary pack build directory,
  23 # Default: ./build
  24 #
  25 # PACK_BUILD=./build
  26
  27 # Specify directory names to be added to pack base directory
  28 # An empty list defaults to all folders next to this script.
  29 # Default: empty (all folders)
  30 #
  31 PACK_DIRS="
  32   CMSIS/Core
  33   CMSIS/Documentation
  34   CMSIS/Driver
  35   CMSIS/RTOS2
  36 "
  37
  38 # Specify file names to be added to pack base directory
  39 # Default: empty
  40 #
  41 PACK_BASE_FILES="
  42   LICENSE
  43 "
  44
  45 # Specify file names to be deleted from pack build directory
  46 # Default: empty
  47 #
  48 # PACK_DELETE_FILES=""
  49
  50 # Specify patches to be applied
  51 # Default: empty
  52 #
  53 # PACK_PATCH_FILES=""
  54
  55 # Specify addition argument to packchk
  56 # Default: empty
  57 #
  58 PACKCHK_ARGS=(-x M336)
  59
  60 # Specify additional dependencies for packchk
  61 # Default: empty
  62 #
  63 PACKCHK_DEPS=" "
  64
  65 # Optional: restrict fallback modes for changelog generation
  66 # Default: full
  67 # Values:
  68 # - full      Tag annotations, release descriptions, or commit messages (in order)
  69 # - release   Tag annotations, or release descriptions (in order)
  70 # - tag       Tag annotations only
  71 #
  72 PACK_CHANGELOG_MODE="tag"
  73
  74 #
  75 # custom pre-processing steps
  76 #
  77 # usage: preprocess <build>
  78 #   <build>  The build folder
  79 #
  80 function preprocess() {
  81   # add custom steps here to be executed
  82   # before populating the pack build folder
  83   ./CMSIS/DoxyGen/gen_doc.sh
  84   return 0
  85 }
  86
  87 #
  88 # custom post-processing steps
  89 #
  90 # usage: postprocess <build>
  91 #   <build>  The build folder
  92 #
  93 function postprocess() {
  94   # add custom steps here to be executed
  95   # after populating the pack build folder
  96   # but before archiving the pack into output folder
  97   return 0
  98 }
  99
 100 ############ DO NOT EDIT BELOW ###########
 101
 102 function install_lib() {
 103   local URL="https://github.com/Open-CMSIS-Pack/gen-pack/archive/refs/tags/v$1.tar.gz"
 104   local STATUS=$(curl -sLI "${URL}" | grep "^HTTP" | tail -n 1 | cut -d' ' -f2 || echo "$((600+$?))")
 105   if [[ $STATUS -ge 400 ]]; then
 106     echo "Wrong/unavailable gen-pack lib version '$1'!" >&2
 107     echo "Check REQUIRED_GEN_PACK_LIB variable."  >&2
 108     echo "For available versions see https://github.com/Open-CMSIS-Pack/gen-pack/tags." >&2
 109     exit 1
 110   fi
 111   echo "Downloading gen-pack lib version '$1' to '$2' ..."
 112   mkdir -p "$2"
 113   curl -L "${URL}" -s | tar -xzf - --strip-components 1 -C "$2" || exit 1
 114 }
 115
 116 function load_lib() {
 117   if [[ -d ${GEN_PACK_LIB} ]]; then
 118     . "${GEN_PACK_LIB}/gen-pack"
 119     return 0
 120   fi
 121   local GLOBAL_LIB="/usr/local/share/gen-pack/${REQUIRED_GEN_PACK_LIB}"
 122   local USER_LIB="${HOME}/.local/share/gen-pack/${REQUIRED_GEN_PACK_LIB}"
 123   if [[ ! -d "${GLOBAL_LIB}" && ! -d "${USER_LIB}" ]]; then
 124     echo "Required gen_pack lib not found!" >&2
 125     install_lib "${REQUIRED_GEN_PACK_LIB}" "${USER_LIB}"
 126   fi
 127
 128   if [[ -d "${GLOBAL_LIB}" ]]; then
 129     . "${GLOBAL_LIB}/gen-pack"
 130   elif [[ -d "${USER_LIB}" ]]; then
 131     . "${USER_LIB}/gen-pack"
 132   else
 133     echo "Required gen-pack lib is not installed!" >&2
 134     exit 1
 135   fi
 136 }
 137
 138 load_lib
 139 gen_pack "${DEFAULT_ARGS[@]}" "$@"
 140
 141 exit 0