Page MenuHomeFreeBSD
Differential D48872

callbootd: Add man page, update Makefile to install man page, and update usage().
Needs ReviewPublic
Actions

Authored by felix.the.red_gmail.com on Feb 6 2025, 9:03 PM.
Tags
None
Referenced Files
F126655309: D48872.id150651.diff
Fri, Aug 22, 4:51 AM
Unknown Object (File)
Fri, Aug 15, 7:34 AM
Unknown Object (File)
Sat, Aug 9, 3:31 PM
Unknown Object (File)
Fri, Aug 8, 12:43 PM
Unknown Object (File)
Sun, Aug 3, 1:22 PM
Unknown Object (File)
Wed, Jul 30, 6:56 PM
Unknown Object (File)
Wed, Jul 30, 1:22 AM
Unknown Object (File)
Mon, Jul 28, 5:59 PM
View All 61 Files
Subscribers
gbe
imp
maxim
ziaee

Details

Reviewers
bdrewery
ngie
sjg
nyan
ziaee
Group Reviewers
manpages
Summary

Create man page for callbootd.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

felix.the.red_gmail.com created this revision.Feb 6 2025, 9:03 PM
Herald added a subscriber: imp. · View Herald TranscriptFeb 6 2025, 9:03 PM
felix.the.red_gmail.com requested review of this revision.Feb 6 2025, 9:03 PM
Harbormaster completed remote builds in B62284: Diff 150651.Feb 6 2025, 9:04 PM
maxim added a subscriber: maxim.Feb 6 2025, 9:21 PM
maxim added inline comments.
usr.sbin/bootparamd/callbootd/callbootd.8
24

You probably want to Xr bootparamd.8 here.

53

Missed comma

ziaee added reviewers: bdrewery, manpages, ngie, sjg, nyan.Feb 7 2025, 12:55 AM
ziaee added a subscriber: ziaee.

It's been quite a long time, but adding reviewers who have worked on this codebase.

sjg added a comment.Feb 7 2025, 8:52 PM

Looks ok - fix the items noted by maxim

gbe added a subscriber: gbe.Feb 8 2025, 4:12 AM
gbe added inline comments.
usr.sbin/bootparamd/callbootd/callbootd.8
2

Please add a SPDX Header and a copyright notice.

56

This should something like

The ABC command / utility was written by
$NAME_OF_SRC_AUTHOR .
This manage was written by...

felix.the.red_gmail.com updated this revision to Diff 150829.Feb 11 2025, 3:20 AM

Add SPDX header and BSD Documentation License.

Harbormaster completed remote builds in B62367: Diff 150829.Feb 11 2025, 3:20 AM
felix.the.red_gmail.com added a comment.Feb 11 2025, 3:22 AM

Updated to include recommendations. Please review.

maxim added a comment.Feb 11 2025, 3:41 AM

LGTM

ziaee added inline comments.Feb 11 2025, 12:44 PM
usr.sbin/bootparamd/callbootd/callbootd.8
39

I don't understand the comment. It shows a different usage than is displayed in this section? I'm not familiar with the program to know which is correct.

58

style.mdoc(5) says the width should be the longest item, unless that hurts readability then it should be indent. I like to check mine at MANWIDTH=80 and MANWIDTH=59

76

Ql is quoted literal, so you don't need to quote it's arguments

ngie added inline comments.Feb 11 2025, 7:41 PM
usr.sbin/bootparamd/callbootd/callbootd.c
151–154

This is backwards: this should all be hard-tab indented per style(9).

ziaee requested changes to this revision.Apr 17 2025, 5:18 PM
ziaee added inline comments.
usr.sbin/bootparamd/callbootd/callbootd.8
2

The entire license for new manuals should look like this:

/*
 * Copyright (c) [year] [your name]
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */
This revision now requires changes to proceed.Apr 17 2025, 5:18 PM
felix.the.red_gmail.com updated this revision to Diff 157496.Jun 24 2025, 3:33 AM

I updated the license.
After re-reading the source for callbootd, I learned I was mistaken about broadcast mode.
I updated the usage function and simplified the manpage.

imp added inline comments.Jun 24 2025, 5:03 AM
usr.sbin/bootparamd/callbootd/callbootd.8
2

Also, don't put name and uear inside square [] brackets.

maxim added a comment.Jun 24 2025, 8:12 AM

There are several EoL whitespaces. Please trim them before committing.

Also, it makes sense to wrap long lines.

Sorry for nitpicking.

felix.the.red_gmail.com updated this revision to Diff 157538.Jun 24 2025, 7:31 PM

Remove EOL whitespace, break up long lines, remove brackets around author and year.

maxim added a comment.Jun 24 2025, 8:15 PM

The final diff (copy&pasted)

  • callbootd.8.orig 2025-06-24 20:10:46.860839000 +0000

+++ callbootd.8 2025-06-24 20:15:11.645894000 +0000
@@ -1,8 +1,8 @@
-.\"/*

  • .\"* Copyright (c) 2025 Felix Johnson
  • .\"*
  • .\"* SPDX-License-Identifier: BSD-2-Clause
  • .\"*/

+.\"
+.\" Copyright (c) 2025 Felix Johnson
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
.Dd June 23, 2025
.Dt CALLBOOTD 8
.Os
@@ -89,7 +89,7 @@
was written by
.An Klas Heggemann Aq Mt klas@nada.kth.se .
.Pp
-This manpage was written by Felix Johnson
+This manual page was written by Felix Johnson
.Aq Mt felix.the.red@gmail.com .
.Sh BUGS
.Nm

felix.the.red_gmail.com updated this revision to Diff 157542.Jun 24 2025, 9:03 PM

Updated copyright to remove extra characters, changed "manpage" to "manual page".

maxim added a comment.Jun 25 2025, 8:41 AM

It looks good.

ziaee added inline comments.Jun 25 2025, 11:14 AM
usr.sbin/bootparamd/callbootd/callbootd.8
12

Nds don't get capitalized

17

Is file_id a type of argument?

felix.the.red_gmail.com added inline comments.Jun 25 2025, 8:23 PM
usr.sbin/bootparamd/callbootd/callbootd.8
17

Yes, and it's optional.

If file_id is not present, then callbootd will be in whoami mode, asking for
the client's hostname, domain, and router.

Otherwise, callbootd asks for mount paths, using file_id as a key.
The boot server maintains a list of key:value pairs for each client in /etc/bootparams.
The file_id argument is typically a short string like root, swap, data, etc.
The value is a server:/path pair for the client to use to mount the corresponding filesystem via NFS.

Revision Contents
Changeset List

PathSize
usr.sbin/
bootparamd/
callbootd/
96 lines
3 lines

Diff 157542

View Options

usr.sbin/bootparamd/callbootd/callbootd.8

Loading...
View Options

usr.sbin/bootparamd/callbootd/callbootd.c

Loading...