Bug 19949

Summary:	The description of /usr/share/examples/cvsup/refuse is inconsistent with cvsup(1).
Product:	Documentation	Reporter:	ushida <ushida>
Component:	Books & Articles	Assignee:	freebsd-doc (Nobody) <doc>
Status:	Closed FIXED
Severity:	Affects Only Me
Priority:	Normal
Version:	Latest
Hardware:	Any
OS:	Any

Description ushida 2000-07-15 17:20:01 UTC

An error in writing of the explanation in /usr/share/examples/cvsup/refuse
causes misinterpretation and inconsistency with cvsup(1).
Although cvsup(1) says `There is currently no provision for comments 
in refuse files.', in /usr/share/examples/cvsup/refuse:
#You can copy this file to your sup directory and uncomment or add
#whatever you would like.

I propose to change the above two lines in /usr/share/examples/cvsup/refuse to:

#You can copy this file to your sup directory and uncomment or add
#whatever you would like. It should be noted that any comment must be 
#removed from refuse files as there is currently no provision for comments.

or add the following lines to /usr/share/examples/cvsup/refuse.
#----------------------------------------------------------------------------
#CAUTION:Any comment must be removed from refuse files as there is currently 
#        no provision for comments.
#----------------------------------------------------------------------------

If there are comments in /usr/sup/refuse by mistake caused by the explanation
in /usr/share/examples/cvsup/refuse, the behavior of `cvsup' depends strongly 
on the server-defined collection of files and even on the comments. 
This is the cause of the delayed finding of this problem. For example,
1. If one uses the whole /usr/share/examples/cvsup/refuse as /usr/sup/refuse,
   cvsup works for `ports-all' and donsn't work for 'src-all'(no error but 
   never update).
2. If one uses the modified /usr/share/examples/cvsup/refuse where the second
   line from the end of the file 
   (#Use this feature with care -- many parts of the src distribution depend)
   are removed, cvsup works for `ports-all' and `src-all'.

Best regards,

Jun Ushida

Fix: 

Modify /usr/share/examples/cvsup/refuse as I proposed.
How-To-Repeat: Uses the whole /usr/share/examples/cvsup/refuse as /usr/sup/refuse.
The command `cvsup' works for `ports-all' and donsn't work for 
'src-all'(no error but never update).

Comment 1 ben freebsd_committer

2000-07-15 17:47:39 UTC

ushida@msa.biglobe.ne.jp wrote:

> or add the following lines to /usr/share/examples/cvsup/refuse.
> #----------------------------------------------------------------------------
> #CAUTION:Any comment must be removed from refuse files as there is currently 
> #        no provision for comments.
> #----------------------------------------------------------------------------

Hmm, how about this:

--- refuse      2000/04/13 14:40:39     1.1
+++ refuse      2000/07/15 16:45:55
@@ -8,6 +8,11 @@
 #CVSup "base" directory, your sup directory is /usr/sup.  If you have
 #changed your base directory, your sup directory is /path/to/base/sup.
 #
+#NOTE:  CVSup currently does not understand comments (lines beginning
+#with a `#' character) in refuse files, so please remember to remove all
+#such comments if you intend to use this file as a starting point for
+#creating your own refuse file.
+#
 #Use this example if you have modified /usr/src/etc/sendmail/freebsd.mc
 #to reflect your local configuration, and you do not want CVSup to
 #overwrite it:

If no-one objects, or beats me to it, I'll commit this soon.

-- 
Ben Smithurst                 / ben@FreeBSD.org / PGP: 0x99392F7D
FreeBSD Documentation Project /

Comment 2 ushida 2000-07-15 19:17:32 UTC

In article <20000715174739.L84045@strontium.scientia.demon.co.uk>
ben@FreeBSD.org wrote:

|Hmm, how about this:
      --- an omission of a middle part ---
|If no-one objects, or beats me to it, I'll commit this soon.

Thank you for your prompt reply.
I approve of your proposal.
--
Jun Ushida

Comment 3 ben freebsd_committer

2000-07-16 21:33:51 UTC

State Changed
From-To: open->closed

Committed in -current and 4-stable, thanks!