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.5"
  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   CMSIS/Documentation/Doxygen
  50   CMSIS/Documentation/README.md
  51 "
  52
  53 # Specify patches to be applied
  54 # Default: empty
  55 #
  56 # PACK_PATCH_FILES=""
  57
  58 # Specify addition argument to packchk
  59 # Default: empty
  60 #
  61 PACKCHK_ARGS=(-x M336)
  62
  63 # Specify additional dependencies for packchk
  64 # Default: empty
  65 #
  66 PACKCHK_DEPS=" "
  67
  68 # Optional: restrict fallback modes for changelog generation
  69 # Default: full
  70 # Values:
  71 # - full      Tag annotations, release descriptions, or commit messages (in order)
  72 # - release   Tag annotations, or release descriptions (in order)
  73 # - tag       Tag annotations only
  74 #
  75 PACK_CHANGELOG_MODE="tag"
  76
  77 #
  78 # custom pre-processing steps
  79 #
  80 # usage: preprocess <build>
  81 #   <build>  The build folder
  82 #
  83 function preprocess() {
  84   # add custom steps here to be executed
  85   # before populating the pack build folder
  86   ./CMSIS/Documentation/Doxygen/gen_doc.sh
  87   return 0
  88 }
  89
  90 #
  91 # custom post-processing steps
  92 #
  93 # usage: postprocess <build>
  94 #   <build>  The build folder
  95 #
  96 function postprocess() {
  97   # add custom steps here to be executed
  98   # after populating the pack build folder
  99   # but before archiving the pack into output folder
 100   return 0
 101 }
 102
 103 ############ DO NOT EDIT BELOW ###########
 104
 105 function install_lib() {
 106   local URL="https://github.com/Open-CMSIS-Pack/gen-pack/archive/refs/tags/v$1.tar.gz"
 107   local STATUS=$(curl -sLI "${URL}" | grep "^HTTP" | tail -n 1 | cut -d' ' -f2 || echo "$((600+$?))")
 108   if [[ $STATUS -ge 400 ]]; then
 109     echo "Wrong/unavailable gen-pack lib version '$1'!" >&2
 110     echo "Check REQUIRED_GEN_PACK_LIB variable."  >&2
 111     echo "For available versions see https://github.com/Open-CMSIS-Pack/gen-pack/tags." >&2
 112     exit 1
 113   fi
 114   echo "Downloading gen-pack lib version '$1' to '$2' ..."
 115   mkdir -p "$2"
 116   curl -L "${URL}" -s | tar -xzf - --strip-components 1 -C "$2" || exit 1
 117 }
 118
 119 function load_lib() {
 120   if [[ -d ${GEN_PACK_LIB} ]]; then
 121     . "${GEN_PACK_LIB}/gen-pack"
 122     return 0
 123   fi
 124   local GLOBAL_LIB="/usr/local/share/gen-pack/${REQUIRED_GEN_PACK_LIB}"
 125   local USER_LIB="${HOME}/.local/share/gen-pack/${REQUIRED_GEN_PACK_LIB}"
 126   if [[ ! -d "${GLOBAL_LIB}" && ! -d "${USER_LIB}" ]]; then
 127     echo "Required gen_pack lib not found!" >&2
 128     install_lib "${REQUIRED_GEN_PACK_LIB}" "${USER_LIB}"
 129   fi
 130
 131   if [[ -d "${GLOBAL_LIB}" ]]; then
 132     . "${GLOBAL_LIB}/gen-pack"
 133   elif [[ -d "${USER_LIB}" ]]; then
 134     . "${USER_LIB}/gen-pack"
 135   else
 136     echo "Required gen-pack lib is not installed!" >&2
 137     exit 1
 138   fi
 139 }
 140
 141 load_lib
 142 gen_pack "${DEFAULT_ARGS[@]}" "$@"
 143
 144 exit 0