Bug 35649

Summary: mount_smbfs(8) page: "See ./examples/dot.nsmbrc for details."
Product: Documentation Reporter: Johann Frisch <jerfa>
Component: Books & ArticlesAssignee: Simon L. B. Nielsen <simon>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Johann Frisch 2002-03-07 22:00:09 UTC
The "FILES" section of the mount_smbfs man page reads: 
"~/.nsmbrc      Keeps static parameters for connections and other informa-               tion.  See ./examples/dot.nsmbrc for details."

It's rather unlikey to find examples/dot.nsmbrc in every current directory ;-) In fact I couldn't find dot.nsmbrc anywhere on my system.

Fix: 

Write dot.nsmbrc, place it in /usr/share/examples/smbfs and correct the man page?
How-To-Repeat: man mount_smbfs
/^FILES
Comment 1 setantae 2002-03-08 08:29:13 UTC
On Thu, Mar 07, 2002 at 01:59:33PM -0800, Johann Frisch wrote:

I have /usr/src/contrib/smbfs/examples/dot.nsmbrc on my system.
It should probably get installed to /usr/share/examples though.

Ceri

-- 
keep a mild groove on
Comment 2 Peter Pentchev 2002-03-08 16:17:59 UTC
On Fri, Mar 08, 2002 at 12:30:02AM -0800, Ceri wrote:
> The following reply was made to PR docs/35649; it has been noted by GNATS.
>=20
> From: Ceri <setantae@submonkey.net>
> To: Johann Frisch <jerfa@yahoo.com>
> Cc: freebsd-gnats-submit@freebsd.org
> Subject: Re: docs/35649: mount_smbfs(8) page: "See ./examples/dot.nsmbrc =
for details."
> Date: Fri, 8 Mar 2002 08:29:13 +0000
>=20
>  On Thu, Mar 07, 2002 at 01:59:33PM -0800, Johann Frisch wrote:
> =20
>  I have /usr/src/contrib/smbfs/examples/dot.nsmbrc on my system.
>  It should probably get installed to /usr/share/examples though.

OK, how about the following patch?

However, this includes a patch to src/contrib/smbfs/, which is not
something we should really be doing.  This message is CC'd to
Boris Popov, the author of the FreeBSD smbfs code; Boris, could you
look at this PR and see if you like the proposed change to
the mount_smbfs.8 manual page?  I know that this will probably require
a patch to the port, since it either does not install this sample
file, or at least does not install it under /usr/share/examples/
However, the original poster's claim that ./examples/dot.nsmbrc is
not quite what the manual page should mention sounds about right for me :)

G'luck,
Peter

--=20
Peter Pentchev	roam@ringlet.net	roam@FreeBSD.org
PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
I've heard that this sentence is a rumor.

Index: src/contrib/smbfs/mount_smbfs/mount_smbfs.8
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /home/ncvs/src/contrib/smbfs/mount_smbfs/mount_smbfs.8,v
retrieving revision 1.1.1.2
diff -u -r1.1.1.2 mount_smbfs.8
--- src/contrib/smbfs/mount_smbfs/mount_smbfs.8	20 Dec 2001 16:16:25 -0000	=
1.1.1.2
+++ src/contrib/smbfs/mount_smbfs/mount_smbfs.8	8 Mar 2002 11:14:38 -0000
@@ -125,7 +125,7 @@
 .It Pa ~/.nsmbrc
 Keeps static parameters for connections and other information.
 See
-.Pa ./examples/dot.nsmbrc
+.Pa /usr/share/examples/smbfs/dot.nsmbrc
 for details.
 .El
 .Sh EXAMPLES
Index: src/share/examples/smbfs/Makefile
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /home/ncvs/src/share/examples/smbfs/Makefile,v
retrieving revision 1.1
diff -u -r1.1 Makefile
--- src/share/examples/smbfs/Makefile	14 Dec 2001 12:17:03 -0000	1.1
+++ src/share/examples/smbfs/Makefile	8 Mar 2002 11:14:38 -0000
@@ -1,5 +1,15 @@
 # $FreeBSD$
=20
+NOOBJ=3D	noobj
+BINDIR=3D	/usr/share/examples
+
+DISTFILES=3D	dot.nsmbrc
+
+beforeinstall:
+	cd ${.CURDIR}/../../../contrib/smbfs/examples; \
+	    ${INSTALL} -o ${SHAREOWN} -g ${SHAREGRP} -m ${SHAREMODE} \
+		${DISTFILES} ${DESTDIR}${BINDIR}/smbfs
+
 SUBDIR=3D	print
=20
-.include <bsd.subdir.mk>
+.include <bsd.prog.mk>
Comment 3 bp 2002-03-09 07:17:40 UTC
On Fri, 8 Mar 2002, Peter Pentchev wrote:

> >  I have /usr/src/contrib/smbfs/examples/dot.nsmbrc on my system.
> >  It should probably get installed to /usr/share/examples though.
> 
> OK, how about the following patch?
> 
> However, this includes a patch to src/contrib/smbfs/, which is not
> something we should really be doing.  This message is CC'd to
> Boris Popov, the author of the FreeBSD smbfs code; Boris, could you
> look at this PR and see if you like the proposed change to
> the mount_smbfs.8 manual page?  I know that this will probably require
> a patch to the port, since it either does not install this sample
> file, or at least does not install it under /usr/share/examples/
> However, the original poster's claim that ./examples/dot.nsmbrc is
> not quite what the manual page should mention sounds about right for me :)

	Yes, this path is somewhat incorrect and update to mount_smbfs.8
is required. However an example of dor.nsmbrc file already installed as
/etc/nsmb.conf. The syntax of both files are the same with exception that
system-wide configuration file will override equal settings in the per
account dot.nsmbrc file.

-- 
Boris Popov
http://rbp.euro.ru
Comment 4 Peter Pentchev 2002-03-09 21:58:06 UTC
On Fri, Mar 08, 2002 at 11:20:01PM -0800, Boris Popov wrote:
> The following reply was made to PR docs/35649; it has been noted by GNATS.
> 
> From: Boris Popov <bp@butya.kz>
> To: Peter Pentchev <roam@ringlet.net>
> Cc: Ceri <setantae@submonkey.net>, bug-followup@FreeBSD.org
> Subject: Re: docs/35649: mount_smbfs(8) page: "See ./examples/dot.nsmbrc for
>  details."
> Date: Sat, 9 Mar 2002 13:17:40 +0600 (ALMT)
> 
>  On Fri, 8 Mar 2002, Peter Pentchev wrote:
>  
>  > >  I have /usr/src/contrib/smbfs/examples/dot.nsmbrc on my system.
>  > >  It should probably get installed to /usr/share/examples though.
>  > 
>  > OK, how about the following patch?
>  > 
>  > However, this includes a patch to src/contrib/smbfs/, which is not
>  > something we should really be doing.  This message is CC'd to
>  > Boris Popov, the author of the FreeBSD smbfs code; Boris, could you
>  > look at this PR and see if you like the proposed change to
>  > the mount_smbfs.8 manual page?  I know that this will probably require
>  > a patch to the port, since it either does not install this sample
>  > file, or at least does not install it under /usr/share/examples/
>  > However, the original poster's claim that ./examples/dot.nsmbrc is
>  > not quite what the manual page should mention sounds about right for me :)
>  
>  	Yes, this path is somewhat incorrect and update to mount_smbfs.8
>  is required. However an example of dor.nsmbrc file already installed as
>  /etc/nsmb.conf. The syntax of both files are the same with exception that
>  system-wide configuration file will override equal settings in the per
>  account dot.nsmbrc file.

Well, I have to admit that I never noticed that a sample file was
actually installed; however, there are two problems I can see with
that.  First, /etc/nsmb.conf is not exactly the same as dot.nsmbrc;
second, /etc/nsmb.conf is not exactly usable as a reference for
normal users, should they want to do per-user settings - it is installed
with 0600 permissions, making it quite hard to read :)

I still think that an /usr/share/examples/smbfs/dot.nsmbrc or similar
is in order; there already is some sample smbfs configuration in
/usr/share/examples/, although only related to printing.

G'luck,
Peter

-- 
Peter Pentchev	roam@ringlet.net	roam@FreeBSD.org
PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
When you are not looking at it, this sentence is in Spanish.
Comment 5 bp 2002-03-11 09:44:14 UTC
On Sat, 9 Mar 2002, Peter Pentchev wrote:

> >  	Yes, this path is somewhat incorrect and update to mount_smbfs.8
> >  is required. However an example of dor.nsmbrc file already installed as
> >  /etc/nsmb.conf. The syntax of both files are the same with exception that
> >  system-wide configuration file will override equal settings in the per
> >  account dot.nsmbrc file.
> 
> Well, I have to admit that I never noticed that a sample file was
> actually installed; however, there are two problems I can see with
> that.  First, /etc/nsmb.conf is not exactly the same as dot.nsmbrc;
> second, /etc/nsmb.conf is not exactly usable as a reference for
> normal users, should they want to do per-user settings - it is installed
> with 0600 permissions, making it quite hard to read :)

	Yep, forgot about the mode. In this light src/share/examples/smbfs
diff is ok for me.

-- 
Boris Popov
http://rbp.euro.ru
Comment 6 Peter Pentchev 2002-03-22 09:21:37 UTC
On Mon, Mar 11, 2002 at 03:44:14PM +0600, Boris Popov wrote:
> On Sat, 9 Mar 2002, Peter Pentchev wrote:
> 
> > >  	Yes, this path is somewhat incorrect and update to mount_smbfs.8
> > >  is required. However an example of dor.nsmbrc file already installed as
> > >  /etc/nsmb.conf. The syntax of both files are the same with exception that
> > >  system-wide configuration file will override equal settings in the per
> > >  account dot.nsmbrc file.
> > 
> > Well, I have to admit that I never noticed that a sample file was
> > actually installed; however, there are two problems I can see with
> > that.  First, /etc/nsmb.conf is not exactly the same as dot.nsmbrc;
> > second, /etc/nsmb.conf is not exactly usable as a reference for
> > normal users, should they want to do per-user settings - it is installed
> > with 0600 permissions, making it quite hard to read :)
> 
> 	Yep, forgot about the mode. In this light src/share/examples/smbfs
> diff is ok for me.

Thanks, I just committed it, will MFC in a week.

G'luck,
Peter

-- 
Peter Pentchev	roam@ringlet.net	roam@FreeBSD.org
PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
Thit sentence is not self-referential because "thit" is not a word.
Comment 7 simon 2003-05-02 00:23:15 UTC
Hello

Close a doc PR followup...

The examples are now installed and it has been MFC'ed as Peter Pentchev
<roam@FreeBSD.org> said he would but mountd_smbfs(8) still refers to
"./examples/dot.nsmbrc".

I think the man page should be changed as orginally proposed in this PR
to point to /usr/share/examples/smbfs/dot.nsmbrc.

Since smbfs is contrib code I have CC'ed the smbfs author.

-- 
Simon L. Nielsen
Comment 8 Simon L. B. Nielsen freebsd_committer freebsd_triage 2003-07-30 12:04:04 UTC
Responsible Changed
From-To: freebsd-doc->simon

I already worked on this, so I will handle it.
Comment 9 Simon L. B. Nielsen freebsd_committer freebsd_triage 2003-07-31 16:09:16 UTC
State Changed
From-To: open->patched

mount_smbfs(8) is now patched in -CURRENT, will MFC later.
Comment 10 Simon L. B. Nielsen freebsd_committer freebsd_triage 2003-08-11 20:13:02 UTC
State Changed
From-To: patched->closed

MFC'ed to -STABLE.