Bug 103956

Summary: [ patch ] [ handbook ] add a section about NFS locking to Handbook
Product: Documentation Reporter: Roman Bogorodskiy <novel>
Component: Books & ArticlesAssignee: Remko Lodder <remko>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
nfslocking.diff none

Description Roman Bogorodskiy freebsd_committer freebsd_triage 2006-10-03 18:30:14 UTC
Add an instruction to Handbook how to enable NFS locking. remko@ and
shaun@ helped to improve wording and markup.
Comment 1 Simon L. B. Nielsen freebsd_committer freebsd_triage 2006-10-03 20:12:49 UTC
On 2006.10.03 21:27:15 +0400, Roman Bogorodskiy wrote:

> Add an instruction to Handbook how to enable NFS locking. remko@ and
> shaun@ helped to improve wording and markup.

It might be a good idea adding a note that rpc.lockd is still
considered rather buggy and depending on setup it might be better to
use the -L for the NFS mount which just does local locking, which of
cause only works if you only have program(s) from one host...

-- 
Simon L. Nielsen
Comment 2 Simon L. B. Nielsen freebsd_committer freebsd_triage 2006-10-08 18:30:23 UTC
On 2006.10.05 15:05:59 +0400, Roman Bogorodskiy wrote:
> Update - fixed problems reported by remko.

>      <sect2>
> +      <title>Locking</title>
> +      
> +      <para>Some applications (e.g. <application>mutt</application>)
> +        require file locking to operate correctly.  In the case of
> +        <acronym>NFS</acronym>, <application>rpc.lockd</application>
> +        can be used for file locking.  To enable it, add the following
> +        to the <filename>/etc/rc.conf</filename> file on both client
> +        and server (it is assumed that <acronym>NFS</acronym>
> +        client and server are configured already):</para>
> +	
> +      <programlisting>rpc_lockd_enable="YES"
> +rpc_statd_enable="YES"</programlisting>
> +	
> +      <para>Start the application by using:</para>

Here should be an extra newline.

> +      <screen>&prompt.root; <userinput>/etc/rc.d/nfslocking start</userinput></screen>
> +
> +      <para>However, there is one more way of doing locking in
> +        <acronym>NFS</acronym> available.  It is possible to pass 
> +        <option>-L</option> to &man.mount.nfs.8;, but it is suitable
> +        for local locking only.  Refer to &man.mount.nfs.8; for
> +        details.</para>

How about instead, something like:

	If real locking between the NFS clients and NFS server is not
	required, it is possible to let the NFS client do locking
	locally by passing -L to &man.mount.nfs.8;.  Refer to the
	&man.mount.nfs.8; manual page for further details.

?

You also have a bit of end-of-line whitespace which should be removed.

> +    </sect2>
> +
> +    <sect2>
>        <title>Practical Uses</title>
>  
>        <para><acronym>NFS</acronym> has many practical uses.  Some of


-- 
Simon L. Nielsen
Comment 3 Roman Bogorodskiy freebsd_committer freebsd_triage 2006-10-08 19:29:44 UTC
  Simon L. Nielsen wrote:

> On 2006.10.05 15:05:59 +0400, Roman Bogorodskiy wrote:
> > Update - fixed problems reported by remko.
> 
> >      <sect2>
> > +      <title>Locking</title>
> > +      
> > +      <para>Some applications (e.g. <application>mutt</application>)
> > +        require file locking to operate correctly.  In the case of
> > +        <acronym>NFS</acronym>, <application>rpc.lockd</application>
> > +        can be used for file locking.  To enable it, add the following
> > +        to the <filename>/etc/rc.conf</filename> file on both client
> > +        and server (it is assumed that <acronym>NFS</acronym>
> > +        client and server are configured already):</para>
> > +	
> > +      <programlisting>rpc_lockd_enable="YES"
> > +rpc_statd_enable="YES"</programlisting>
> > +	
> > +      <para>Start the application by using:</para>
> 
> Here should be an extra newline.
> 
> > +      <screen>&prompt.root; <userinput>/etc/rc.d/nfslocking start</userinput></screen>
> > +
> > +      <para>However, there is one more way of doing locking in
> > +        <acronym>NFS</acronym> available.  It is possible to pass 
> > +        <option>-L</option> to &man.mount.nfs.8;, but it is suitable
> > +        for local locking only.  Refer to &man.mount.nfs.8; for
> > +        details.</para>
> 
> How about instead, something like:
> 
> 	If real locking between the NFS clients and NFS server is not
> 	required, it is possible to let the NFS client do locking
> 	locally by passing -L to &man.mount.nfs.8;.  Refer to the
> 	&man.mount.nfs.8; manual page for further details.
> 
> ?
> 
> You also have a bit of end-of-line whitespace which should be removed.


Here's an updated diff: http://novel.fannet.ru/~novel/nfslocking.diff. 

Roman Bogorodskiy
Comment 4 Remko Lodder 2006-10-13 10:25:13 UTC
Where is the diff now?? (The url no longer has the nfslocking.diff command)


On Sun, Oct 08, 2006 at 10:29:44PM +0400, Roman Bogorodskiy wrote:
>   Simon L. Nielsen wrote:
> 
> > On 2006.10.05 15:05:59 +0400, Roman Bogorodskiy wrote:
> > > Update - fixed problems reported by remko.
> > 
> > >      <sect2>
> > > +      <title>Locking</title>
> > > +      
> > > +      <para>Some applications (e.g. <application>mutt</application>)
> > > +        require file locking to operate correctly.  In the case of
> > > +        <acronym>NFS</acronym>, <application>rpc.lockd</application>
> > > +        can be used for file locking.  To enable it, add the following
> > > +        to the <filename>/etc/rc.conf</filename> file on both client
> > > +        and server (it is assumed that <acronym>NFS</acronym>
> > > +        client and server are configured already):</para>
> > > +	
> > > +      <programlisting>rpc_lockd_enable="YES"
> > > +rpc_statd_enable="YES"</programlisting>
> > > +	
> > > +      <para>Start the application by using:</para>
> > 
> > Here should be an extra newline.
> > 
> > > +      <screen>&prompt.root; <userinput>/etc/rc.d/nfslocking start</userinput></screen>
> > > +
> > > +      <para>However, there is one more way of doing locking in
> > > +        <acronym>NFS</acronym> available.  It is possible to pass 
> > > +        <option>-L</option> to &man.mount.nfs.8;, but it is suitable
> > > +        for local locking only.  Refer to &man.mount.nfs.8; for
> > > +        details.</para>
> > 
> > How about instead, something like:
> > 
> > 	If real locking between the NFS clients and NFS server is not
> > 	required, it is possible to let the NFS client do locking
> > 	locally by passing -L to &man.mount.nfs.8;.  Refer to the
> > 	&man.mount.nfs.8; manual page for further details.
> > 
> > ?
> > 
> > You also have a bit of end-of-line whitespace which should be removed.
> 
> Here's an updated diff: http://novel.fannet.ru/~novel/nfslocking.diff. 
> 
> Roman Bogorodskiy



-- 
Kind regards,

     Remko Lodder               ** remko@elvandar.org
     FreeBSD                    ** remko@FreeBSD.org

     /* Quis custodiet ipsos custodes */
Comment 5 Remko Lodder freebsd_committer freebsd_triage 2006-10-13 12:23:59 UTC
Responsible Changed
From-To: freebsd-doc->remko

I'll take it.
Comment 6 Roman Bogorodskiy freebsd_committer freebsd_triage 2006-10-13 12:53:59 UTC
  Remko Lodder wrote:

> Where is the diff now?? (The url no longer has the nfslocking.diff command)


Hm, there's a weird problem with Apache. The diff should be avaible
again.
 
> On Sun, Oct 08, 2006 at 10:29:44PM +0400, Roman Bogorodskiy wrote:
> >   Simon L. Nielsen wrote:
> > 
> > > On 2006.10.05 15:05:59 +0400, Roman Bogorodskiy wrote:
> > > > Update - fixed problems reported by remko.
> > > 
> > > >      <sect2>
> > > > +      <title>Locking</title>
> > > > +      
> > > > +      <para>Some applications (e.g. <application>mutt</application>)
> > > > +        require file locking to operate correctly.  In the case of
> > > > +        <acronym>NFS</acronym>, <application>rpc.lockd</application>
> > > > +        can be used for file locking.  To enable it, add the following
> > > > +        to the <filename>/etc/rc.conf</filename> file on both client
> > > > +        and server (it is assumed that <acronym>NFS</acronym>
> > > > +        client and server are configured already):</para>
> > > > +	
> > > > +      <programlisting>rpc_lockd_enable="YES"
> > > > +rpc_statd_enable="YES"</programlisting>
> > > > +	
> > > > +      <para>Start the application by using:</para>
> > > 
> > > Here should be an extra newline.
> > > 
> > > > +      <screen>&prompt.root; <userinput>/etc/rc.d/nfslocking start</userinput></screen>
> > > > +
> > > > +      <para>However, there is one more way of doing locking in
> > > > +        <acronym>NFS</acronym> available.  It is possible to pass 
> > > > +        <option>-L</option> to &man.mount.nfs.8;, but it is suitable
> > > > +        for local locking only.  Refer to &man.mount.nfs.8; for
> > > > +        details.</para>
> > > 
> > > How about instead, something like:
> > > 
> > > 	If real locking between the NFS clients and NFS server is not
> > > 	required, it is possible to let the NFS client do locking
> > > 	locally by passing -L to &man.mount.nfs.8;.  Refer to the
> > > 	&man.mount.nfs.8; manual page for further details.
> > > 
> > > ?
> > > 
> > > You also have a bit of end-of-line whitespace which should be removed.
> > 
> > Here's an updated diff: http://novel.fannet.ru/~novel/nfslocking.diff. 
> > 
> > Roman Bogorodskiy
> 
> 
> 
> -- 
> Kind regards,
> 
>      Remko Lodder               ** remko@elvandar.org
>      FreeBSD                    ** remko@FreeBSD.org
> 
>      /* Quis custodiet ipsos custodes */
Comment 7 dfilter service freebsd_committer freebsd_triage 2006-10-13 15:11:07 UTC
remko       2006-10-13 14:11:00 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/handbook/network-servers chapter.sgml 
  Log:
  Add documentation about NFSlocking.
  
  PR:                     docs/103956
  Submitted by:           novel
  Facilitated by:         Snow B.V.
  
  Revision  Changes    Path
  1.91      +26 -0     doc/en_US.ISO8859-1/books/handbook/network-servers/chapter.sgml
_______________________________________________
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 8 Remko Lodder freebsd_committer freebsd_triage 2006-10-13 15:11:47 UTC
State Changed
From-To: open->closed

I committed the patch, thank you very much. I only changed a little 
(formatting style) but the rest was OK, keep it up.