Page MenuHomeFreeBSD

Updating glabel.8 man page
ClosedPublic

Authored by freebsd_ny-central.org on Mar 16 2024, 8:04 PM.
Referenced Files
F85970747: D44394.id138857.diff
Thu, Jun 13, 11:48 AM
Unknown Object (File)
Fri, Jun 7, 6:13 AM
Unknown Object (File)
Thu, Jun 6, 5:58 PM
Unknown Object (File)
Thu, Jun 6, 2:29 PM
Unknown Object (File)
Thu, Jun 6, 6:20 AM
Unknown Object (File)
Wed, May 22, 9:06 PM
Unknown Object (File)
Tue, May 21, 6:58 PM
Unknown Object (File)
Tue, May 21, 3:29 PM

Details

Summary

PR 276724 indicates that the current glabel man page does not describe the corner case of attempting to set a label on an already mounted partition.

  • Added a paragraph indicating that glabel requires an exclusive lock on the partition
  • Added that any file system first needs to be unmounted for the label to persist across reboot
  • Added that if the affected device node is root, that single user mode with r/o mount will be required

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

lib/geom/label/glabel.8
179
180

There's trailing whitespace at the end of the line after file system.

181

Thanks for the reminder and for the feedback. I've fixed the trailing whitespace now.

freebsd_ny-central.org marked an inline comment as done.

Aaand I missed the other two changes. Now added those as well.

gbe added a subscriber: gbe.

LGTM from manpages

This revision is now accepted and ready to land.May 12 2024, 8:34 AM
gbe requested changes to this revision.May 12 2024, 8:37 AM

The comments are marked as done but the differential itself doesn't contain them. For example the typo s/hols/holds/.

If they are included I would commit.

This revision now requires changes to proceed.May 12 2024, 8:37 AM

Well, that's embarrassing. Looks like I uploaded the wrong diff. Thanks for your diligence and your feedback!

concussious.bugzilla_runbox.com added inline comments.
lib/geom/label/glabel.8
178

Also, new sentance new line. After that , LGTM

This revision now requires changes to proceed.Fri, May 17, 2:05 AM

Thanks for the feedback and pointing out the line breaks; I have now

  • fixed line breaks also for other occurrences where new sentences were started but line breaks were missing
  • I linted the man page and fixed/replaced a self-referencing Xr with an Nm instead

We're almost there, but the patch now fails to apply after 1a720cbec513210fa2e85c3882741ef2f6dc5f35. @freebsd_ny-central.org, could you rebase your changes on top of the latest from main?

Rebased to 3cc1b35bc1bdcdee279b3ee7d0e0946b684df898.

And learned a new thing - man pages get moved around between the sections and I really need to look out for that. Almost broke the fix for main branch...
Appreciate the support. Thanks!

It is not typical to move manpages around, and that was actually my fault, sorry.

Commit message improvements, based on template.

Hi Chris,

Did the commit log update make it here? I don't see it. Does the one shared via email (repeated below) look good to you? Do you have any corrections?

glabel.8: Describe cases related to permissions / existing mounts

Specially, note some requirements for label changes:

- glabel requires write permission on device
- filesystems first need to be unmounted for new labels to persist
  across reboots
- if the affected device node holds the filesystem root, single-user
  mode with r/o mount will be required.

Also, while here, apply some formatting tweaks.

PR:		276724
Reviewed by:	gbe, jrm, Alexander Ziaee <concussious@runbox.com>
Differential Revision:	https://reviews.freebsd.org/D44394

Must have done something wrong. I'll figure it out eventually. Plan to get arcanist going asap. Generally looks good! Thanks!

I had the original reporter added, don't want to nitpick though...

glabel.8: Describe cases related to permissions / existing mounts

Specially, note some requirements for label changes:

- glabel requires write permission on device
- filesystems first need to be unmounted for new labels to persist
  across reboots
- if the affected device node holds the filesystem root, single-user
  mode with r/o mount will be required.

Also, while here, apply some formatting tweaks.

PR:		276724
Reported by:    Alex Matei <matei35@yahoo.com>
Reviewed by:	gbe, jrm, Alexander Ziaee <concussious@runbox.com>
Differential Revision:	https://reviews.freebsd.org/D44394
This revision was not accepted when it landed; it landed in state Needs Review.Tue, May 21, 6:51 PM
This revision was automatically updated to reflect the committed changes.

Included the important Reported by in the commit. Thanks.