Jenkins scripts port: update shell function comments

Review function comments style.
https://google.github.io/styleguide/shellguide.html#function-comments

Change-Id: I8c557fd6cb653744d93c28cd28caeef3e4bf10bc
Bug: b:185520507
This commit is contained in:
Roberto Alanis 2021-10-27 15:23:09 +00:00
parent 21d24b4c08
commit 35b7436a21
2 changed files with 14 additions and 9 deletions

View File

@ -34,8 +34,10 @@ log_err() {
####################################### #######################################
# Create build directory. Build directory will be deleted if it exists. # Create build directory. Build directory will be deleted if it exists.
# Arguments:
# None.
# Returns: # Returns:
# mkdir result # mkdir result.
####################################### #######################################
make_build_dir() { make_build_dir() {
if [[ "$#" -ne 1 ]]; then if [[ "$#" -ne 1 ]]; then
@ -50,10 +52,10 @@ make_build_dir() {
####################################### #######################################
# Cleanup files from the build directory. # Cleanup files from the build directory.
# Args:
# $1 build directory
# Globals: # Globals:
# LIBWEBP_ROOT repository's root path # LIBWEBP_ROOT repository's root path.
# Arguments:
# $1 build directory.
####################################### #######################################
cleanup() { cleanup() {
# $1 is not completely removed to allow for binary artifacts to be # $1 is not completely removed to allow for binary artifacts to be
@ -64,6 +66,10 @@ cleanup() {
####################################### #######################################
# Setup ccache for toolchain. # Setup ccache for toolchain.
# Globals:
# PATH
# Arguments:
# None.
####################################### #######################################
setup_ccache() { setup_ccache() {
if [[ -x "$(command -v ccache)" ]]; then if [[ -x "$(command -v ccache)" ]]; then

View File

@ -50,14 +50,13 @@ EOF
####################################### #######################################
# Wrap clang-tools scan-build. # Wrap clang-tools scan-build.
# # Globals:
# Args: # OUTPUT_DIR target directory where scan-build report is generated.
# MODE scan-build mode
# Arguments:
# $* scan-build additional args. # $* scan-build additional args.
# Returns: # Returns:
# scan-build retcode # scan-build retcode
# Global:
# OUTPUT_DIR target directory where scan-build report is generated.
# MODE scan-build mode
####################################### #######################################
scan_build() { scan_build() {
scan-build -o "${OUTPUT_DIR}" --use-analyzer="$(command -v clang)" \ scan-build -o "${OUTPUT_DIR}" --use-analyzer="$(command -v clang)" \