StarMirror/styleguide
1
0
Fork 0
mirror of https://github.com/google/styleguide.git synced 2024-03-22 13:11:43 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #534 from google/change_HEAD

Browse Source 
Project import generated by Copybara.
This commit is contained in:
Mike Frysinger 2020-02-27 18:21:26 -05:00 committed by GitHub
commit 250bd6a4b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
shellguide.md
View File

@ -132,7 +132,7 @@ information is recommended.
```shell ```shell
err() { err() {
echo "[$(date +'%Y-%m-%dT%H:%M:%S%z')]: $*" > &2 echo "[$(date +'%Y-%m-%dT%H:%M:%S%z')]: $*" >&2
} }
if ! do_something; then if ! do_something; then
@ -758,6 +758,7 @@ removed `./somefile'
`eval` should be avoided. `eval` should be avoided.
Eval munges the input when used for assignment to variables and can Eval munges the input when used for assignment to variables and can
set variables without making it possible to check what those variables set variables without making it possible to check what those variables
were. were.
@ -1146,15 +1147,13 @@ my_func2() {
### Function Location ### Function Location
Put all functions together in the file just below constants. Don't hide Put all functions together in the file just below constants. Don't hide
executable code between functions. executable code between functions. Doing so makes the code difficult to follow
and results in nasty surprises when debugging.
If you've got functions, put them all together near the top of the If you've got functions, put them all together near the top of the
file. Only includes, `set` statements and setting constants file. Only includes, `set` statements and setting constants
may be done before declaring functions. may be done before declaring functions.
Don't hide executable code between functions. Doing so makes the code
difficult to follow and results in nasty surprises when debugging.
<a id="s7.8-main"></a> <a id="s7.8-main"></a>
### main ### main
@ -1193,14 +1192,14 @@ Example:
```shell ```shell
if ! mv "${file_list[@]}" "${dest_dir}/"; then if ! mv "${file_list[@]}" "${dest_dir}/"; then
echo "Unable to move ${file_list[*]} to ${dest_dir}" > &2 echo "Unable to move ${file_list[*]} to ${dest_dir}" >&2
exit 1 exit 1
fi fi
# Or # Or
mv "${file_list[@]}" "${dest_dir}/" mv "${file_list[@]}" "${dest_dir}/"
if (( $? != 0 )); then if (( $? != 0 )); then
echo "Unable to move ${file_list[*]} to ${dest_dir}" > &2 echo "Unable to move ${file_list[*]} to ${dest_dir}" >&2
exit 1 exit 1
fi fi
``` ```
@ -1213,7 +1212,7 @@ following is acceptable:
```shell ```shell
tar -cf - ./* | ( cd "${dir}" && tar -xf - ) tar -cf - ./* | ( cd "${dir}" && tar -xf - )
if (( PIPESTATUS[0] != 0 || PIPESTATUS[1] != 0 )); then if (( PIPESTATUS[0] != 0 || PIPESTATUS[1] != 0 )); then
echo "Unable to tar files to ${dir}" > &2 echo "Unable to tar files to ${dir}" >&2
fi fi
``` ```