Bug 203406

Summary: [PATCH] update for wpa_cli(8) manual page
Product: Documentation Reporter: fehmi noyan isi <fnoyanisi>
Component: Books & ArticlesAssignee: Sevan Janiyan <sevan>
Status: Closed FIXED    
Severity: Affects Some People CC: fnoyanisi, sevan
Priority: --- Keywords: easy, patch, patch-ready
Version: Latest   
Hardware: Any   
OS: Any   
URL: https://reviews.freebsd.org/D8593
Attachments:
Description Flags
diff to update the wpa_cli(8) manual page
none
Updated Patch
none
Updated Patch none

Description fehmi noyan isi 2015-09-28 06:39:29 UTC
Created attachment 161471 [details]
diff to update the wpa_cli(8) manual page

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
Comment 1 fehmi noyan isi 2016-12-03 07:06:58 UTC
Created attachment 177627 [details]
Updated Patch

Previous patch has been updated based on Benjamin's comments in [1]
I have also created a new revision with this patch [2]

[1] https://reviews.freebsd.org/D8593
[2] https://reviews.freebsd.org/D8691
Comment 2 fehmi noyan isi 2016-12-21 10:14:25 UTC
Created attachment 178171 [details]
Updated Patch

The latest patch.

Revision [1] has been updated

[1]  https://reviews.freebsd.org/D8691
Comment 3 commit-hook freebsd_committer freebsd_triage 2017-01-24 08:57:27 UTC
A commit references this bug:

Author: sevan
Date: Tue Jan 24 08:56:54 UTC 2017
New revision: 312684
URL: https://svnweb.freebsd.org/changeset/base/312684

Log:
  Extend manual to cover more commands and options.

  PR:		203406
  Submitted by:	Fehmi Noyan Isi (fnoyanisi AT yahoo DOT com)
  Approved by:	wblock (mentor)
  MFC after:	5 days
  Differential Revision:	 https://reviews.freebsd.org/D8691

Changes:
  head/usr.sbin/wpa/wpa_cli/wpa_cli.8
Comment 4 Sevan Janiyan freebsd_committer freebsd_triage 2017-01-24 08:58:27 UTC
Committed, Thank you for your submission
Comment 5 fehmi noyan isi 2017-01-24 10:59:38 UTC
Thanks!
Comment 6 commit-hook freebsd_committer freebsd_triage 2017-03-30 01:18:39 UTC
A commit references this bug:

Author: sevan
Date: Thu Mar 30 01:17:46 UTC 2017
New revision: 316189
URL: https://svnweb.freebsd.org/changeset/base/316189

Log:
  MFC 312684

  Extend manual to cover more commands and options.

  PR:		203406
  Submitted by:	Fehmi Noyan Isi (fnoyanisi AT yahoo DOT com)
  Approved by:	wblock (mentor)
  Differential Revision:	 https://reviews.freebsd.org/D8691

Changes:
_U  stable/10/
  stable/10/usr.sbin/wpa/wpa_cli/wpa_cli.8
Comment 7 commit-hook freebsd_committer freebsd_triage 2017-03-30 01:19:43 UTC
A commit references this bug:

Author: sevan
Date: Thu Mar 30 01:18:58 UTC 2017
New revision: 316190
URL: https://svnweb.freebsd.org/changeset/base/316190

Log:
  MFC 312684

  Extend manual to cover more commands and options.

  PR:             203406
  Submitted by:   Fehmi Noyan Isi (fnoyanisi AT yahoo DOT com)
  Approved by:    wblock (mentor)
  Differential Revision:   https://reviews.freebsd.org/D8691

Changes:
_U  stable/11/
  stable/11/usr.sbin/wpa/wpa_cli/wpa_cli.8