Bug 276099 - freebsd-update: manpage does not mention '-v' option and its aliases
Summary: freebsd-update: manpage does not mention '-v' option and its aliases
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Alexander Ziaee
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-01-03 15:13 UTC by Michael Osipov
Modified: 2026-04-10 18:32 UTC (History)
7 users (show)

See Also:

Attachments
Patch to document -v option in freebsd-update.8 (695 bytes, patch)
2026-03-08 06:58 UTC, Paarth Shirsat 		paarthshirsat123: maintainer-approval?
Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Michael Osipov freebsd_committer freebsd_triage 2024-01-03 15:13:18 UTC 
Note: This issue also applies to all other stable branches.

freebsd-update supports verbose output:
https://github.com/freebsd/freebsd-src/blob/8b144c015c9cce0bc99a7fbdc43f22f51a946d2c/usr.sbin/freebsd-update/freebsd-update.sh#L527-L538, but the manpage does not mention it at all. In some situations you might want to analyze an issue with verbose output.
Comment 1 Paarth Shirsat 2026-03-08 06:58:09 UTC 
Created attachment 268621 [details]
Patch to document -v option in freebsd-update.8

The documentation of -v and its behavior was missing from the OPTIONS section in the man page. This patch adds documentation for all the accepted values i.e., stats, nostats, debug, implemented in freebsd-update.sh. The entry is placed consistent with alphabetical ordering of short flags before long flags.

Tested with mandoc to ensure correct rendering.
Comment 2 Michael Osipov freebsd_committer freebsd_triage 2026-03-08 15:49:05 UTC 
ziaee, do you want to take over? This is an easy fix.
Comment 3 Alexander Ziaee freebsd_committer freebsd_triage 2026-03-09 13:54:13 UTC 
Thanks guys!
Comment 4 commit-hook freebsd_committer freebsd_triage 2026-03-09 13:56:09 UTC 
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=02fd9fa2952705ea0ed142061dd86aad7e01f8db

commit 02fd9fa2952705ea0ed142061dd86aad7e01f8db
Author:     Paarth Shirsat <paarthshirsat123@gmail.com>
AuthorDate: 2026-03-09 13:49:51 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-03-09 13:54:23 +0000

    freebsd-update: Document -v verbosity flag

    PR:             276099
    MFC after:      3 days
    Reported by:    michaelo
    Co-authored-by: Alexander Ziaee <ziaee@FreeBSD.org>

 usr.sbin/freebsd-update/freebsd-update.8  | 13 ++++++++++++-
 usr.sbin/freebsd-update/freebsd-update.sh |  1 +
 2 files changed, 13 insertions(+), 1 deletion(-)
Comment 5 commit-hook freebsd_committer freebsd_triage 2026-04-10 18:32:23 UTC 
A commit in branch stable/15 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=d7bda1a9963717f98bcccc95c2b188a8753a16f6

commit d7bda1a9963717f98bcccc95c2b188a8753a16f6
Author:     Paarth Shirsat <paarthshirsat123@gmail.com>
AuthorDate: 2026-03-09 13:49:51 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-04-10 18:29:15 +0000

    freebsd-update: Document -v verbosity flag

    PR:             276099
    MFC after:      3 days
    Reported by:    michaelo
    Co-authored-by: Alexander Ziaee <ziaee@FreeBSD.org>

    (cherry picked from commit 02fd9fa2952705ea0ed142061dd86aad7e01f8db)

 usr.sbin/freebsd-update/freebsd-update.8  | 13 ++++++++++++-
 usr.sbin/freebsd-update/freebsd-update.sh |  1 +
 2 files changed, 13 insertions(+), 1 deletion(-)