Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
steam-runtime-tools
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
steamrt
steam-runtime-tools
Commits
b2a2a20e
Commit
b2a2a20e
authored
4 months ago
by
Simon McVittie
Browse files
Options
Downloads
Patches
Plain Diff
slr-for-game-developers: Recommend linting shell scripts with shellcheck
Signed-off-by:
Simon McVittie
<
smcv@collabora.com
>
parent
b0c8aa8f
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/slr-for-game-developers.md
+8
-2
8 additions, 2 deletions
docs/slr-for-game-developers.md
with
8 additions
and
2 deletions
docs/slr-for-game-developers.md
+
8
−
2
View file @
b2a2a20e
...
...
@@ -1291,9 +1291,14 @@ Shell scripts can start with `#!/bin/sh` to use a small POSIX shell,
or
`#!/bin/bash`
to use GNU
`bash`
.
Similar to Debian and Ubuntu, the
`/bin/sh`
in the container is not
`bash`
, so
`bash`
features cannot be used in
`#!/bin/sh`
scripts.
[
Debian Policy
][]
has some useful advice on writing robust shell scripts.
[
Debian Policy
][]
has some useful advice on writing robust shell scripts,
and the
[
shellcheck
][]
lint tool usually gives good recommendations.
Basic shell utilities are available in the container runtime, but more
advanced utilities might not be present.
advanced utilities will often not be present.
The legacy
[
`LD_LIBRARY_PATH`-based scout runtime
][
ldlp-runtime
]
cannot guarantee the presence of anything beyond basic shell utilities
either.
<!-- References: -->
...
...
@@ -1325,6 +1330,7 @@ advanced utilities might not be present.
[
scout-on-soldier
]:
container-runtime.md#scout-on-soldier
[
set launch options
]:
https://help.steampowered.com/en/faqs/view/7D01-D2DD-D75E-2955
[
shared-paths
]:
shared-paths.md
[
shellcheck
]:
https://www.shellcheck.net/
[
sniper SDK
]:
https://gitlab.steamos.cloud/steamrt/sniper/sdk/-/blob/steamrt/sniper/README.md
[
sniper
]:
https://gitlab.steamos.cloud/steamrt/steamrt/-/blob/steamrt/sniper/README.md
[
soldier SDK
]:
https://gitlab.steamos.cloud/steamrt/soldier/sdk/-/blob/steamrt/soldier/README.md
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment