Page MenuHomeFreeBSD

Update glabel(8) to clarify filesystem volume labels, device metadata identifiers, and generic GEOM labels.
ClosedPublic

Authored by bcr on Jun 25 2025, 2:11 AM.
Tags
None
Referenced Files
F174179493: D51030.diff
Thu, Oct 1, 4:34 AM
Unknown Object (File)
Wed, Sep 30, 3:32 AM
Unknown Object (File)
Thu, Sep 24, 2:14 AM
Unknown Object (File)
Wed, Sep 23, 11:19 PM
Unknown Object (File)
Wed, Sep 23, 5:25 PM
Unknown Object (File)
Wed, Sep 23, 2:46 AM
Unknown Object (File)
Tue, Sep 22, 11:29 PM
Unknown Object (File)
Tue, Sep 22, 11:08 PM
Subscribers

Details

Summary
  • Change description of manual page
  • Split out filesystem, GPT and GEOM labels.
  • Give an example for each filesystem of the program to use to set a label.
  • Clarify examples.

To summarize the original PR:

  • "Labelization" is not a real word. Please change the description of the manual page.
  • glabel(8) is confusing and doesn't distinguish between filesystem labels and GEOM labels.
  • The example doesn't appear to show glabel in action.

PR:262207

Test Plan

Check formatting
mandoc -Tascii lib/geom/label/glabel.8

Check for linter errors:
mandoc -Tlint lib/geom/label/glabel.8

Diff Detail

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

Event Timeline

felix.the.red_gmail.com edited the summary of this revision. (Show Details)
felix.the.red_gmail.com edited the test plan for this revision. (Show Details)

Remove empty Em.
Remove end-of-line space.

Can you update the patch to use ada instead of ad, which is the more canonical naming used these days?

bcr added a reviewer: felix.the.red_gmail.com.

I'm taking over due to feedback timeout.

Update patch which includes comments and corrections.

I think when this is ready we should consider asking Pawel to review it.

lib/geom/label/glabel.8
30

Nd does not need to be quoted, and is not shown quoted in any style guides.

98

I feel like these paragraphs are out of order somehow, maybe they need subsections also, but please give me a moment to reflect on this.

107–120

We should make this a little clearer about what the table is doing. What does it mean a suitable entry will be created as shown below? The table below says we need to use something else?

110–120

Editorial and mechanical tweaks, but it doesn't make sense to me why /dev/diskid/ and /dev/label/ are not in the table?

293

I kind of hate this. We give them a noun and then in parenthesis three other nouns. We should pick one. Whole entire rest of industry calls these FAT filesystems. By tradition we call them MS-DOS filesystems. Either is clear and concise and fine with me, but trying to define every possible thing in an example is sometime I really try to get people to not do.

This revision was not accepted when it landed; it landed in state Needs Review.Sun, Sep 13, 9:10 AM
This revision was automatically updated to reflect the committed changes.