-
Notifications
You must be signed in to change notification settings - Fork 416
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
Add doc for config file #6392
Add doc for config file #6392
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly grammar & formatting.
I’ve questions about the subheadings. If they’re commands or files, like config
, it is possible to show them in monospace in the heading? If so, that’s best for clarify. If not, perhaps consider capitalizing them, like Concurrency, etc.
Thanks. I committed all suggestions.
I switched them to code style. |
@christinerose could you please give a formal approval if you are happy with the current state of the PR? Thanks! |
I don't think I like the location of the configuration documentation here. I think it would be better for it to come near the end of
|
doc/dune-files.rst
Outdated
with some colors to help differentiate programs. | ||
|
||
- ``short`` print one line per command being executed, with the binary name on | ||
the left and the reason it is being executed for on the right. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about:
prints a line for each program executed with the binary name on the left and the targets of the action on the right.
doc/dune-files.rst
Outdated
- ``progress``, Dune shows and updates a status line as build goals are being | ||
completed (this is the default). | ||
|
||
- ``verbose`` prints the full command lines of programs being executed by Dune, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- ``verbose`` prints the full command lines of programs being executed by Dune, | |
- ``verbose`` prints the full command lines of programs executed by Dune, |
(looking to tighten syntax a little, but it's fine the way it is if you prefer)
doc/dune-files.rst
Outdated
with some colors to help differentiate programs. | ||
|
||
- ``short`` print one line per command being executed, with the binary name on | ||
the left and the reason it is being executed for on the right. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or...
prints a line for each program executed with the binary name on the left and the action targets on the right
???
It's also fine the way it is if you prefer. Just looking to tighten syntax where possible and minimize passive voice. :)
So sorry for the delay! Approved now. |
Thanks for the detailed comments @Alizter! I implemented all of your recommendations. Do you mind giving a formal approval (if you are happy with the state of the PR)? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good. Some more comments.
doc/dune-files.rst
Outdated
config | ||
====== | ||
|
||
This file is used to set global configuration of Dune (applicable across |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is used to set global configuration of Dune (applicable across | |
This file is used to set the global configuration of Dune (applicable across |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Co-authored-by: Christine Rose <[email protected]> Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Signed-off-by: Nicolás Ojeda Bär <[email protected]>
Thanks @Alizter! I amended as per your comments and will merge once CI passes. |
concurrency | ||
----------- | ||
|
||
Maximum number of concurrent jobs Dune is allowed to have. | ||
|
||
.. code:: scheme | ||
|
||
(concurrency <setting>) | ||
|
||
where ``<setting>`` is one of: | ||
|
||
- ``auto``, auto-detect maximum number of cores. This is the default value. | ||
|
||
- ``<number>``, a positive integer specifying the maximum number of jobs Dune | ||
may use simultaneously. | ||
|
||
.. _terminal-persistence: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This appears to be made up. We should have called this jobs.
Fixes #5493
Moreover, the "man" page for
dune-config(5)
is terribly out-of-date and does not seem very pratical to have the information in two places (the manual and the man page). Since we don't document any other Dune file format in man page format, shall we get rid of thedune-config(5)
man page?