hpc / hpc/mpifileutils

documentation: `dtar` doesn't have a `--verbose` option

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

Nobody has claimed this yet.

Dominant language
C
Stars
200
Forks
85
Avg merge
3d 21h
Merged PRs (30d)
2

Description

Hi!

The current documentation for dtar lists a --verbose option (https://mpifileutils.readthedocs.io/en/0.12-rtd/dtar.1.html#cmdoption-v), but that option doesn't seem to actually exist in dtar 0.12:

$ dtar -h

Usage: dtar [options] <source ...>

Options:
  -c, --create            - create archive
  -x, --extract           - extract archive
  -f, --file <FILE>       - specify archive file
  -C, --chdir <DIR>       - change directory to DIR before executing
      --preserve-owner    - preserve owner/group (default effective uid/gid)
      --preserve-times    - preserve atime/mtime (default current time)
      --preserve-perms    - preserve permissions (default subtracts umask)
      --preserve-xattrs   - preserve xattrs (default ignores xattrs)
      --fsync             - sync file data to disk on close
  -b, --bufsize <SIZE>    - IO buffer size in bytes (default 4MB)
  -k, --chunksize <SIZE>  - work size per task in bytes (default 4MB)
      --memsize <SIZE>    - memory limit per task for parallel read in bytes (default 256MB)
      --progress <N>      - print progress every N seconds
  -q, --quiet             - quiet output
  -h, --help              - print usage
For more information see https://mpifileutils.readthedocs.io.

And the option seems to be commented in the code:
https://github.com/hpc/mpifileutils/blob/v0.12/src/dtar/dtar.c#L153

Does the documentation need to be updated?

Contributor guide

Open the contributing guide

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

Inspect the dtar documentation linked in the issue and compare its options with the usage output shown there. Check src/dtar/dtar.c around line 153, then remove or correct the nonexistent --verbose entry and verify the rendered documentation no longer lists it.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.