Clarify how to set $0 properly in run_in_shell_command (Cherry-pick…

… of #19019) (#19031) Fixes #19017 (well turns out it was a non-issue) by suggesting to users how to get `$0` properly in their binaries. Co-authored-by: Joshua Cannon <[email protected]>
pantsbuild · May 18, 2023 · b008277 · b008277
1 parent c3dddf9
commit b008277
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/src/python/pants/backend/shell/target_types.py b/src/python/pants/backend/shell/target_types.py
@@ -266,7 +266,15 @@ class ShellSourcesGeneratorTarget(TargetFilesGenerator):
 class ShellCommandCommandField(StringField):
     alias = "command"
     required = True
-    help = "Shell command to execute.\n\nThe command is executed as 'bash -c <command>' by default."
+    help = help_text(
+        """
+        Shell command to execute.
+
+        The command is executed as 'bash -c <command>' by default. If you want to invoke a binary
+        use `exec -a $0 <binary> <args>` as the command so that the binary gets the correct `argv[0]`
+        set.
+        """
+    )
 
 
 class ShellCommandOutputsField(StringSequenceField):