add the Xr's to the SEE ALSO as well #10589

jmgurney · 2020-07-17T19:49:39Z

Motivation and Context

There are a TON of zfs-* man pages. This adds them to the SEE ALSO section so that people can more quickly look through what all the options are, now that the page has been split.

Description

It adds ALL the zfs-* pages that are Xr'd to the SEE ALSO section so that you can quickly go to the end of the page, and see ALL the option instead of having to page through all the short descriptions.

How Has This Been Tested?

man ./zfs.8

examine output.

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)
Documentation (a change to man pages or other documentation)

Checklist:

My code follows the ZFS on Linux code style requirements.
I have updated the documentation accordingly.
I have read the contributing document.
I have added tests to cover my changes.
I have run the ZFS Test Suite with this change applied.
All commit messages are properly formatted and contain Signed-off-by.

allanjude

Reviewed By: allanjude@freebsd.org

ghost

Awesome, thanks!

codecov · 2020-07-18T03:11:41Z

Codecov Report

Merging #10589 into master will decrease coverage by 0.16%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #10589      +/-   ##
==========================================
- Coverage   79.75%   79.59%   -0.17%     
==========================================
  Files         395      395              
  Lines      125066   125066              
==========================================
- Hits        99743    99542     -201     
- Misses      25323    25524     +201

Flag	Coverage Δ
#kernel	`80.32% <ø> (-0.06%)`	⬇️
#user	`64.83% <ø> (-1.17%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
module/zfs/vdev_indirect.c	`73.37% <0.00%> (-11.65%)`	⬇️
module/os/linux/spl/spl-kmem-cache.c	`78.44% <0.00%> (-11.43%)`	⬇️
module/zfs/bpobj.c	`86.86% <0.00%> (-4.29%)`	⬇️
module/zfs/vdev_raidz.c	`89.11% <0.00%> (-4.25%)`	⬇️
module/zfs/dsl_scan.c	`83.19% <0.00%> (-2.81%)`	⬇️
module/zfs/vdev_removal.c	`93.94% <0.00%> (-2.75%)`	⬇️
module/zfs/vdev_indirect_mapping.c	`96.61% <0.00%> (-1.94%)`	⬇️
module/zfs/metaslab.c	`94.12% <0.00%> (-1.58%)`	⬇️
lib/libzfs/libzfs_changelist.c	`84.26% <0.00%> (-0.75%)`	⬇️
module/zfs/zfs_quota.c	`86.36% <0.00%> (-0.46%)`	⬇️
... and 50 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ad52de7...75787d8. Read the comment docs.

behlendorf

@jmgurney thanks. Would you just mind force updating to the PR and add your signed-off-by to the git commit message. Then we can get this merged.

rlaager · 2020-08-01T18:17:59Z

This is great! Any chance you could add the same cross-references for the zpool-* man pages in zpool.8?

behlendorf · 2020-08-24T04:27:39Z

@jmgurney it would be great if you could address the review feedback so we can merge this.

jmgurney · 2020-08-26T18:47:45Z

@jmgurney thanks. Would you just mind force updating to the PR and add your signed-off-by to the git commit message. Then we can get this merged.

I'm not sure the best/most correct way to add the signed-off-by line. should I just amend the commit and do a force push? or? The linked documentation does not contain this information.

rlaager · 2020-08-26T18:57:17Z

Yes, amend the commit and force push.

Signed-off-by: John-Mark Gurney <jmg@funkthat.com>

jmgurney · 2020-08-26T19:20:01Z

Ok, I think this completes the signed-off adding. I'll look at the zpool now...

Signed-off-by: John-Mark Gurney <jmg@funkthat.com>

jmgurney · 2020-08-26T19:34:26Z

ok, zpool has been updated, and also properly sorted by section and then alphabetically..

There are a ton of zfs-* and zpool-* man pages. This adds them to the SEE ALSO section so that people can more quickly look through what all the options are, now that the pages have been split. Reviewed-by: Richard Laager <rlaager@wiktel.com> Reviewed-by: Ryan Moeller <ryan@iXsystems.com> Reviewed-by: George Melikov <mail@gmelikov.ru> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Reviewed-by: Allan Jude <allan@klarasystems.com> Signed-off-by: John-Mark Gurney <jmg@funkthat.com> Closes #10589

There are a ton of zfs-* and zpool-* man pages. This adds them to the SEE ALSO section so that people can more quickly look through what all the options are, now that the pages have been split. Reviewed-by: Richard Laager <rlaager@wiktel.com> Reviewed-by: Ryan Moeller <ryan@iXsystems.com> Reviewed-by: George Melikov <mail@gmelikov.ru> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Reviewed-by: Allan Jude <allan@klarasystems.com> Signed-off-by: John-Mark Gurney <jmg@funkthat.com> Closes openzfs#10589

allanjude approved these changes Jul 17, 2020

View reviewed changes

ghost approved these changes Jul 17, 2020

View reviewed changes

ghost added Status: Code Review Needed Ready for review and testing Type: Documentation Indicates a requested change to the documentation labels Jul 17, 2020

behlendorf approved these changes Jul 19, 2020

View reviewed changes

gmelikov approved these changes Jul 20, 2020

View reviewed changes

behlendorf added Status: Revision Needed Changes are required for the PR to be accepted and removed Status: Code Review Needed Ready for review and testing labels Jul 22, 2020

add the Xr's to the SEE ALSO as well

dde1c21

Signed-off-by: John-Mark Gurney <jmg@funkthat.com>

jmgurney force-pushed the zfs-seealso branch from c2e3f00 to dde1c21 Compare August 26, 2020 19:17

ghost added Status: Accepted Ready to integrate (reviewed, tested) and removed Status: Revision Needed Changes are required for the PR to be accepted labels Aug 26, 2020

add zpool .Xr's and sort by section then alphabetically

75787d8

Signed-off-by: John-Mark Gurney <jmg@funkthat.com>

ghost approved these changes Aug 26, 2020

View reviewed changes

behlendorf approved these changes Aug 26, 2020

View reviewed changes

behlendorf merged commit 770269e into openzfs:master Aug 27, 2020

behlendorf added this to Backport for OpenZFS 2.0 in OpenZFS 2.0 Aug 27, 2020

behlendorf moved this from Backport for OpenZFS 2.0 to New OpenZFS 2.0 Features (0.8->2.0) in OpenZFS 2.0 Aug 28, 2020

behlendorf moved this from New OpenZFS 2.0 Features (0.8->2.0) to Done in OpenZFS 2.0 Aug 30, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add the Xr's to the SEE ALSO as well #10589

add the Xr's to the SEE ALSO as well #10589

jmgurney commented Jul 17, 2020 •

edited by rlaager

allanjude left a comment

ghost left a comment

codecov bot commented Jul 18, 2020 •

edited

behlendorf left a comment •

edited

rlaager commented Aug 1, 2020

behlendorf commented Aug 24, 2020

jmgurney commented Aug 26, 2020

rlaager commented Aug 26, 2020

jmgurney commented Aug 26, 2020

jmgurney commented Aug 26, 2020

add the Xr's to the SEE ALSO as well #10589

add the Xr's to the SEE ALSO as well #10589

Conversation

jmgurney commented Jul 17, 2020 • edited by rlaager

Motivation and Context

Description

How Has This Been Tested?

Types of changes

Checklist:

allanjude left a comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

codecov bot commented Jul 18, 2020 • edited

Codecov Report

behlendorf left a comment • edited

Choose a reason for hiding this comment

rlaager commented Aug 1, 2020

behlendorf commented Aug 24, 2020

jmgurney commented Aug 26, 2020

rlaager commented Aug 26, 2020

jmgurney commented Aug 26, 2020

jmgurney commented Aug 26, 2020

jmgurney commented Jul 17, 2020 •

edited by rlaager

codecov bot commented Jul 18, 2020 •

edited

behlendorf left a comment •

edited