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

Default for -j is not clear #167

Closed
durka opened this issue Oct 11, 2016 · 4 comments
Closed

Default for -j is not clear #167

durka opened this issue Oct 11, 2016 · 4 comments
Labels
doc An issue with or an improvement to documentation.

Comments

@durka
Copy link
Contributor

durka commented Oct 11, 2016

rg --help says this:

    -j, --threads ARG
        The number of threads to use. Defaults to the number of logical CPUs
        (capped at 6). [default: 0]

I have four cores here. Given this documentation I have no idea what the default parallelishness is :)

@BurntSushi
Copy link
Owner

I guess it's confusing because of [default: 0]?

I guess it should say, "0 means use the number of logical CPUs, capped at 6."

@BurntSushi BurntSushi added the doc An issue with or an improvement to documentation. label Oct 11, 2016
@durka
Copy link
Contributor Author

durka commented Oct 11, 2016

That would be much more clear!

@durka
Copy link
Contributor Author

durka commented Oct 11, 2016

I can make a PR. Are the man pages auto generated somehow or should I make the same edits there?

@BurntSushi
Copy link
Owner

BurntSushi commented Oct 11, 2016

@durka Thanks! They aren't auto-generated unfortunately. You'll need to edit both src/args.rs and doc/rg.1.md, and then run cd doc && ./convert-to-man.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc An issue with or an improvement to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants