btrfs-progs/common
David Sterba ec5ebf35ec btrfs-progs: help: recognize --help option among other options
There's a report that handling of --help in connection with other option
is confusing in some cases:

Various sub-commands to btrfs claim --help is an unrecognized option if
there are any other options on the CLI.

Examples of --help being unrecognized.

  $ btrfs filesystem defragment -v --help
  btrfs filesystem defragment: unrecognized option '--help'
  Try 'btrfs filesystem defragment --help' for more information

  $ btrfs balance start -v --help
  $ btrfs balabtrfs balance start -v --help
  btrfs balance start: unrecognized option '--help'
  Try 'btrfs balance start --help' for more information

Alternatively, some sub-commands support --help even if there are extra
options on the CLI:

  $ btrfs filesystem df -v --help
  usage: btrfs filesystem df [options] <path>

      Show space usage information for a mount point

      -b|--raw                  raw numbers in bytes
      -h|--human-readable       human friendly numbers, base 1024 (default)
      -H                        human friendly numbers, base 1000
      --iec                     use 1024 as a base (KiB, MiB, GiB, TiB)
      --si                      use 1000 as a base (kB, MB, GB, TB)
      -k|--kbytes               show sizes in KiB, or kB with --si
      -m|--mbytes               show sizes in MiB, or MB with --si
      -g|--gbytes               show sizes in GiB, or GB with --si
      -t|--tbytes               show sizes in TiB, or TB with --si

      Global options:
      --format TYPE             where TYPE is: text

Update clean_args_no_options() to detect unrecognized options properly
and do not show full help text (which usued to be done in the past but
is confusing and not pointing to the problem).

There's also a mixup of global verbosity options and command-specific
verbosity options (now deprecated), so in some commands they are
recognized.

Also handle the --help option for commands without options so the
following works:

  $ btrfs fi df -v --help /
  btrfs filesystem df: invalid option 'v'
  Try 'btrfs filesystem df --help' for more information

  $ btrfs fi df -H --help /
  usage: btrfs filesystem df [options] <path>

      Show space usage information for a mount point

      -b|--raw                  raw numbers in byte
  ...

Issue: #889
Signed-off-by: David Sterba <dsterba@suse.com>
2025-02-11 20:43:28 +01:00
..
array.c btrfs-progs: run codespell throughout fixing typos automagically 2024-07-30 19:56:08 +02:00
array.h btrfs-progs: add an extensible pointer array struct 2023-08-28 17:24:24 +02:00
box.h btrfs-progs: add btrfs-find-root to btrfs.box 2023-07-26 15:00:48 +02:00
clear-cache.c btrfs-progs: clean up includes 2025-01-16 19:13:26 +01:00
clear-cache.h btrfs-progs: move clear-cache.[ch] from check/ to common/ directory 2023-10-13 18:13:12 +02:00
cpu-utils.c btrfs-progs: clean up includes, using include-what-you-use 2023-10-03 01:11:57 +02:00
cpu-utils.h btrfs-progs: detect PCLMUL CPU support for accelerated crc32c 2023-09-13 00:38:50 +02:00
defs.h btrfs-progs: move common-defs to common/ 2020-03-31 18:37:35 +02:00
device-scan.c btrfs-progs: rename and move __strncpy_null to string-utils 2024-06-24 19:18:46 +02:00
device-scan.h btrfs-progs: clean up includes 2025-01-16 19:13:26 +01:00
device-utils.c btrfs-progs: support byte length for zone resetting 2024-06-03 21:26:39 +02:00
device-utils.h btrfs-progs: clean up includes 2025-01-16 19:13:26 +01:00
extent-cache.c btrfs-progs: make all parameters of rb_tree search/insert const 2024-03-12 21:43:54 +01:00
extent-cache.h btrfs-progs: common: update include lists, part 1 2022-10-11 09:08:07 +02:00
extent-tree-utils.c btrfs-progs: clean up includes 2025-01-16 19:13:26 +01:00
extent-tree-utils.h btrfs-progs: clean up includes 2025-01-16 19:13:26 +01:00
filesystem-utils.c btrfs-progs: open the devices exclusively for writes 2024-09-17 14:33:22 +02:00
filesystem-utils.h btrfs-progs: common: update include lists, part 1 2022-10-11 09:08:07 +02:00
format-output.c btrfs-progs: properly close va_copy in fmt_set_unquoted() 2024-04-18 19:16:15 +02:00
format-output.h btrfs-progs: rename time-long format name to date-time 2023-08-28 17:24:23 +02:00
fsfeatures.c btrfs-progs: move RST back to experimental 2024-06-24 19:18:32 +02:00
fsfeatures.h btrfs-progs: clean up includes 2025-01-16 19:13:26 +01:00
help.c btrfs-progs: help: recognize --help option among other options 2025-02-11 20:43:28 +01:00
help.h btrfs-progs: add support for dry-run options 2023-11-03 18:04:37 +01:00
inject-error.c btrfs-progs: clean up includes, using include-what-you-use 2023-10-03 01:11:57 +02:00
inject-error.h btrfs-progs: clean up includes, using include-what-you-use 2023-10-03 01:11:57 +02:00
internal.h btrfs-progs: pull in the full max/min/clamp implementation from kernel 2023-10-10 19:16:29 +02:00
messages.c btrfs-progs: handle write errors in btrfs_add_to_fsid() 2024-03-16 22:25:50 +01:00
messages.h btrfs-progs: add uClibc-ng compatibility for printf format %pV 2024-07-30 19:53:33 +02:00
open-utils.c btrfs-progs: use strncpy_null everywhere 2024-06-24 19:18:48 +02:00
open-utils.h btrfs-progs: rename btrfs_open_fd2() to btrfs_open_path() 2024-02-20 12:59:29 +01:00
parse-utils.c btrfs-progs: implement arg_strtou64_with_suffix() with a new helper 2024-01-18 02:14:23 +01:00
parse-utils.h btrfs-progs: implement arg_strtou64_with_suffix() with a new helper 2024-01-18 02:14:23 +01:00
path-utils.c btrfs-progs: rename and move __strncpy_null to string-utils 2024-06-24 19:18:46 +02:00
path-utils.h btrfs-progs: rename and move __strncpy_null to string-utils 2024-06-24 19:18:46 +02:00
rbtree-utils.c btrfs-progs: make all parameters of rb_tree search/insert const 2024-03-12 21:43:54 +01:00
rbtree-utils.h btrfs-progs: make all parameters of rb_tree search/insert const 2024-03-12 21:43:54 +01:00
root-tree-utils.c btrfs-progs: clean up includes 2025-01-16 19:13:26 +01:00
root-tree-utils.h btrfs-progs: clean up includes 2025-01-16 19:13:26 +01:00
send-stream.c btrfs-progs: clean up includes 2025-01-16 19:13:26 +01:00
send-stream.h btrfs-progs: clean up includes, using include-what-you-use 2023-10-03 01:11:57 +02:00
send-utils.c btrfs-progs: move uuid-tree definitions to kernel-shared/uuid-tree.h 2024-07-30 20:01:59 +02:00
send-utils.h btrfs-progs: clean up includes 2025-01-16 19:13:26 +01:00
sort-utils.c btrfs-progs: run codespell throughout fixing typos automagically 2024-07-30 19:56:08 +02:00
sort-utils.h btrfs-progs: run codespell throughout fixing typos automagically 2024-07-30 19:56:08 +02:00
string-table.c btrfs-progs: string-table: fix memory leak on exit path in table_vprintf() 2024-04-18 19:16:15 +02:00
string-table.h btrfs-progs: string-table: add ranged API for printing and clearing 2022-12-05 20:32:02 +01:00
string-utils.c btrfs-progs: factor string escaping helpers from receive dump 2024-07-30 19:53:33 +02:00
string-utils.h btrfs-progs: factor string escaping helpers from receive dump 2024-07-30 19:53:33 +02:00
sysfs-utils.c btrfs-progs: change all sysfs helpers to return errno 2023-12-09 01:17:22 +01:00
sysfs-utils.h btrfs-progs: clean up includes 2025-01-16 19:13:26 +01:00
task-utils.c btrfs-progs: common: update include lists, part 1 2022-10-11 09:08:07 +02:00
task-utils.h btrfs-progs: common: update include lists, part 1 2022-10-11 09:08:07 +02:00
tree-search.h btrfs-progs: fix struct btrfs_tree_search_args layout 2025-01-17 22:30:40 +01:00
units.c btrfs-progs: introduce UASSERT() for purely userspace code 2023-05-26 18:02:28 +02:00
units.h btrfs-progs: common: update include lists, part 1 2022-10-11 09:08:07 +02:00
utils.c btrfs-progs: utils: flush stdout after prompt in ask_user() 2024-11-28 14:40:46 +01:00
utils.h btrfs-progs: clean up includes 2025-01-16 19:13:26 +01:00