update for wpa_cli(8)
AbandonedPublic
Actions

Authored by sevan on Nov 20 2016, 9:29 PM.

Details

Reviewers

bjk
bcr

Group Reviewers

manpages

Summary

Bug 203406

Make adjustments highlighted by Igor.

From the bug report:

SYNPOSIS section has been updated to reflect the command line options
OPTIONS section, which includes the description of each command line option (such as -v, -a, -G, -g, -B), has been added
Other supported commands have been added into the COMMANDS sections. The wpa_cli_commands[] structure contained in the /contrib/wpa/wpa_supplicant/wpa_cli.c file is used as the reference for adding new commands (commands that need a special compile time option have been excluded)

Repository

rS FreeBSD src repository - subversion

Lint

Lint Skipped

Unit

Tests Skipped

sevan retitled this revision from to update for wpa_cli(8).

sevan updated this object.

sevan edited the test plan for this revision. (Show Details)

sevan added a reviewer: bcr.

sevan added a project: manpages.

I'd prefer to not see more \fB and \fR escapes going in; we should use the richer mdoc macros.

usr.sbin/wpa/wpa_cli/wpa_cli.8
37	We shouldn't need the \fB and \fR escapes if we use the Fl macro. It looks like this man page is FreeBSD-local (as opposed to the sources, which are in contrib), so there would not be concerns about diverging from upstream unless the README is somehow using roff markup.
160	The default
169	This might be better as "the daemon" but I'm not sure.
171	comma after mode I'm not sure what "the action file" means in this context, though.
178	the default I think "Unix" may be a better spelling.
184	Either "to the wpa_supplicant daemon" or "to wpa_supplicant"; my preference is the latter.
197	The default
201	utility or daemon?
202	Use .Xr for the reference.
247	Hmm, should PIN be capitalized?
259	This sentence is a bit awkward, maybe Specifying .Ar clear causes .Nm to clear the blacklist.
280	(Some of the \fB are not .Fl, of course, but maybe .Ar?)

This revision now requires changes to proceed.Nov 20 2016, 11:10 PM

sevan edited edge metadata.

sevan marked 12 inline comments as done.

usr.sbin/wpa/wpa_cli/wpa_cli.8
41	Ah, I see, all of these ("action file", "pid file", etc.) are single arguments, not keyword and argument (as if "action", "pid", "global" were literal strings). In that case, we should probably use an underscore instead of a space to make it more clear that it is a single argument, as in "action_file" or "path_to_ctrl_sockets" further above.
42	Space before the ellipsis
161	No need for "your".
163	.Pa for pathnames
184	I don't think this is done?
190	Warren will probably complain about "below".
197	I don't think this is done either (now applies to line 202)