Skip to content
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.

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

Update conflicting docs for default number of jobs #1452

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

adamcohen2
Copy link

@adamcohen2 adamcohen2 commented Mar 26, 2024

This PR removes the absent=<number-of-cores-deteced> from the docs, since this value is variable and depends on the number of cores of the machine where semgrep is run. This leads to conflicting information in the docs, because the description of the --jobs parameter explains that it defaults to the number of cores detected on the system, whereas the absent=4 value is hardcoded, which is confusing.

Please ensure

  • A subject matter expert (SME) reviews the content
  • A technical writer reviews the content or PR
  • This change has no security implications or else you have pinged the security team
  • Redirects are added if the PR changes page URLs
  • If you have changed any header tag links (doc/#this-kind-of-anchor), update all instances of that link

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@@ -163,7 +163,7 @@ OPTIONS
have time limit. Defaults to 0 s for all CLI scans. For CI scans,
it defaults to 3 hours.

-j VAL, --jobs=VAL (absent=4)
-j VAL, --jobs=VAL
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this text automatically generated based on the output of running semgrep --help? If it is automatically generated, then it's more difficult to change...

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adamcohen2 Yes, you're right, it's automatically generated from the main semgrep repo. I'll let the team know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants