2.5. Batch and Shell Coding Guidelines

These coding guidelines MUST be applied to all batch/shell scripts.

2.5.1. Batch

The following rules generally apply and follow the naming schema BATCH:<ongoing-number>.

2.5.1.1. Filenames (BATCH:001)

The following rules apply for filenames of batch scripts.

Batch script filenames

  • The general file naming rules MUST be applied (see Section 2.1.1).

  • Batch scripts MUST use .bat as file extension.

For example the valid file names for batch scripts are

  • hello.bat

  • my-script.bat

2.5.1.2. Header (BATCH:002)

Batch script header

Batch scripts MUST start with the following header:

Listing 2.42 File header for batch scripts.
 1@REM Copyright (c) 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
 2@REM All rights reserved.
 3@REM
 4@REM SPDX-License-Identifier: BSD-3-Clause
 5@REM
 6@REM Redistribution and use in source and binary forms, with or without
 7@REM modification, are permitted provided that the following conditions are met:
 8@REM
 9@REM 1. Redistributions of source code must retain the above copyright notice, this
10@REM    list of conditions and the following disclaimer.
11@REM
12@REM 2. Redistributions in binary form must reproduce the above copyright notice,
13@REM    this list of conditions and the following disclaimer in the documentation
14@REM    and/or other materials provided with the distribution.
15@REM
16@REM 3. Neither the name of the copyright holder nor the names of its
17@REM    contributors may be used to endorse or promote products derived from
18@REM    this software without specific prior written permission.
19@REM
20@REM THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21@REM AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22@REM IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23@REM DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24@REM FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25@REM DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26@REM SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27@REM CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28@REM OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29@REM OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30@REM
31@REM We kindly request you to use one or more of the following phrases to refer to
32@REM foxBMS in your hardware, software, documentation or advertising materials:
33@REM
34@REM - "This product uses parts of foxBMS&reg;"
35@REM - "This product includes parts of foxBMS&reg;"
36@REM - "This product is derived from foxBMS&reg;"

2.5.2. Shell

The following rules generally apply and follow the naming schema SHELL:<ongoing-number>.

2.5.2.1. Filenames (SHELL:001)

The following rules apply for filenames of shell scripts.

Shell script filenames

  • The general file naming rules MUST be applied (see Section 2.1.1).

  • Shell scripts MUST use .sh as file extension.

For example the valid file names for shell scripts are

  • hello.sh

  • my-script.sh

2.5.2.2. Header (SHELL:002)

Shell script header

Shell scripts MUST start with the following header:

Listing 2.43 File header for shell scripts.
 1#!/usr/bin/env bash
 2#
 3# Copyright (c) 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
 4# All rights reserved.
 5#
 6# SPDX-License-Identifier: BSD-3-Clause
 7#
 8# Redistribution and use in source and binary forms, with or without
 9# modification, are permitted provided that the following conditions are met:
10#
11# 1. Redistributions of source code must retain the above copyright notice, this
12#    list of conditions and the following disclaimer.
13#
14# 2. Redistributions in binary form must reproduce the above copyright notice,
15#    this list of conditions and the following disclaimer in the documentation
16#    and/or other materials provided with the distribution.
17#
18# 3. Neither the name of the copyright holder nor the names of its
19#    contributors may be used to endorse or promote products derived from
20#    this software without specific prior written permission.
21#
22# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32#
33# We kindly request you to use one or more of the following phrases to refer to
34# foxBMS in your hardware, software, documentation or advertising materials:
35#
36# - "This product uses parts of foxBMS&reg;"
37# - "This product includes parts of foxBMS&reg;"

2.5.3. File Templates

These file templates below show how these rules are correctly applied. They SHOULD be used as basis for new files.