Skip to content

zfs-rollback.8: fix typo in example number #17282

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
Merged
merged 1 commit into from
Apr 28, 2025
Merged

zfs-rollback.8: fix typo in example number #17282

merged 1 commit into from
Apr 28, 2025

Conversation

Defenso-QTH
Copy link
Contributor

Close #17281

@Defenso-QTH
zfs-rollback.8: fix typo in example number
773de54 
Signed-off-by: Quentin Thébault <quentin.thebault@defenso.fr>
robn
robn approved these changes Apr 28, 2025
View reviewed changes
Copy link
Member

@robn robn left a comment

Choose a reason for hiding this comment

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

Huh, what a weird little cross-referencing mess. Still, this matches some of the others, by starting at 1 within their pages. So good find, and good change, thank you :)

concussious
concussious reviewed Apr 28, 2025
View reviewed changes
Copy link
Contributor

@concussious concussious left a comment

Choose a reason for hiding this comment

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

It looks like this Works As Intended based on the roff comment I highlighted below.

@Defenso-QTH
Copy link
Contributor Author

Sorry it seems I went too fast with this one. Thanks @concussious for spotting it.

@robn
Copy link
Member

robn commented Apr 28, 2025

No, I think you were right. To take another example, zfs(8) says:

.Sh EXAMPLES
...
.\" Examples 2, 3, 10, 15 are also shared with zfs-snapshot.8.

and then in zfs-snapshot(8):

.Sh EXAMPLES
.\" These are, respectively, examples 2, 3, 10, 15 from zfs.8
.\" Make sure to update them bidirectionally
.Ss Example 1 : No Creating a ZFS Snapshot
...
.Ss Example 2 : No Creating and Destroying Multiple Snapshots
...
.Ss Example 3 : No Promoting a ZFS Clone
...
.Ss Example 4 : No Performing a Rolling Snapshot

I just assumed you were adjusting zfs-rollback(8) to be consistent?

@Defenso-QTH
Copy link
Contributor Author

Actually I had checked zfs-list, which also starts at 1, although it is referenced as 5 in zfs.8.

Which scheme is the desired one, then?

@Defenso-QTH Defenso-QTH reopened this Apr 28, 2025
@robn robn mentioned this pull request Apr 28, 2025
Closed
@robn
Copy link
Member

robn commented Apr 28, 2025

I haven't read them all, but most seem to be numbered 1,2,3,... in the sub-program pages, so I'd stick with that.

concussious
concussious approved these changes Apr 28, 2025
View reviewed changes
Copy link
Contributor

@concussious concussious left a comment

Choose a reason for hiding this comment

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

Ah, good thing I was wrong! Sorry for the confusion.

@amotin amotin added the Status: Accepted Ready to integrate (reviewed, tested) label Apr 28, 2025
@amotin amotin merged commit 63de2d2 into openzfs:master Apr 28, 2025
32 of 33 checks passed
@Defenso-QTH Defenso-QTH deleted the patch-1 branch April 29, 2025 03:57
snajpa pushed a commit to vpsfreecz/zfs that referenced this pull request May 2, 2025
@Defenso-QTH @snajpa
zfs-rollback.8: fix typo in example number
5dc5876 
Reviewed-by: George Melikov <mail@gmelikov.ru>
Reviewed-by: Alexander Motin <mav@FreeBSD.org>
Reviewed-by: Alexander Ziaee <ziaee@FreeBSD.org>
Reviewed-by: Rob Norris <robn@despairlabs.com>
Signed-off-by: Quentin Thébault <quentin.thebault@defenso.fr>
Closes openzfs#17282
robn pushed a commit to robn/zfs that referenced this pull request May 23, 2025
@Defenso-QTH @robn
zfs-rollback.8: fix typo in example number
1a8cabf 
Reviewed-by: George Melikov <mail@gmelikov.ru>
Reviewed-by: Alexander Motin <mav@FreeBSD.org>
Reviewed-by: Alexander Ziaee <ziaee@FreeBSD.org>
Reviewed-by: Rob Norris <robn@despairlabs.com>
Signed-off-by: Quentin Thébault <quentin.thebault@defenso.fr>
Closes openzfs#17282
(cherry picked from commit 63de2d2)
@robn robn mentioned this pull request May 23, 2025
Closed
14 tasks
robn pushed a commit to robn/zfs that referenced this pull request May 24, 2025
@Defenso-QTH @robn
zfs-rollback.8: fix typo in example number
8bc5f1d 
Reviewed-by: George Melikov <mail@gmelikov.ru>
Reviewed-by: Alexander Motin <mav@FreeBSD.org>
Reviewed-by: Alexander Ziaee <ziaee@FreeBSD.org>
Reviewed-by: Rob Norris <robn@despairlabs.com>
Signed-off-by: Quentin Thébault <quentin.thebault@defenso.fr>
Closes openzfs#17282
(cherry picked from commit 63de2d2)
tonyhutter pushed a commit that referenced this pull request May 28, 2025
@Defenso-QTH @tonyhutter
zfs-rollback.8: fix typo in example number
4f34e8d 
Reviewed-by: George Melikov <mail@gmelikov.ru>
Reviewed-by: Alexander Motin <mav@FreeBSD.org>
Reviewed-by: Alexander Ziaee <ziaee@FreeBSD.org>
Reviewed-by: Rob Norris <robn@despairlabs.com>
Signed-off-by: Quentin Thébault <quentin.thebault@defenso.fr>
Closes #17282
(cherry picked from commit 63de2d2)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@robn robn robn approved these changes

@gmelikov gmelikov gmelikov approved these changes

@amotin amotin amotin approved these changes

@concussious concussious concussious 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.

zfs-list.8: Typo in example number
5 participants
@Defenso-QTH @robn @gmelikov @amotin @concussious