wpa_cli.8 manual page update revision

[fnoyanisi_yahoo.com]

Summary

Diff file has been updated

wpa_cli.8.D8691_patched_edited:201
+.It Ic ifname
+Shows the current interface name.
+The default interface is the first interface found in the socket path.

passive -> active: s/Shows/Show/
Done!

wpa_cli.8.D8691_patched_edited:204
+.It Ic ping
+Pings the
+.Xr wpa_supplicant 8

passive -> active: s/Pings/Ping/
Done!

[wblock]

wpa_cli.8.d8593

155 ↗

(On Diff #22660)

s/The following/These/

158 ↗

(On Diff #22660)

"should" is best used for recommending something. Here, it kind of introduces doubt. If control sockets "should" be found there, does that mean sometimes they are not?
I suspect this really means

Control sockets path.

166 ↗

(On Diff #22660)

Passive to active:

Interface to be configured.

178 ↗

(On Diff #22660)

When possible, removing the verbs from the beginning of these can make them shorter and sometimes clearer.

PID file location.

188 ↗

(On Diff #22660)

See the

195 ↗

(On Diff #22660)

(I know, not yours in this diff.)
s/The following/These/
s/may be/can be/

202 ↗

(On Diff #22660)

s/Default/The default/

207 ↗

(On Diff #22660)

s/of/of the/

294 ↗

(On Diff #22660)

"should be invoked after" meaning "can be", or meaning "must be run after a BSS scan or bad things happen"?

297 ↗

(On Diff #22660)

s/network/the network/

308 ↗

(On Diff #22660)

s/given/the given/

[fnoyanisi_yahoo.com]

Diff file has been updated according to Warren's suggestions.
Thank you!

[wblock]

A quick glance and this looks good, but it's missing any context. Please see https://wiki.freebsd.org/action/show/Phabricator?action=show&redirect=CodeReview#Create_a_Revision_via_Web_Interface

Thanks!

[fnoyanisi_yahoo.com]

Hi there,

Some additional context on the motivation for this patch (from bug report 203406 [1])

Current manual page for wpi_cli(8) is out of date -dated 2005- and lacks descriptions of command line options and many commands.

With this patch;

• 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)

Patch was generated against the wpa_cli.8 man page included in the "head" branch.

wpa_cli.8.fni -> working copy
wpa_cli.8 -> original file from the "head" branch

Diff file was generated with the command below
diff -u wpa_cli.8 wpa_cli.8.fni > wpa_cli.8.diff

Sevan created the relevant Phabricator entry for the review of the patch in [1]. Diff 23173 [2] reflects corrections proposed by Benjamin and Warren.

[1] https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=203406
[2] https://reviews.freebsd.org/D8691?id=23173

[wblock]

wpa_cli.8.D8691_patched_edited

201 ↗

(On Diff #23173)

passive -> active: s/Shows/Show/

204 ↗

(On Diff #23173)

passive -> active: s/Pings/Ping/

[fnoyanisi_yahoo.com]

Two updates have been incorporated into the patch;

1 ) passive -> active: s/Shows/Show/ in COMMANDS section of the manual page

wpa_cli.8.D8691_patched_edited:201
+.It Ic ifname
+Shows the current interface name.
+The default interface is the first interface found in the socket path.

2 ) passive -> active: s/Pings/Ping/ in COMMANDS section of the manual page

wpa_cli.8.D8691_patched_edited:204
+.It Ic ping
+Pings the
+.Xr wpa_supplicant 8

[fnoyanisi_yahoo.com]

This comment was removed by fnoyanisi_yahoo.com.

[wblock]

Still no context (as in diff context, as in svn diff --diff-cmd=diff -x -U999999 or git diff -U999999 other-branch). But other than the whitespace issues noted, looks good. Please fix those, bump .Dd, and check the patched file with igor -R wpa_cli.8 and mandoc -Tlint wpa_cli.8 before commit.

wpa_cli.8

160

igor says there is trailing whitespace on this line.

163

igor says there is trailing whitespace on this line also, although it can't be seen in Phabricator.