Fixing "run all examples" command for macOS (Contributing page) #61
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
While running this on my machine (Apple silicon mac) I got this:
`xargs: command line cannot be assembled, too long`
On macOS (and possibly other compatible systems), there is a limit on the size of arguments that can be passed using the "-I" flag. From the manual page (`man xargs`):
```
-S replsize
Specify the amount of space (in bytes) that -I can use for
replacements. The default for replsize is 255.
```
Bumping this number up (e.g. adding -S1024) can resolve this problem.
MBerguer
requested review from
zerosnacks,
yash-atreya and
Evalir
as code owners
zerosnacks
reviewed
Apr 22, 2024
| @@ -148,7 +148,7 @@ cargo run --example 2>&1 \ | |||
| -e 'ws_auth' \ | |||
| -e 'connect_builtin' \ | |||
| -e 'subscribe_logs' \ | |||
| | xargs -I {} sh -c 'if cargo run --example {} --quiet 1>/dev/null; then \ | |||
There was a problem hiding this comment.
Unfortunately the -S flag does not exist on Linux, I'll add a Bash script so it can more easily be ran across all operating systems
There was a problem hiding this comment.
Ok, I thought this would be easier, but it didn't count with that; let me know if you need help 💪
You can go ahead and close this PR if you plan to open another one or an issue in the future
There was a problem hiding this comment.
Closing for now, will think of a better way to enable contributors to run the examples easily. Bash is quite brittle as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While running this on my machine (Apple silicon mac) I got this:
xargs: command line cannot be assembled, too longOn macOS (and possibly other compatible systems), there is a limit on the size of arguments that can be passed using the
-Iflag. From the manual page (man xargs):So, bumping this number up (e.g. adding
-S1024) can resolve this problem.This change shouldn't affect other architectures, but It would be great if the reviewer could validate this on another setup different than mine.
Motivation
Smoother dev contributing experience (just copy n' paste)
Solution
Adding a flag to the To run all (runnable) examples, specifically to the
xargspart of the command.xargs -S1024 -I {} sh -c 'if cargo run --example {} --quiet 1>/dev/null;PR Checklist