Bug 246697 - bectl.c: sync help text to man page
Summary: bectl.c: sync help text to man page
Status: Open
Alias: None
Product: Base System
Classification: Unclassified
Component: bin (show other bugs)
Version: CURRENT
Hardware: Any Any
: --- Affects Only Me
Assignee: freebsd-bugs (Nobody)
URL:
Keywords: patch
Depends on:
Blocks:
 
Reported: 2020-05-24 14:15 UTC by Jimmy Olgeni
Modified: 2021-01-06 19:42 UTC (History)
3 users (show)

See Also:


Attachments
bectl help text fixes (1.12 KB, patch)
2020-05-24 14:15 UTC, Jimmy Olgeni
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Jimmy Olgeni freebsd_committer 2020-05-24 14:15:45 UTC
Created attachment 214812 [details]
bectl help text fixes

Sync the bectl help text with the man page synopsis.

Notably, the "-o" option of "bectl destroy" was missing.
Comment 1 Kyle Evans freebsd_committer 2020-05-30 19:54:32 UTC
Mostly LGTM -- there's one change that I don't think I agree with, but it's wrong in the manpage too (which is the version you changed it to):

> bectl jail [-bU] [{-o key=value | -u key}]...

-b and -U are mutually exclusive options, as they were represented before. We should also fix the manpage to reflect that (I can follow up with this) and perhaps make `bectl jail` actually error out. The problem is that the options are philosophically at odds with each other; one is specifically meant to keep the jail around and not do anything interactive with it because the caller will operate on it, while the other implies that the jail+mount should be torn down before bectl returns.
Comment 2 Mark Johnston freebsd_committer 2020-11-24 18:18:01 UTC
Part of the proposed patch was committed independently.  Would either of you be willing to upload a new patch based on comment 1?
Comment 3 Robert Wing freebsd_committer 2020-12-04 21:46:08 UTC
https://reviews.freebsd.org/D27482
Comment 4 commit-hook freebsd_committer 2021-01-06 19:42:53 UTC
A commit in branch main references this bug:

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

commit b1ea63e2e3c92d1346af067f5cf609e3e062f8b9
Author:     Robert Wing <rew@FreeBSD.org>
AuthorDate: 2021-01-06 19:38:25 +0000
Commit:     Robert Wing <rew@FreeBSD.org>
CommitDate: 2021-01-06 19:38:25 +0000

    bectl(8): sync man page and help text

    Sync man page with behavior of bectl(8).

    Sync help text with man page.

    PR:             246697
    Reported by:    olgeni
    Submitted by:   olgeni (with changes)
    Reviewed by:    kevans, olgeni
    Approved by:    kevans (mentor)
    MFC after:      1 week
    Differential Revision:  https://reviews.freebsd.org/D27482

 sbin/bectl/bectl.8 | 11 +++++------
 sbin/bectl/bectl.c |  9 ++++-----
 2 files changed, 9 insertions(+), 11 deletions(-)