Request to update `dfind --help`
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 200
- Forks
- 85
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 2
Description
Dear Development Team,
Thank you for developing mpifileutils.
It will be very helpful if the help information for dfind can be updated to reflect the functionality available in version 0.12.
Especially the --type C options.
Since this information is not current, and the first Google search result for "mpifileutils dfind" returns v0.9.1 docs, it is very challenging to learn the current functionality offered by dfind.
Current behavior
$ dfind --help
Usage: dfind [options] <path> EXPRESSIONS...
Options:
-i, --input <file> - read list from file
-o, --output <file> - write processed list to file
-t, --text - use with -o; write processed list to file in ascii format
-v, --verbose - verbose output
-q, --quiet - quiet output
-h, --help - print usage
Tests:
--amin N - last accessed N minutes ago
--anewer FILE - last accessed more recently than FILE modified
--atime N - last accessed N days ago
--cmin N - status last changed N minutes ago
--cnewer FILE - status last changed more recently than FILE modified
--ctime N - status last changed N days ago
--mmin N - data last modified N minutes ago
--newer FILE - modified more recently than FILE
--mtime N - data last modified N days ago
--gid N - numeric group ID is N
--group NAME - belongs to group NAME
--uid N - numeric user ID is N
--user NAME - owned by user NAME
--name PATTERN - base name matches shell pattern PATTERN
--path PATTERN - full path matches shell pattern PATTERN
--regex REGEX - full path matches POSIX regex REGEX
--size N - size is N bytes. Supports attached units like KB, MB, GB
--type C - of type C: d=dir, f=file, l=symlink
Tests with N can use -N (less than N), N (exactly N), +N (more than N)
Actions:
--print - print item name to stdout
--exec CMD ; - execute CMD on item
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the source for the dfind --help output and compare its options with the version 0.12 dfind documentation linked in the issue. Update the help text, especially the --type C options, so it reflects current functionality and verify that dfind --help shows the documented options.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100