Skip to content

SKUNK-1029 Document by_ref exception for shell rule S1481 #5952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mpaladin merged 2 commits into from
Dec 10, 2025
Merged

SKUNK-1029 Document by_ref exception for shell rule S1481 #5952

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54a427c
Document by_ref exception for shell rule S1481
romainbrenguier Dec 3, 2025
3de462c
Use "Special Cases" rather than exception
romainbrenguier Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions rules/S1481/shell/rule.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
include::../rationale.adoc[]

=== Special Cases

Variables passed by reference to functions whose name contains `by_ref` are considered used. In bash, some functions accept variable names as plain word arguments (not `$var` expansions) and modify them indirectly. When such a function name contains `by_ref`, word arguments matching declared variable names are counted as legitimate usages.

[source,bash]
----
function process_data() {
local result status # Compliant: result and status are used by reference
get_values_by_ref result status
}
----

include::../how-to-fix-it.adoc[]

=== Code examples
Expand Down
Loading