Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[2.2] cmd: add 'help' subcommand to zpool and zfs #15343

Closed
wants to merge 1 commit into from
Closed

[2.2] cmd: add 'help' subcommand to zpool and zfs #15343

wants to merge 1 commit into from

Conversation

robn
Copy link
Member

@robn robn commented Oct 3, 2023

Description

2.2 backport of #15288.

How Has This Been Tested?

Build and quick functional check.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Performance enhancement (non-breaking change which improves efficiency)
  • Code cleanup (non-breaking change which makes code smaller or more readable)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Library ABI change (libzfs, libzfs_core, libnvpair, libuutil and libzfsbootenv)
  • Documentation (a change to man pages or other documentation)

Checklist:

@robn
cmd: add 'help' subcommand to zpool and zfs
e566cbe 
'program help subcommand' is a reasonably common pattern for
multifunction command-line programs. This commit adds support for that
style to the zpool and zfs commands.

When run as 'zpool help [<topic>]' or 'zfs help [<topic>]', executes the
'man' program on the PATH with the most likely manpage name for the
requested topic: "zpool-<topic>" or "zfs-<topic>" for subcommands, or
"zpool<topic>" or "zfs<topic>" for the "concepts" and "props" topics.
If no topic is supplied, uses the top "zpool" or "zfs" pages.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Kay Pedersen <mail@mkwg.de>
Signed-off-by: Rob Norris <robn@despairlabs.com>
Closes openzfs#15288
@robn robn changed the title cmd: add 'help' subcommand to zpool and zfs [2.2] cmd: add 'help' subcommand to zpool and zfs Oct 3, 2023
oromenahar
oromenahar approved these changes Oct 3, 2023
View reviewed changes
Copy link
Contributor

@oromenahar oromenahar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the work!

@behlendorf
Copy link
Contributor

Thanks for the PR but this has already been pulled in to the 2.2-relase branch as 3af6368.

@behlendorf behlendorf closed this Oct 3, 2023
@robn
Copy link
Member Author

robn commented Oct 3, 2023

Wow, so it has! That's my mistake (obviously); something weird up with my local repo and it hasn't been updating zfs-2.2-release, so I didn't see it. I'll go ask my nearby git boffin what's up with that. Cheers :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oromenahar oromenahar oromenahar approved these changes

@usaleem-ix usaleem-ix usaleem-ix approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@robn @behlendorf @oromenahar @usaleem-ix