Bug 121821

Summary: [patch] wpa_supplicant.conf.5 - provide pointer to sample configuration file
Product: Documentation Reporter: edwin
Component: Books & ArticlesAssignee: Daniel Gerzo <danger>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description edwin 2008-03-18 09:10:01 UTC
It took me a while to figure out how to properly use a WEP (silly
Nintendo DS doesn't know about WPA so I needed to reconfigure my
network) configuration. Once I had read through the wpa_supplicant.conf
in /usr/src/contrib/wpa_supplicant it was clear at once.
Comment 1 John Baldwin freebsd_committer freebsd_triage 2008-03-18 13:21:55 UTC
> +.Pa /usr/src/contrib/wpa_supplicant/ .
>  .Sh SEE ALSO
>  .Xr wpa_cli 8 ,
>  .Xr wpa_passphrase 8 ,

This should 
reference /usr/share/examples/etc/wpa_supplicant/wpa_supplicant.conf instead 
since HEAD installs it there and /usr/src/ is not installed on all machines.

BTW, it seems to me that wpa_supplicant.conf should just go 
in /usr/share/examples/etc/ since it lives in /etc and is only a single file 
rather than having its own subdirectory.

-- 
John Baldwin
Comment 2 Sam Leffler freebsd_committer freebsd_triage 2008-03-18 21:18:52 UTC
> BTW, it seems to me that wpa_supplicant.conf should just go 
> in /usr/share/examples/etc/ since it lives in /etc and is only a single file 
> rather than having its own subdirectory.
>   

I believe there were other files that could go in examples and/or I 
followed existing practice from another app.  But feel free to change it.

    Sam
Comment 3 dfilter service freebsd_committer freebsd_triage 2008-07-01 22:53:07 UTC
danger      2008-07-01 21:52:49 UTC

  FreeBSD src repository

  Modified files:
    usr.sbin/wpa/wpa_supplicant Makefile wpa_supplicant.conf.5 
  Log:
  SVN rev 180158 on 2008-07-01 21:52:49Z by danger
  
  - install the example wpa_supplicant.conf file to the share/examples/etc
    directory [1]
  - add the FILES section to the wpa_supplicant.conf.5 file, so that people
    will be able to detect the example configuration file easier. [2]
  
  PR:             docs/121821 [2]
  Approved by:    brooks [1]
  MFC after:      3 days
  
  Revision  Changes    Path
  1.16      +1 -1      src/usr.sbin/wpa/wpa_supplicant/Makefile
  1.10      +5 -0      src/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.conf.5
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 4 Daniel Gerzo freebsd_committer freebsd_triage 2008-07-01 22:54:39 UTC
Responsible Changed
From-To: freebsd-doc->danger

Track
Comment 5 Daniel Gerzo freebsd_committer freebsd_triage 2008-07-01 22:54:52 UTC
State Changed
From-To: open->patched

I have moved the example configuration file to the share/examples/etc 
directory and added a corresponding FILES section to the man page. 
I hope it's sufficient solution for your PR.
Comment 6 dfilter service freebsd_committer freebsd_triage 2008-07-05 12:08:55 UTC
danger      2008-07-05 11:08:26 UTC

  FreeBSD src repository

  Modified files:        (Branch: RELENG_7)
    usr.sbin/wpa/wpa_supplicant Makefile wpa_supplicant.conf.5 
  Log:
  SVN rev 180290 on 2008-07-05 11:08:26Z by danger
  
  MFC r180158:
  
  - install the example wpa_supplicant.conf file to the share/examples/etc
    directory [1]
  - add the FILES section to the wpa_supplicant.conf.5 file, so that people
    will be able to detect the example configuration file easier. [2]
  
  PR:             docs/121821 [2]
  
  Revision  Changes    Path
  1.11.2.5  +1 -1      src/usr.sbin/wpa/wpa_supplicant/Makefile
  1.9.2.1   +5 -0      src/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.conf.5
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 7 Daniel Gerzo freebsd_committer freebsd_triage 2009-01-06 12:39:35 UTC
State Changed
From-To: patched->closed

- the changes are now in RELENG_7 as well as RELENG_6
Comment 8 dfilter service freebsd_committer freebsd_triage 2009-01-06 12:39:57 UTC
Author: danger (doc committer)
Date: Tue Jan  6 12:39:28 2009
New Revision: 186816
URL: http://svn.freebsd.org/changeset/base/186816

Log:
  MFC r180158:
  
  - install the example wpa_supplicant.conf file to the share/examples/etc
    directory [1]
  - add the FILES section to the wpa_supplicant.conf.5 file, so that people
    will be able to detect the example configuration file easier. [2]
  
  PR:		docs/121821 [2]
  Submitted by:	edwin [2]
  Approved by:	brooks [1]

Modified:
  stable/6/usr.sbin/wpa/   (props changed)
  stable/6/usr.sbin/wpa/wpa_supplicant/Makefile
  stable/6/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.conf.5

Modified: stable/6/usr.sbin/wpa/wpa_supplicant/Makefile
==============================================================================
--- stable/6/usr.sbin/wpa/wpa_supplicant/Makefile	Tue Jan  6 12:23:19 2009	(r186815)
+++ stable/6/usr.sbin/wpa/wpa_supplicant/Makefile	Tue Jan  6 12:39:28 2009	(r186816)
@@ -11,6 +11,11 @@ SRCS=	config.c eloop.c common.c md5.c rc
 
 MAN=	wpa_supplicant.8 wpa_supplicant.conf.5
 
+.if ${MK_EXAMPLES} != "no"
+FILESDIR= ${SHAREDIR}/examples/etc
+FILES=	wpa_supplicant.conf
+.endif
+
 CFLAGS+= -I${.CURDIR} -I${WPA_SUPPLICANT_DISTDIR}
 CFLAGS+= -DCONFIG_DRIVER_BSD
 CFLAGS+= -DCONFIG_DRIVER_NDIS

Modified: stable/6/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.conf.5
==============================================================================
--- stable/6/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.conf.5	Tue Jan  6 12:23:19 2009	(r186815)
+++ stable/6/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.conf.5	Tue Jan  6 12:39:28 2009	(r186816)
@@ -514,6 +514,11 @@ network={
         wep_key0=42FEEDDEAFBABEDEAFBEEFAA55
 }
 .Ed
+.Sh FILES
+.Bl -tag -width ".Pa /usr/share/examples/etc/wpa_supplicant.conf" -compact
+.It Pa /etc/wpa_supplicant.conf
+.It Pa /usr/share/examples/etc/wpa_supplicant.conf
+.El
 .Sh SEE ALSO
 .Xr wpa_cli 8 ,
 .Xr wpa_passphrase 8 ,
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"