Page MenuHomeFreeBSD
Differential D8691

wpa_cli.8 manual page update revision
ClosedPublic
Actions

Authored by fnoyanisi_yahoo.com on Dec 2 2016, 7:50 AM.
Tags
None
Referenced Files
F81970881: D8691.diff
Sat, Dec 14, 9:32 PM
Unknown Object (File)
Wed, Nov 20, 4:34 AM
Unknown Object (File)
Tue, Nov 19, 10:51 AM
Unknown Object (File)
Sat, Nov 16, 9:20 PM
Unknown Object (File)
Sat, Nov 16, 12:40 PM
Unknown Object (File)
Fri, Nov 15, 9:42 PM
Unknown Object (File)
Fri, Nov 15, 5:00 PM
Unknown Object (File)
Fri, Nov 15, 4:33 PM
View All 82 Files
Subscribers
fnoyanisi_yahoo.com
sevan
wblock

Details

Reviewers
bjk
wblock
bcr
Commits
rS316190: MFC 312684
rS316189: MFC 312684
rS312684: Extend manual to cover more commands and options.
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!

Diff Detail

Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

fnoyanisi_yahoo.com updated this revision to Diff 22659.Dec 2 2016, 7:50 AM
fnoyanisi_yahoo.com retitled this revision from to Updated diff file.
fnoyanisi_yahoo.com updated this object.
fnoyanisi_yahoo.com edited the test plan for this revision. (Show Details)
fnoyanisi_yahoo.com updated this revision to Diff 22660.Dec 2 2016, 8:16 AM
fnoyanisi_yahoo.com added a parent revision: D8593: update for wpa_cli(8).Dec 2 2016, 8:24 AM
fnoyanisi_yahoo.com mentioned this in D8593: update for wpa_cli(8).Dec 2 2016, 8:33 AM
sevan added a subscriber: sevan.Dec 5 2016, 2:17 PM
sevan added reviewers: bcr, bjk.Dec 5 2016, 5:01 PM
wblock added a subscriber: wblock.Dec 16 2016, 7:10 PM
wblock added inline comments.
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 marked 11 inline comments as done.EditedDec 21 2016, 10:01 AM

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

fnoyanisi_yahoo.com updated this revision to Diff 23173.Dec 21 2016, 10:11 AM
fnoyanisi_yahoo.com updated this object.
fnoyanisi_yahoo.com added a subscriber: fnoyanisi_yahoo.com.
wblock added a comment.Dec 23 2016, 4:22 AM

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 added a comment.Dec 29 2016, 9:38 AM

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 added inline comments.Jan 13 2017, 3:29 PM
wpa_cli.8.D8691_patched_edited
201

passive -> active: s/Shows/Show/

204

passive -> active: s/Pings/Ping/

fnoyanisi_yahoo.com updated this revision to Diff 24105.Jan 17 2017, 10:15 AM
fnoyanisi_yahoo.com retitled this revision from Updated diff file to wpa_cli.8 manual page update revision.
fnoyanisi_yahoo.com updated this object.
fnoyanisi_yahoo.com marked 2 inline comments as done.

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 added a comment.Jan 17 2017, 10:16 AM
This comment was removed by fnoyanisi_yahoo.com.
wblock accepted this revision.Jan 20 2017, 3:40 PM
wblock added a reviewer: 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 ↗(On Diff #24105)

igor says there is trailing whitespace on this line.

163 ↗(On Diff #24105)

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

This revision is now accepted and ready to land.Jan 20 2017, 3:40 PM
Closed by commit rS312684: Extend manual to cover more commands and options. (authored by sevan). · Explain WhyJan 24 2017, 8:57 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
132 lines

Diff 23173

View Options

wpa_cli.8.D8691_patched_edited

Loading...