amiro-os / kernel / kernelsetup.sh @ 00843891
History | View | Annotate | Download (30.109 KB)
| 1 |
################################################################################ |
|---|---|
| 2 |
# AMiRo-OS is an operating system designed for the Autonomous Mini Robot # |
| 3 |
# (AMiRo) platform. # |
| 4 |
# Copyright (C) 2016..2019 Thomas Schöpping et al. # |
| 5 |
# # |
| 6 |
# This program is free software: you can redistribute it and/or modify # |
| 7 |
# it under the terms of the GNU General Public License as published by # |
| 8 |
# the Free Software Foundation, either version 3 of the License, or # |
| 9 |
# (at your option) any later version. # |
| 10 |
# # |
| 11 |
# This program is distributed in the hope that it will be useful, # |
| 12 |
# but WITHOUT ANY WARRANTY; without even the implied warranty of # |
| 13 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # |
| 14 |
# GNU General Public License for more details. # |
| 15 |
# # |
| 16 |
# You should have received a copy of the GNU General Public License # |
| 17 |
# along with this program. If not, see <http://www.gnu.org/licenses/>. # |
| 18 |
# # |
| 19 |
# This research/work was supported by the Cluster of Excellence Cognitive # |
| 20 |
# Interaction Technology 'CITEC' (EXC 277) at Bielefeld University, which is # |
| 21 |
# funded by the German Research Foundation (DFG). # |
| 22 |
################################################################################ |
| 23 |
|
| 24 |
#!/bin/bash |
| 25 |
|
| 26 |
################################################################################ |
| 27 |
# GENERIC FUNCTIONS # |
| 28 |
################################################################################ |
| 29 |
|
| 30 |
### print an error message ##################################################### |
| 31 |
# Prints a error <message> to standard output. |
| 32 |
#If variable 'LOG_FILE' is specified, the message is also appended to the given file. |
| 33 |
# |
| 34 |
# usage: printError <message> |
| 35 |
# arguments: <message> |
| 36 |
# Message string to print. |
| 37 |
# return: n/a |
| 38 |
# |
| 39 |
function printError {
|
| 40 |
local string="ERROR: $1" |
| 41 |
# if a log file is specified |
| 42 |
if [ -n "$LOG_FILE" ]; then |
| 43 |
printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE |
| 44 |
fi |
| 45 |
printf "$(tput setaf 1)>>> $string$(tput sgr 0)" 1>&2 |
| 46 |
} |
| 47 |
|
| 48 |
### print a warning message #################################################### |
| 49 |
# Prints a warning <message> to standard output. |
| 50 |
#If variable 'LOG_FILE' is specified, the message is also appended to the given file. |
| 51 |
# |
| 52 |
# usage: printMessage <message> |
| 53 |
# arguments: <message> |
| 54 |
# Message string to print. |
| 55 |
# return: n/a |
| 56 |
# |
| 57 |
function printWarning {
|
| 58 |
local string="WARNING: $1" |
| 59 |
# if a log file is specified |
| 60 |
if [ -n "$LOG_FILE" ]; then |
| 61 |
printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE |
| 62 |
fi |
| 63 |
printf "$(tput setaf 3)>>> $string$(tput sgr 0)" |
| 64 |
} |
| 65 |
|
| 66 |
### print an information message ############################################### |
| 67 |
# Prints an information <message> to standard output. |
| 68 |
#If variable 'LOG_FILE' is specified, the message is also appended to the given file. |
| 69 |
# |
| 70 |
# usage: printInfo <message> |
| 71 |
# arguments: <message> |
| 72 |
# Message string to print. |
| 73 |
# return: n/a |
| 74 |
# |
| 75 |
function printInfo {
|
| 76 |
local string="INFO: $1" |
| 77 |
# if a log file is specified |
| 78 |
if [ -n "$LOG_FILE" ]; then |
| 79 |
printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE |
| 80 |
fi |
| 81 |
printf "$(tput setaf 2)>>> $string$(tput sgr 0)" |
| 82 |
} |
| 83 |
|
| 84 |
### print a message to file #################################################### |
| 85 |
# Appends a <message> to a log file, specified by the variable 'LOG_FILE'. |
| 86 |
# |
| 87 |
# usage printLog <message> |
| 88 |
# arguments: <message> |
| 89 |
# Message string to print. |
| 90 |
# return: n/a |
| 91 |
# |
| 92 |
function printLog {
|
| 93 |
local string="LOG: $1" |
| 94 |
# if a log file is specified |
| 95 |
if [ -n "$LOG_FILE" ]; then |
| 96 |
printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE |
| 97 |
fi |
| 98 |
} |
| 99 |
|
| 100 |
### exit the script normally ################################################### |
| 101 |
# Prints a delimiter and exits the script normally (returns 0). |
| 102 |
# |
| 103 |
# usage: quitScript |
| 104 |
# arguments: n/a |
| 105 |
# return: 0 |
| 106 |
# No error or warning occurred. |
| 107 |
# |
| 108 |
function quitScript {
|
| 109 |
printInfo "exiting $(realpath ${BASH_SOURCE[0]})\n"
|
| 110 |
printf "\n" |
| 111 |
printf "######################################################################\n" |
| 112 |
exit 0 |
| 113 |
} |
| 114 |
|
| 115 |
### read a user input ########################################################## |
| 116 |
# Reads a single character user input from a set up <options> and stores it in |
| 117 |
# a given <return> variable. |
| 118 |
# |
| 119 |
# usage: readUserInput <options> <return> |
| 120 |
# arguments: <options> |
| 121 |
# String definiing the set of valid characters. |
| 122 |
# If the string is empty, the user can input any character. |
| 123 |
# <return> |
| 124 |
# Variable to store the selected character to. |
| 125 |
# return: n/a |
| 126 |
# |
| 127 |
function readUserInput {
|
| 128 |
local input="" |
| 129 |
# read user input |
| 130 |
while [ -z $input ] || ( [ -n "$1" ] && [[ ! $input =~ ^[$1]$ ]] ); do |
| 131 |
read -p "your selection: " -n 1 -e input |
| 132 |
if [ -z $input ] || ( [ -n "$1" ] && [[ ! $input =~ ^[$1]$ ]] ); then |
| 133 |
printWarning "[$input] is no valid action\n" |
| 134 |
fi |
| 135 |
done |
| 136 |
printLog "[$input] has been selected\n" |
| 137 |
eval $2="$input" |
| 138 |
} |
| 139 |
|
| 140 |
### check whether argument is an option ######################################## |
| 141 |
# Checks a <string> whether it is an option. |
| 142 |
# Options are defined to either start with '--' followed by any string, or |
| 143 |
# to start with a single '-' followed by a single character, or |
| 144 |
# to start with a single '-' followed by a single character, a '=' and any string. |
| 145 |
# Examples: '--option', '--option=arg', '-o', '-o=arg', '--' |
| 146 |
# |
| 147 |
# usage: parseIsOption <string> |
| 148 |
# arguments: <string> |
| 149 |
# A string to check whether it is an option. |
| 150 |
# return: 0 |
| 151 |
# <string> is an option. |
| 152 |
# -1 |
| 153 |
# <string> is not an option. |
| 154 |
# |
| 155 |
function parseIsOption {
|
| 156 |
if [[ "$1" =~ ^-(.$|.=.*) ]] || [[ "$1" =~ ^--.* ]]; then |
| 157 |
return 0 |
| 158 |
else |
| 159 |
return -1 |
| 160 |
fi |
| 161 |
} |
| 162 |
|
| 163 |
### set the log file ########################################################### |
| 164 |
# Sets a specified <infile> as log file and checks whether it already exists. |
| 165 |
# If so, the log may either be appended to the file, its content can be cleared, |
| 166 |
# or no log is generated at all. |
| 167 |
# The resulting path is stored in <outvar>. |
| 168 |
# |
| 169 |
# usage: setLogFile [--option=<option>] [--quiet] <infile> <outvar> |
| 170 |
# arguments: --option=<option> |
| 171 |
# Select what to do if <file> already exists. |
| 172 |
# Possible values are 'a', 'c', 'r' and 'n'. |
| 173 |
# - a: append (starts with a separator) |
| 174 |
# - c: continue (does not insert a seperator) |
| 175 |
# - r: delete and restart |
| 176 |
# - n: no log |
| 177 |
# If no option is secified but <file> exists, an interactive selection is provided. |
| 178 |
# --quiet |
| 179 |
# Suppress all messages. |
| 180 |
# <infile> |
| 181 |
# Path of the wanted log file. |
| 182 |
# <outvar> |
| 183 |
# Variable to store the path of the log file to. |
| 184 |
# return: 0 |
| 185 |
# No error or warning occurred. |
| 186 |
# -1 |
| 187 |
# Error: invalid input |
| 188 |
# |
| 189 |
function setLogFile {
|
| 190 |
local filepath="" |
| 191 |
local option="" |
| 192 |
local quiet=false |
| 193 |
|
| 194 |
# parse arguments |
| 195 |
local otherargs=() |
| 196 |
while [ $# -gt 0 ]; do |
| 197 |
if ( parseIsOption $1 ); then |
| 198 |
case "$1" in |
| 199 |
-o=*|--option=*) |
| 200 |
option=${1#*=}; shift 1;;
|
| 201 |
-o*|--option*) |
| 202 |
option="$2"; shift 2;; |
| 203 |
-q|--quiet) |
| 204 |
quiet=true; shift 1;; |
| 205 |
*) |
| 206 |
printError "invalid option: $1\n"; shift 1;; |
| 207 |
esac |
| 208 |
else |
| 209 |
otherargs+=("$1")
|
| 210 |
shift 1 |
| 211 |
fi |
| 212 |
done |
| 213 |
filepath=$(realpath ${otherargs[0]})
|
| 214 |
|
| 215 |
# if file already exists |
| 216 |
if [ -e $filepath ]; then |
| 217 |
# if no option was specified, ask what to do |
| 218 |
if [ -z "$option" ]; then |
| 219 |
printWarning "log file $filepath already esists\n" |
| 220 |
local userinput="" |
| 221 |
printf "Select what to do:\n" |
| 222 |
printf " [A] - append log\n" |
| 223 |
printf " [R] - restart log (delete existing file)\n" |
| 224 |
printf " [N] - no log\n" |
| 225 |
readUserInput "AaRrNn" userinput |
| 226 |
option=${userinput,,}
|
| 227 |
fi |
| 228 |
# evaluate option |
| 229 |
case "$option" in |
| 230 |
a|c) |
| 231 |
if [ $quiet = false ]; then |
| 232 |
printInfo "appending log to $filepath\n" |
| 233 |
fi |
| 234 |
if [ $option != c ]; then |
| 235 |
printf "\n" >> $filepath |
| 236 |
printf "######################################################################\n" >> $filepath |
| 237 |
printf "\n" >> $filepath |
| 238 |
fi |
| 239 |
;; |
| 240 |
r) |
| 241 |
echo -n "" > $filepath |
| 242 |
if [ $quiet = false ]; then |
| 243 |
printInfo "content of $filepath wiped\n" |
| 244 |
fi |
| 245 |
;; |
| 246 |
n) |
| 247 |
if [ $quiet = false ]; then |
| 248 |
printInfo "no log file will be generated\n" |
| 249 |
fi |
| 250 |
filepath="" |
| 251 |
;; |
| 252 |
*) # sanity check (return error) |
| 253 |
printError "unexpected argument: $option\n"; return -1;; |
| 254 |
esac |
| 255 |
else |
| 256 |
if [ $quiet = false ]; then |
| 257 |
printInfo "log file set to $filepath\n" |
| 258 |
fi |
| 259 |
fi |
| 260 |
|
| 261 |
eval ${otherargs[1]}="$filepath"
|
| 262 |
|
| 263 |
return 0 |
| 264 |
} |
| 265 |
|
| 266 |
### check whether commands are available ####################################### |
| 267 |
# Checks whether the specified commands are available and can be executed. |
| 268 |
# |
| 269 |
# usage: checkCommand [<command> <command> ...] |
| 270 |
# arguments: <command> |
| 271 |
# Name of the command to check. |
| 272 |
# return: 0 |
| 273 |
# All requested commands are available. |
| 274 |
# >0 |
| 275 |
# Number of requested commands that were not found. |
| 276 |
# -1 |
| 277 |
# No argument given. |
| 278 |
# |
| 279 |
function checkCommands {
|
| 280 |
local status=0 |
| 281 |
|
| 282 |
# return if no argument was specified |
| 283 |
if [ $# -eq 0 ]; then |
| 284 |
return -1 |
| 285 |
fi |
| 286 |
|
| 287 |
# check all specified commands |
| 288 |
while [ $# -gt 0 ]; do |
| 289 |
command -v $1 &>/dev/null |
| 290 |
if [ $? -ne 0 ]; then |
| 291 |
printWarning "Command '$1' not available.\n" |
| 292 |
status=$((status + 1)) |
| 293 |
fi |
| 294 |
shift 1 |
| 295 |
done |
| 296 |
|
| 297 |
return $status |
| 298 |
} |
| 299 |
|
| 300 |
################################################################################ |
| 301 |
# SPECIFIC FUNCTIONS # |
| 302 |
################################################################################ |
| 303 |
|
| 304 |
### print welcome text ######################################################### |
| 305 |
# Prints a welcome message to standard out. |
| 306 |
# |
| 307 |
# usage: printWelcomeText |
| 308 |
# arguments: n/a |
| 309 |
# return: n/a |
| 310 |
# |
| 311 |
function printWelcomeText {
|
| 312 |
printf "######################################################################\n" |
| 313 |
printf "# #\n" |
| 314 |
printf "# Welcome to the ChibiOS submodule setup! #\n" |
| 315 |
printf "# #\n" |
| 316 |
printf "######################################################################\n" |
| 317 |
printf "# #\n" |
| 318 |
printf "# Copyright (c) 2016..2019 Thomas Schöpping #\n" |
| 319 |
printf "# #\n" |
| 320 |
printf "# This is free software; see the source for copying conditions. #\n" |
| 321 |
printf "# There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR #\n" |
| 322 |
printf "# A PARTICULAR PURPOSE. The development of this software was #\n" |
| 323 |
printf "# supported by the Excellence Cluster EXC 227 Cognitive Interaction #\n" |
| 324 |
printf "# Technology. The Excellence Cluster EXC 227 is a grant of the #\n" |
| 325 |
printf "# Deutsche Forschungsgemeinschaft (DFG) in the context of the German #\n" |
| 326 |
printf "# Excellence Initiative. #\n" |
| 327 |
printf "# #\n" |
| 328 |
printf "######################################################################\n" |
| 329 |
} |
| 330 |
|
| 331 |
### print help ################################################################# |
| 332 |
# Prints a help text to standard out. |
| 333 |
# |
| 334 |
# usage: printHelp |
| 335 |
# arguments: n/a |
| 336 |
# return: n/a |
| 337 |
# |
| 338 |
function printHelp {
|
| 339 |
printInfo "printing help text\n" |
| 340 |
printf "usage: $(basename ${BASH_SOURCE[0]}) [-h|--help] [-i|--init] [-p|--patch] [-d|--documentation=<option>] [-w|--wipe] [-q|--quit] [--log=<file>]\n"
|
| 341 |
printf "options: -h, --help\n" |
| 342 |
printf " Print this help text.\n" |
| 343 |
printf " -i, --init\n" |
| 344 |
printf " Initialize ChibiOS submodule.\n" |
| 345 |
printf " -p, --patch,\n" |
| 346 |
printf " Apply patches to ChibiOS.\n" |
| 347 |
printf " -d, --documentation <option>\n" |
| 348 |
printf " Possible options are: 'g' and 'o' (can be combined).\n" |
| 349 |
printf " - g: Generate HTML documentation of ChibiOS.\n" |
| 350 |
printf " - o: Open HTML documentation of ChibiOS.\n" |
| 351 |
printf " -w, --wipe\n" |
| 352 |
printf " Wipe ChibiOS submodule.\n" |
| 353 |
printf " -q, --quit\n" |
| 354 |
printf " Quit the script.\n" |
| 355 |
printf " --log=<file>\n" |
| 356 |
printf " Specify a log file.\n" |
| 357 |
} |
| 358 |
|
| 359 |
### initialize ChibiOS submodule ############################################### |
| 360 |
# Initializes the ChibiOS Git submodule. |
| 361 |
# |
| 362 |
# usage: initChibiOS |
| 363 |
# arguments: n/a |
| 364 |
# return: 0 |
| 365 |
# No error or warning occurred. |
| 366 |
# 1 |
| 367 |
# Warning: Aborted by user. |
| 368 |
# -1 |
| 369 |
# Error: Unexpected user input. |
| 370 |
# -1 |
| 371 |
# Error: Missing dependency. |
| 372 |
# |
| 373 |
function initChibiOS {
|
| 374 |
printInfo "initializing ChibiOS submodule...\n" |
| 375 |
local userdir=$(pwd) |
| 376 |
local kerneldir=$(dirname $(realpath ${BASH_SOURCE[0]}))
|
| 377 |
local chibiosdir=${kerneldir}/ChibiOS
|
| 378 |
|
| 379 |
# if the kernel folder is not empty |
| 380 |
if [ ! -z "$(ls -A $chibiosdir)" ]; then |
| 381 |
printWarning "$chibiosdir is not empty. Delete and reinitialize? [y/n]\n" |
| 382 |
local userinput="" |
| 383 |
readUserInput "YyNn" userinput |
| 384 |
case "$userinput" in |
| 385 |
Y|y) |
| 386 |
wipeChibiOS |
| 387 |
;; |
| 388 |
N|n) |
| 389 |
printWarning "ChibiOS initialization aborted by user\n" |
| 390 |
return 1 |
| 391 |
;; |
| 392 |
*) # sanity check (return error) |
| 393 |
printError "unexpected input: $userinput\n"; return -1;; |
| 394 |
esac |
| 395 |
fi |
| 396 |
|
| 397 |
# check dependencies |
| 398 |
checkCommands git |
| 399 |
if [ $? -ne 0 ]; then |
| 400 |
printError "Missing dependencies detected.\n" |
| 401 |
return -2 |
| 402 |
fi |
| 403 |
|
| 404 |
# initialize submodule to default branch |
| 405 |
cd $kerneldir |
| 406 |
git submodule update --init $chibiosdir 2>&1 | tee -a $LOG_FILE |
| 407 |
while [ ${PIPESTATUS[0]} -ne 0 ]; do
|
| 408 |
printWarning "initialitaion failed. Retry? [y/n]\n" |
| 409 |
local userinput="" |
| 410 |
readUserInput "YyNn" userinput |
| 411 |
case "$userinput" in |
| 412 |
Y|y) |
| 413 |
git submodule update --init $chibiosdir 2>&1 | tee -a $LOG_FILE;; |
| 414 |
N|n) |
| 415 |
printWarning "ChibiOS initialization aborted by user\n" |
| 416 |
cd $userdir |
| 417 |
return 1 |
| 418 |
;; |
| 419 |
*) # sanity check (return error) |
| 420 |
printError "unexpected input: $userinput\n"; return -1;; |
| 421 |
esac |
| 422 |
done |
| 423 |
cd $userdir |
| 424 |
|
| 425 |
return 0 |
| 426 |
} |
| 427 |
|
| 428 |
### patch ChibiOS ############################################################## |
| 429 |
# Applies patches to ChibiOS submodule. |
| 430 |
# |
| 431 |
# usage: patchChibiOS |
| 432 |
# arguments: n/a |
| 433 |
# return: 0 |
| 434 |
# No error or warning occurred. |
| 435 |
# 1 |
| 436 |
# Warning: ChibiOS not initialized yet. |
| 437 |
# 2 |
| 438 |
# Warning: Setup aborted by user. |
| 439 |
# -1 |
| 440 |
# Error: Unexpected user input. |
| 441 |
# |
| 442 |
function patchChibiOS {
|
| 443 |
printInfo "applying patches to ChibiOS\n" |
| 444 |
local userdir=$(pwd) |
| 445 |
local kerneldir=$(dirname $(realpath ${BASH_SOURCE[0]}))
|
| 446 |
local chibiosdir=${kerneldir}/ChibiOS
|
| 447 |
local git_branch_patched="AMiRo-OS" |
| 448 |
|
| 449 |
# check dependencies |
| 450 |
checkCommands git |
| 451 |
if [ $? -ne 0 ]; then |
| 452 |
printError "Missing dependencies detected.\n" |
| 453 |
return -2 |
| 454 |
fi |
| 455 |
|
| 456 |
# if the ChibiOS folder is empty |
| 457 |
if [ -z "$(ls -A $chibiosdir)" ]; then |
| 458 |
printWarning "$chibiosdir is empty. Please initialize first.\n" |
| 459 |
return 1 |
| 460 |
else |
| 461 |
# get some information from Git |
| 462 |
cd $chibiosdir |
| 463 |
local git_branch_current=$(git rev-parse --abbrev-ref HEAD) |
| 464 |
local git_branches=$(git for-each-ref --format="%(refname)") |
| 465 |
local git_dirtyfiles=($(git ls-files -dmo --exclude-standard --exclude=/doc)) |
| 466 |
cd $userdir |
| 467 |
|
| 468 |
local issues=0 |
| 469 |
# if the current branch is already $git_branch_patched |
| 470 |
if [ "$git_branch_current" = "$git_branch_patched" ]; then |
| 471 |
issues=$((issues + 1)) |
| 472 |
printWarning "current branch is already $git_branch_patched\n" |
| 473 |
fi |
| 474 |
# if the current branch is bot $git_branch_patched, but another branch $git_branch_patched already exists |
| 475 |
if [ "$git_branch_current" != "$git_branch_patched" ] && [[ "$git_branches" = *"$git_branch_patched"* ]]; then |
| 476 |
issues=$((issues + 1)) |
| 477 |
printWarning "another branch $git_branch_patched already exists\n" |
| 478 |
fi |
| 479 |
# if there are untracked, modified, or deleted files |
| 480 |
if [ ${#git_dirtyfiles[@]} != 0 ]; then
|
| 481 |
issues=$((issues + 1)) |
| 482 |
printWarning "there are ${#git_dirtyfiles[@]} untracked, modified, or deleted files\n"
|
| 483 |
fi |
| 484 |
if [ $issues -gt 0 ]; then |
| 485 |
local userinput="" |
| 486 |
printWarning "$issues issues detected. Do you want to continue? [y/n]\n" |
| 487 |
readUserInput "YyNn" userinput |
| 488 |
case "$userinput" in |
| 489 |
Y|y) |
| 490 |
;; |
| 491 |
N|n) |
| 492 |
printfWarning "ChibiOS patching aborted by user\n" |
| 493 |
return 2 |
| 494 |
;; |
| 495 |
*) # sanity check (return error) |
| 496 |
printError "unexpected input: $userinput\n"; return -1;; |
| 497 |
esac |
| 498 |
fi |
| 499 |
|
| 500 |
# create a new branch and apply the patches |
| 501 |
local patches=${kerneldir}/patches/*.patch
|
| 502 |
cd $chibiosdir |
| 503 |
git checkout -b "$git_branch_patched" 2>&1 | tee -a $LOG_FILE |
| 504 |
for patch in $patches; do |
| 505 |
cp $patch . |
| 506 |
patch=$(basename $patch) |
| 507 |
printInfo "applying ${patch}...\n"
|
| 508 |
git apply --whitespace=nowarn --ignore-space-change --ignore-whitespace < $patch 2>&1 | tee -a $LOG_FILE |
| 509 |
rm $patch |
| 510 |
# # These lines are disabled for safety reasons: |
| 511 |
# # Filed commits are detected as valid changes by the super-project. |
| 512 |
# # This may lead to errorneous updates of the super-project, as to point to one of these commit hashes. |
| 513 |
# # Since these commits are not pushed upstream, initialization of the super-project will therefore fail, because |
| 514 |
# # the referenced hashed (after patching) do not exist in a clean copy of this sub-project. |
| 515 |
# git add $(git ls-files -dmo --exclude-standard --exclude=/doc) $(git diff --name-only) 2>&1 | tee -a $LOG_FILE |
| 516 |
# git commit --message="$patch applied" 2>&1 | tee -a $LOG_FILE |
| 517 |
done |
| 518 |
cd $userdir |
| 519 |
|
| 520 |
return 0 |
| 521 |
fi |
| 522 |
} |
| 523 |
|
| 524 |
### ChibiOS dcoumentation setup ################################################ |
| 525 |
# |
| 526 |
# usage: documentation [<option>] |
| 527 |
# arguments: <option> |
| 528 |
# Can be either 'g' or 'o' to generate or open HTML documentation respectively. |
| 529 |
# return: 0 |
| 530 |
# No error or warning occurred. |
| 531 |
# 1 |
| 532 |
# Warning: Kernel not nitialized yet. |
| 533 |
# 2 |
| 534 |
# Warning: Setup aborted by user. |
| 535 |
# 3 |
| 536 |
# Warning: Issues occurred. |
| 537 |
# -1 |
| 538 |
# Error: Unexpected user input. |
| 539 |
# -2 |
| 540 |
# Error: Missing dependencies. |
| 541 |
# |
| 542 |
function documentation {
|
| 543 |
local userdir=$(pwd) |
| 544 |
local kerneldir=$(dirname $(realpath ${BASH_SOURCE[0]}))
|
| 545 |
local chibiosdir=${kerneldir}/ChibiOS
|
| 546 |
|
| 547 |
# if the ChibiOS folder is empty |
| 548 |
if [ -z "$(ls -A $chibiosdir)" ]; then |
| 549 |
printWarning "$chibiosdir is empty. Please initialize first.\n" |
| 550 |
return 1 |
| 551 |
else |
| 552 |
local option=""; |
| 553 |
# if no argument was specified, ask what to do |
| 554 |
if [ $# -eq 0 ]; then |
| 555 |
printInfo "ChibiOS documentation setup\n" |
| 556 |
printf "Please select one of the following actions:\n" |
| 557 |
printf " [G] - generate HTML documentation\n" |
| 558 |
printf " [O] - open HTML documentation\n" |
| 559 |
printf " [A] - abort this setup\n" |
| 560 |
local userinput |
| 561 |
readUserInput "GgOoAa" userinput |
| 562 |
option=${userinput,,}
|
| 563 |
if [ $option = "a" ]; then |
| 564 |
printInfo "ChibiOS documentation setup aborted by user\n" |
| 565 |
return 2 |
| 566 |
fi |
| 567 |
else |
| 568 |
option="$1" |
| 569 |
fi |
| 570 |
|
| 571 |
local issues=0 |
| 572 |
case "$option" in |
| 573 |
# generate HTML documentation |
| 574 |
g) |
| 575 |
# check dependencies |
| 576 |
checkCommands doxygen |
| 577 |
if [ $? -ne 0 ]; then |
| 578 |
printError "Missing dependencies detected.\n" |
| 579 |
return -2 |
| 580 |
fi |
| 581 |
|
| 582 |
# ChibiOS/HAL: check if required files exis |
| 583 |
if [ -f ${chibiosdir}/doc/hal/makehtml.sh ]; then
|
| 584 |
printInfo "generating ChibiOS/HAL documentation...\n" |
| 585 |
cd ${chibiosdir}/doc/hal
|
| 586 |
${chibiosdir}/doc/hal/makehtml.sh 2>&1 | tee -a $LOG_FILE
|
| 587 |
cd $userdir |
| 588 |
printInfo "access ChibiOS/HAL documentation via ${chibiosdir}doc/hal/html/index.html\n"
|
| 589 |
else |
| 590 |
issues=$((issues + 1)) |
| 591 |
printError "could not generate ChibiOS/HAL documentation\n" |
| 592 |
fi |
| 593 |
# ChibiOS/RT: check if required files exis |
| 594 |
if [ -f ${chibiosdir}/doc/rt/makehtml.sh ]; then
|
| 595 |
printInfo "generating ChibiOS/RT documentation...\n" |
| 596 |
cd ${chibiosdir}/doc/rt
|
| 597 |
${chibiosdir}/doc/rt/makehtml.sh 2>&1 | tee -a $LOG_FILE
|
| 598 |
cd $userdir |
| 599 |
printInfo "access ChibiOS/RT documentation via ${chibiosdir}doc/rt/html/index.html\n"
|
| 600 |
else |
| 601 |
issues=$((issues + 1)) |
| 602 |
printError "could not generate ChibiOS/RT documentation\n" |
| 603 |
fi |
| 604 |
# ChibiOS/NIL: check if required files exis |
| 605 |
if [ -f ${chibiosdir}/doc/nil/makehtml.sh ]; then
|
| 606 |
printInfo "generating ChibiOS/NIL documentation...\n" |
| 607 |
cd ${chibiosdir}/doc/nil
|
| 608 |
${chibiosdir}/doc/nil/makehtml.sh 2>&1 | tee -a $LOG_FILE
|
| 609 |
cd $userdir |
| 610 |
printInfo "access ChibiOS/NIL documentation via ${chibiosdir}edoc/nil/html/index.html\n"
|
| 611 |
else |
| 612 |
issues=$((issues + 1)) |
| 613 |
printError "could not generate ChibiOS/NIL documentation\n" |
| 614 |
fi |
| 615 |
;; |
| 616 |
|
| 617 |
# open HTML documentation |
| 618 |
o) |
| 619 |
# ChibiOS/HAL: check if required files exis |
| 620 |
if [ -f ${chibiosdir}/doc/hal/html/index.html ]; then
|
| 621 |
printInfo "open ChibiOS/HAL documentation\n" |
| 622 |
xdg-open ${chibiosdir}/doc/hal/html/index.html &> /dev/null &
|
| 623 |
else |
| 624 |
issues=$((issues + 1)) |
| 625 |
printError "could not open ChibiOS/HAL documentation\n" |
| 626 |
fi |
| 627 |
# ChibiOS/RT: check if required files exis |
| 628 |
if [ -f ${chibiosdir}/doc/rt/html/index.html ]; then
|
| 629 |
printInfo "open ChibiOS/RT documentation\n" |
| 630 |
xdg-open ${chibiosdir}/doc/rt/html/index.html &> /dev/null &
|
| 631 |
else |
| 632 |
issues=$((issues + 1)) |
| 633 |
printError "could not open ChibiOS/RT documentation\n" |
| 634 |
fi |
| 635 |
# ChibiOS/NIL: check if required files exis |
| 636 |
if [ -f ${chibiosdir}/doc/nil/html/index.html ]; then
|
| 637 |
printInfo "open ChibiOS/NIL documentation\n" |
| 638 |
xdg-open ${chibiosdir}/doc/nil/html/index.html &> /dev/null &
|
| 639 |
else |
| 640 |
issues=$((issues + 1)) |
| 641 |
printError "could not open ChibiOS/NIL documentation\n" |
| 642 |
fi |
| 643 |
;; |
| 644 |
|
| 645 |
*) # sanity check (return error) |
| 646 |
printError "unexpected input: $userinput\n"; return -1;; |
| 647 |
esac |
| 648 |
|
| 649 |
if [ $issues -gt 0 ]; then |
| 650 |
return 3 |
| 651 |
else |
| 652 |
return 0 |
| 653 |
fi |
| 654 |
fi |
| 655 |
} |
| 656 |
|
| 657 |
### reset ChibiOS submodule and wipe directory ################################# |
| 658 |
# Resets the ChibiOS Git submodule and wipes the directory. |
| 659 |
# |
| 660 |
# usage: wipeChibiOS |
| 661 |
# arguments: n/a |
| 662 |
# return: 0 |
| 663 |
# No error or warning occurred. |
| 664 |
# 1 |
| 665 |
# Warning: Submodule directory is already empty. |
| 666 |
# 2 |
| 667 |
# Warning: Wiping aborted by user. |
| 668 |
# -1 |
| 669 |
# Error: Unexpected user input. |
| 670 |
# |
| 671 |
function wipeChibiOS {
|
| 672 |
printInfo "reset and wipe Git submodule $kerneldir\n" |
| 673 |
local userdir=$(pwd) |
| 674 |
local kerneldir=$(dirname $(realpath ${BASH_SOURCE[0]}))
|
| 675 |
local chibiosdir=${kerneldir}/ChibiOS
|
| 676 |
local git_branch_patched="AMiRo-OS" |
| 677 |
|
| 678 |
# check dependencies |
| 679 |
checkCommands git |
| 680 |
if [ $? -ne 0 ]; then |
| 681 |
printError "Missing dependencies detected.\n" |
| 682 |
return -2 |
| 683 |
fi |
| 684 |
|
| 685 |
# if the ChibiOS folder is empty |
| 686 |
if [ -z "$(ls -A $chibiosdir)" ]; then |
| 687 |
printInfo "$chibiosdir is alread empty\n" |
| 688 |
return 1 |
| 689 |
else |
| 690 |
# get some information from Git |
| 691 |
cd $kerneldir |
| 692 |
local git_basehash=($(git ls-tree -d HEAD $kerneldir)); git_basehash=${git_basehash[2]}
|
| 693 |
cd $chibiosdir |
| 694 |
local git_branch_current=$(git rev-parse --abbrev-ref HEAD) |
| 695 |
local git_difftobase="$(git diff ${git_basehash}..HEAD)"
|
| 696 |
local git_commits=$(git log --format=oneline ${git_basehash}..HEAD)
|
| 697 |
local git_dirtyfiles=($(git ls-files -dmo --exclude-standard --exclude=/doc)) |
| 698 |
cd $userdir |
| 699 |
local issues=0 |
| 700 |
# if the HEAD is neither detached, nor is the current branch $git_branch_patched |
| 701 |
if [ "$git_branch_current" != "HEAD" ] && [ "$git_branch_current" != "$git_branch_patched" ]; then |
| 702 |
issues=$((issues + 1)) |
| 703 |
printWarning "modifications to ChibiOS Git submodule detected\n" |
| 704 |
fi |
| 705 |
# if HEAD is ahead of submodule base commit but with more than just applied patches |
| 706 |
if [ -n "$git_difftobase" ] && [ -n "$(echo $git_commits | grep -Ev '\.patch applied$')" ]; then |
| 707 |
issues=$((issues + 1)) |
| 708 |
printWarning "HEAD is ahead of submodule base by unexpected commits\n" |
| 709 |
fi |
| 710 |
# if there are untracked, modified, or deleted files |
| 711 |
if [ ${#git_dirtyfiles[@]} != 0 ]; then
|
| 712 |
issues=$((issues + 1)) |
| 713 |
printWarning "there are ${#git_dirtyfiles[@]} untracked, modified, or deleted files\n"
|
| 714 |
fi |
| 715 |
if [ $issues -gt 0 ]; then |
| 716 |
local userinput="" |
| 717 |
printWarning "$issues issues detected. Do you want to continue? [y/n]\n" |
| 718 |
readUserInput "YyNn" userinput |
| 719 |
case "$userinput" in |
| 720 |
Y|y) |
| 721 |
;; |
| 722 |
N|n) |
| 723 |
printfWarning "wiping ChibiOS Git submodule aborted by user\n" |
| 724 |
return 2 |
| 725 |
;; |
| 726 |
*) # sanity check (return error) |
| 727 |
printError "unexpected input: $userinput\n"; return -1;; |
| 728 |
esac |
| 729 |
fi |
| 730 |
|
| 731 |
# checkout base commit and delete all local branches |
| 732 |
cd $kerneldir |
| 733 |
git submodule update --force --checkout $kerneldir | tee -a $LOG_FILE |
| 734 |
cd $chibiosdir |
| 735 |
local git_branches=($(git for-each-ref --format="%(refname)")) |
| 736 |
for branch in $git_branches; do |
| 737 |
if [[ $branch = *"heads/"* ]]; then |
| 738 |
git branch -D ${branch##*/} | tee -a $LOG_FILE
|
| 739 |
fi |
| 740 |
done |
| 741 |
cd $userdir |
| 742 |
|
| 743 |
# deinitialize ChibiOS submodule and delete any remaining files |
| 744 |
cd $kerneldir |
| 745 |
git submodule deinit -f $chibiosdir 2>&1 | tee -a $LOG_FILE |
| 746 |
rm -rf $chibiosdir/* |
| 747 |
cd $userdir |
| 748 |
|
| 749 |
return 0 |
| 750 |
fi |
| 751 |
} |
| 752 |
|
| 753 |
### main function of this script ############################################### |
| 754 |
# The kernel setup provides comfortable initialization, patching, documentation |
| 755 |
# generation and cleanup for ChibiOS. |
| 756 |
# |
| 757 |
# usage: see function printHelp |
| 758 |
# arguments: see function printHelp |
| 759 |
# return: 0 |
| 760 |
# No error or warning occurred. |
| 761 |
# |
| 762 |
function main {
|
| 763 |
# print welcome/info text if not suppressed |
| 764 |
if [[ $@ != *"--noinfo"* ]]; then |
| 765 |
printWelcomeText |
| 766 |
else |
| 767 |
printf "######################################################################\n" |
| 768 |
fi |
| 769 |
printf "\n" |
| 770 |
|
| 771 |
# if --help or -h was specified, print the help text and exit |
| 772 |
if [[ $@ == *"--help"* || $@ == *"-h"* ]]; then |
| 773 |
printHelp |
| 774 |
printf "\n" |
| 775 |
quitScript |
| 776 |
fi |
| 777 |
|
| 778 |
# set log file if specified |
| 779 |
if [[ $@ == *"--log"* ]] || [[ $@ == *"--LOG"* ]]; then |
| 780 |
# get the parameter (file name) |
| 781 |
local cmdidx=1 |
| 782 |
while [[ ! "${!cmdidx}" = "--log"* ]] && [[ ! "${!cmdidx}" = "--LOG"* ]]; do
|
| 783 |
cmdidx=$[cmdidx + 1] |
| 784 |
done |
| 785 |
local cmd="${!cmdidx}"
|
| 786 |
local logfile="" |
| 787 |
if [[ "$cmd" = "--log="* ]] || [[ "$cmd" = "--LOG="* ]]; then |
| 788 |
logfile=${cmd#*=}
|
| 789 |
else |
| 790 |
local filenameidx=$((cmdidx + 1)) |
| 791 |
logfile="${!filenameidx}"
|
| 792 |
fi |
| 793 |
# optionally force silent appending |
| 794 |
if [[ "$cmd" = "--LOG"* ]]; then |
| 795 |
setLogFile --option=c --quiet "$logfile" LOG_FILE |
| 796 |
else |
| 797 |
setLogFile "$logfile" LOG_FILE |
| 798 |
printf "\n" |
| 799 |
fi |
| 800 |
fi |
| 801 |
# log script name |
| 802 |
printLog "this is $(realpath ${BASH_SOURCE[0]})\n"
|
| 803 |
|
| 804 |
# parse arguments |
| 805 |
local otherargs=() |
| 806 |
while [ $# -gt 0 ]; do |
| 807 |
if ( parseIsOption $1 ); then |
| 808 |
case "$1" in |
| 809 |
-h|--help) # already handled; ignore |
| 810 |
shift 1;; |
| 811 |
-i|--init) |
| 812 |
initChibiOS; printf "\n"; shift 1;; |
| 813 |
-p|--patch) |
| 814 |
patchChibiOS; printf "\n"; shift 1;; |
| 815 |
-d=*|--documentation=*) |
| 816 |
documentation "${1#*=}"; printf "\n"; shift 1;;
|
| 817 |
-d|--documentation) |
| 818 |
if ( ! parseIsOption $2 ); then |
| 819 |
documentation "$2"; printf "\n"; shift 2 |
| 820 |
else |
| 821 |
documentation; printf "\n"; shift 1 |
| 822 |
fi;; |
| 823 |
-w|--wipe) |
| 824 |
wipeChibiOS; printf "\n"; shift 1;; |
| 825 |
-q|--quit) |
| 826 |
quitScript; shift 1;; |
| 827 |
--log=*|--LOG=*) # already handled; ignore |
| 828 |
shift 1;; |
| 829 |
--log|--LOG) # already handled; ignore |
| 830 |
shift 2;; |
| 831 |
--noinfo) # already handled; ignore |
| 832 |
shift 1;; |
| 833 |
*) |
| 834 |
printError "invalid option: $1\n"; shift 1;; |
| 835 |
esac |
| 836 |
else |
| 837 |
otherargs+=("$1")
|
| 838 |
shift 1 |
| 839 |
fi |
| 840 |
done |
| 841 |
|
| 842 |
# interactive menu |
| 843 |
while ( true ); do |
| 844 |
# main menu info prompt and selection |
| 845 |
printInfo "ChibiOS kernel setup main menu\n" |
| 846 |
printf "Please select one of the following actions:\n" |
| 847 |
printf " [I] - initialize ChibiOS submodule\n" |
| 848 |
printf " [P] - apply patches to ChibiOS\n" |
| 849 |
printf " [D] - generate or open HTML documentation\n" |
| 850 |
printf " [W] - wipe ChibiOS submodule\n" |
| 851 |
printf " [Q] - quit this setup\n" |
| 852 |
local userinput="" |
| 853 |
readUserInput "IiPpDdWwQq" userinput |
| 854 |
printf "\n" |
| 855 |
|
| 856 |
# evaluate user selection |
| 857 |
case "$userinput" in |
| 858 |
I|i) |
| 859 |
initChibiOS; printf "\n";; |
| 860 |
P|p) |
| 861 |
patchChibiOS; printf "\n";; |
| 862 |
D|d) |
| 863 |
documentation; printf "\n";; |
| 864 |
W|w) |
| 865 |
wipeChibiOS; printf "\n";; |
| 866 |
Q|q) |
| 867 |
quitScript;; |
| 868 |
*) # sanity check (exit with error) |
| 869 |
printError "unexpected argument: $userinput\n";; |
| 870 |
esac |
| 871 |
done |
| 872 |
|
| 873 |
exit 0 |
| 874 |
} |
| 875 |
|
| 876 |
################################################################################ |
| 877 |
# SCRIPT ENTRY POINT # |
| 878 |
################################################################################ |
| 879 |
|
| 880 |
main "$@" |