doc: add man page for clear-usage command, update docs with related information#814
Merged
mergify[bot] merged 4 commits intoflux-framework:masterfrom Feb 12, 2026
Merged
Conversation
Problem: There is no test in t1026-flux-account-perms.t that makes sure that the "clear-usage" command is not accessible by all users. Add a test.
Problem: The add-bank(1) and edit-bank(1) pages are not updated with the new --ignore-older-than optional argument. Update the man(1) pages with the new optional argument.
Problem: There is no man(1) page for the clear-usage command. Add one.
Problem: There is no mention of the clear-usage command and its potential benefit anywhere in the "Components" section of the flux-accounting documentation. Add a small section to the Job Usage Calculation page in the flux-accounting documentation about resetting the usage for a bank and its potential benefit.
cmoussa1
added
documentation
wihobbs
approved these changes
Feb 11, 2026
|
|
||
| An associated priority to be applied to jobs submitted under this bank. | ||
|
|
||
| .. option:: --ignore-older-than |
Member
There was a problem hiding this comment.
Suggested change
| .. option:: --ignore-older-than | |
| .. option:: --ignore-older-than=SECONDS|DATETIME |
| :program:`flux account edit-bank` allows for the modifications of certain | ||
| fields for a given bank. The list of modifiable fields are as follows: | ||
|
|
||
| .. option:: --parent-bank |
Member
There was a problem hiding this comment.
These three options are repeated across two commands. Are they repeated other places too? You might save yourself some copy/paste (and potential errors down the line) by having a file like doc/man1/common/bank-common-params.rst that you can drop in here. See flux-run(1) for an example.
Member
Author
There was a problem hiding this comment.
No, those are the only places where they are listed, but this is a good suggestion. I should probably look into this, because there are plenty of options that are shared across the add-* and edit-* commands.
Contributor
Merge Queue StatusRule:
This pull request spent 6 seconds in the queue, with no time running CI. Required conditions to merge
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #814 +/- ##
=======================================
Coverage 82.93% 82.93%
=======================================
Files 27 27
Lines 2479 2479
=======================================
Hits 2056 2056
Misses 423 423 🚀 New features to boost your workflow:
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Problem
There is no man(1) page for the
clear-usagecommand.This PR adds one. I've also snuck in a couple other commits to a) add a test to check that
clear-usageis not accessible by all users, b), update theadd-bank(1)andedit-bank(1)pages with the new--ignore-older-thanoptional argument, and c), add a section onclear-usageand why it might be beneficial to run.