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

Update to man pages for zpool-iostat, zpool-list, zpool-status and zpool-wait to resolve time(2) -> time(1) #15823

Merged
merged 1 commit into from
Jan 29, 2024
Merged

Update to man pages for zpool-iostat, zpool-list, zpool-status and zpool-wait to resolve time(2) -> time(1) #15823

merged 1 commit into from
Jan 29, 2024

Conversation

chrisdavidson
Copy link
Contributor

zpool-iostat.8: Updated time(2) -> time(1) to align to manual page
zpool-list.8: Updated time(2) -> time(1) to align to manual page
zpool-status.8: Updated time(2) -> time(1) to align to manual page
zpool-wait.8: Update time(2) -> time(1) to align to manual page

Signed-off-by: Christopher Davidson christopher.davidson@gmail.com

Motivation and Context

This change was applied to the manual pages to resolve misaligned .Xr references in the manual pages as they were in FreeBSD-CURRENT.

Description

The manual pages were confirmed to be aligned to time(2) and double checked with a few spots checks:

  1. main time -> which resulted in time(1) and not time(2) showing
  2. https://man.freebsd.org/cgi/man.cgi?query=time&apropos=0&sektion=0&manpath=FreeBSD+15.0-CURRENT&arch=default&format=html -> to confirm the manual page on machine matched what was expected on website with man output.

How Has This Been Tested?

The testing conducted was spot check with the above items and checking multiple releases of FreeBSD: FreeBSD 14.0 (amd64) FreeBSD(arm - raspberry pi) FreeBSD-CURRENT (amd64) and all confirmed same result.

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

Checklist:

  • My code follows the OpenZFS code style requirements.
  • [ X] I have updated the documentation accordingly.
  • [ X] 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.

behlendorf
behlendorf approved these changes Jan 26, 2024
View reviewed changes
Copy link
Contributor

@behlendorf behlendorf left a comment

Choose a reason for hiding this comment

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

The change itself looks fine can you just resolve the two style warnings and force update the PR.

https://github.com/openzfs/zfs/actions/runs/7661248838/job/20880232317?pr=15823

error: commit subject over 72 characters
error: missing "Signed-off-by"

@behlendorf behlendorf added the Status: Code Review Needed Ready for review and testing label Jan 26, 2024
@chrisdavidson chrisdavidson changed the title Update to manual pages for zpool-iostat, zpool-list, zpool-status and zpool-wait to resolve time(2) -> time(1) Update to man pages for zpool-iostat, zpool-list, zpool-status and zpool-wait to resolve time(2) -> time(1) Jan 27, 2024
@chrisdavidson
Summary: Update man pages to time(1) from time(2)
7a03db3 
zpool-iostat.8: Updated time(2) -> time(1) to align to manual page
zpool-list.8: Updated time(2) -> time(1) to align to manual page
zpool-status.8: Updated time(2) -> time(1) to align to manual page
zpool-wait.8: Update time(2) -> time(1) to align to manual page

Signed-off-by: Christopher Davidson <christopher.davidson@gmail.com>
@chrisdavidson
Copy link
Contributor Author

The change itself looks fine can you just resolve the two style warnings and force update the PR.

https://github.com/openzfs/zfs/actions/runs/7661248838/job/20880232317?pr=15823

error: commit subject over 72 characters error: missing "Signed-off-by"

Thank you for the review comments and recommendations.

Both of these should be resolved now and captured in the subsequent commit associated with this PR.

@behlendorf behlendorf added Status: Accepted Ready to integrate (reviewed, tested) and removed Status: Code Review Needed Ready for review and testing labels Jan 29, 2024
@behlendorf behlendorf merged commit c3fd7a5 into openzfs:master Jan 29, 2024
22 of 25 checks passed
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jan 29, 2024
@chrisdavidson @behlendorf
Update man pages to time(1) from time(2)
7fd53ea 
zpool-iostat.8: Updated time(2) -> time(1) to align to manual page
zpool-list.8: Updated time(2) -> time(1) to align to manual page
zpool-status.8: Updated time(2) -> time(1) to align to manual page
zpool-wait.8: Update time(2) -> time(1) to align to manual page

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Christopher Davidson <christopher.davidson@gmail.com>
Closes openzfs#15823
behlendorf pushed a commit that referenced this pull request Jan 29, 2024
@chrisdavidson @behlendorf
Update man pages to time(1) from time(2)
acc7cd8 
zpool-iostat.8: Updated time(2) -> time(1) to align to manual page
zpool-list.8: Updated time(2) -> time(1) to align to manual page
zpool-status.8: Updated time(2) -> time(1) to align to manual page
zpool-wait.8: Update time(2) -> time(1) to align to manual page

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Christopher Davidson <christopher.davidson@gmail.com>
Closes #15823
lundman pushed a commit to openzfsonwindows/openzfs that referenced this pull request Mar 13, 2024
@chrisdavidson @lundman
Update man pages to time(1) from time(2)
d2d9665 
zpool-iostat.8: Updated time(2) -> time(1) to align to manual page
zpool-list.8: Updated time(2) -> time(1) to align to manual page
zpool-status.8: Updated time(2) -> time(1) to align to manual page
zpool-wait.8: Update time(2) -> time(1) to align to manual page

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Christopher Davidson <christopher.davidson@gmail.com>
Closes openzfs#15823
lundman pushed a commit to openzfsonwindows/openzfs that referenced this pull request Mar 13, 2024
@chrisdavidson @lundman
Update man pages to time(1) from time(2)
2097906 
zpool-iostat.8: Updated time(2) -> time(1) to align to manual page
zpool-list.8: Updated time(2) -> time(1) to align to manual page
zpool-status.8: Updated time(2) -> time(1) to align to manual page
zpool-wait.8: Update time(2) -> time(1) to align to manual page

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Christopher Davidson <christopher.davidson@gmail.com>
Closes openzfs#15823
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@behlendorf behlendorf behlendorf approved these changes

Assignees
No one assigned
Labels
Status: Accepted Ready to integrate (reviewed, tested)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@chrisdavidson @behlendorf