Page MenuHomeFreeBSD

jexec man: Add examples section
ClosedPublic

Authored by dbaio on Jul 1 2023, 8:39 PM.
Tags
None
Referenced Files
Unknown Object (File)
Mon, Sep 23, 7:24 PM
Unknown Object (File)
Sun, Sep 22, 12:30 PM
Unknown Object (File)
Sun, Sep 22, 2:27 AM
Unknown Object (File)
Sat, Sep 21, 2:37 PM
Unknown Object (File)
Fri, Sep 20, 3:41 PM
Unknown Object (File)
Wed, Sep 18, 9:34 AM
Unknown Object (File)
Sat, Sep 14, 12:38 PM
Unknown Object (File)
Sun, Sep 8, 8:52 AM

Details

Summary
jexec man: Add examples section

MFC after:      3 days
Test Plan
$ mandoc -T lint ./jexec.8
<null>

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 52375
Build 49266: arc lint + arc unit

Event Timeline

dbaio requested review of this revision.Jul 1 2023, 8:39 PM

Nits fixable on commit

usr.sbin/jexec/jexec.8
71
80
85
89
This revision is now accepted and ready to land.Jul 3 2023, 12:37 AM
danfe added inline comments.
usr.sbin/jexec/jexec.8
77

Shouldn't we expand contractions?

81

uname(8) -> .Xr uname 1

$ man 8 uname
No manual entry for uname
86

sh(1) -> .Xr sh 1

89

login(1) -> .Xr login 1

92

motd(5) -> .Xr motd 5

This revision now requires review to proceed.Jul 3 2023, 10:57 AM

Thank you both for reviewing.

usr.sbin/jexec/jexec.8
71

This is rendering correct.

89

I couldn't use this macro in the example title; it doesn't render in the same line.
But the reference is in the next paragraph.

usr.sbin/jexec/jexec.8
77

It should read "It is also possible ...", its is a possessive pronoun. :-)

89

I couldn't use this macro in the example title; it doesn't render in the same line.

Oh, so .Xr references cannot be used with .Ss? Interesting...

dbaio marked 2 inline comments as done.Jul 4 2023, 2:24 AM
dbaio added inline comments.
usr.sbin/jexec/jexec.8
89

it seems so, I couldn't find any other man page doing that.

Looks nice. I just have some minor suggestions.

usr.sbin/jexec/jexec.8
77

s/by is/by its/

82

Perhaps this could be rephrased into

The following command runs
.Ql uname -a
in a jail called
.Dq name .
Since a command is specified explicitly,
.Nm
does not spawn an interactive shell.
Instead,
.Nm
executes the specified command directly.
89

In that case I'd replace "login(1)" with "the login command" to avoid confusion.

92

A newline would be nice here.

94

Usually, .Xr should be on its own line. Perhaps it renders correctly, but it is not how Xr is usually used :)

dbaio marked an inline comment as done.
  • Improve examples

@0mp, thanks for the tips and feedback; much appreciated.

This revision is now accepted and ready to land.Oct 4 2023, 8:28 AM
This revision was automatically updated to reflect the committed changes.

Thank you everyone for reviewing this.