hpc / hpc/ior

-q quitOnError option is now --warningAsErrors user guide is outdated

Open
#256 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
C
Stars
487
Forks
200
Avg merge
1d 21h
Merged PRs (30d)
2

Description

Hi,
the -q quitOnError option is no longer supported and leads to an unrecognized option error.
I'am fine with the change also with ior behavior, but it is still noted in the user doc.
Maybe you might want to update the user guide.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open doc/USER_GUIDE around line 95 and compare its -q/quitOnError entry with the currently supported command-line options. Update the guide so it no longer documents the unsupported option and accurately describes the replacement behavior, then verify the edited entry against the CLI help or option documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.