From swear@blarg.net  Sun Oct 14 11:34:53 2001
Return-Path: <swear@blarg.net>
Received: from lists.blarg.net (lists.blarg.net [206.124.128.17])
	by hub.freebsd.org (Postfix) with ESMTP id 3B00137B401
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 14 Oct 2001 11:34:53 -0700 (PDT)
Received: from thig.blarg.net (thig.blarg.net [206.124.128.18])
	by lists.blarg.net (Postfix) with ESMTP id E4A9ABC8D
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 14 Oct 2001 11:34:52 -0700 (PDT)
Received: from localhost.localdomain ([206.124.139.115])
	by thig.blarg.net (8.9.3/8.9.3) with ESMTP id LAA05717
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 14 Oct 2001 11:34:52 -0700
Received: (from jojo@localhost)
	by localhost.localdomain (8.11.6/8.11.3) id f9EIY4u57000;
	Sun, 14 Oct 2001 11:34:04 -0700 (PDT)
	(envelope-from swear@blarg.net)
Message-Id: <t2het2nk9w.et2@localhost.localdomain>
Date: 14 Oct 2001 11:34:03 -0700
From: "Gary W. Swearingen" <swear@blarg.net>
Reply-To: swear@blarg.net
To: FreeBSD-gnats-submit@freebsd.org
Subject: cvsup(1) "base" option and keyword descriptions are confusing.
X-GNATS-Notify:

>Number:         31264
>Category:       docs
>Synopsis:       cvsup(1) "base" option and keyword descriptions are confusing.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    jdp
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Oct 14 11:40:00 PDT 2001
>Closed-Date:    Mon May 26 11:45:42 PDT 2003
>Last-Modified:  Mon May 26 11:45:42 PDT 2003
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 4.4-RELEASE i386
>Organization:
none
>Environment:
n/a
================
>Description:

cvsup(1) discussion of "-b" option and "base" keyword are not as clear
as they could be, to say the least.  (The "cvsup" command has made
things unnecessarily complicated, but it's too late to fix that.)
================
>How-To-Repeat:
n/a
================
>Fix:

Some rewording of the "-b" option and "base" keyword descriptions,
plus a word change for consistency.   I have the keyword referencing
the option to reduce the text users must read and to make maintenance
easier and less error-prone.

patch -d "unknown uncompressed man/man1 dir" < this-PR

*** /tmp/old-cvsup.1	Wed Aug  8 11:42:23 2001
--- /tmp/cvsup.1	Wed Aug  8 17:20:16 2001
***************
*** 131,141 ****
  connecting to the server.  This may be useful on hosts which have
  multiple IP addresses.
  .It Fl b Ar base
! Specifies the base directory under which
  .Nm
! will maintain its bookkeeping files, overriding any
! .Cm base
! specifications in the
  .Ar supfile .
  .It Fl c Ar collDir
  Specifies the subdirectory of
--- 131,153 ----
  connecting to the server.  This may be useful on hosts which have
  multiple IP addresses.
  .It Fl b Ar base
! Specifies the directory under which
  .Nm
! will place
! .Ar collDir
! and will use as the default
! .Ar prefix
! directory.  The
! .Ar base
! directory must pre-exist;
! .Nm
! will not create it.  The default
! .Ar base
! directory is
! .Pa /usr/local/etc/cvsup .
! This option has precedence over use of the
! .Ar base
! keyword in the
  .Ar supfile .
  .It Fl c Ar collDir
  Specifies the subdirectory of
***************
*** 440,458 ****
  by convention.  Non-CVS collections conventionally use
  .Cm release=current .
  .It Cm base= Ns Ar base
! This specifies a directory under which
! .Nm cvsup
! will maintain its bookkeeping files, describing the state of each
! collection on the client machine.
! The
! .Ar base
! directory must already exist;
! .Nm
! will not create it.
! The default
! .Ar base
! directory is
! .Pa /usr/local/etc/cvsup .
  .It Cm prefix= Ns Ar prefix
  This is the directory under which updated files will be placed.
  By default, it is the same as
--- 452,460 ----
  by convention.  Non-CVS collections conventionally use
  .Cm release=current .
  .It Cm base= Ns Ar base
! This has the same effect as the
! .Fl b
! option except that the option has precedence over this keyword.
  .It Cm prefix= Ns Ar prefix
  This is the directory under which updated files will be placed.
  By default, it is the same as
***************
*** 461,467 ****
  .Ar base .
  The
  .Ar prefix
! directory must already exist;
  .Nm
  will not create it.
  .Pp
--- 463,469 ----
  .Ar base .
  The
  .Ar prefix
! directory must pre-exist;
  .Nm
  will not create it.
  .Pp
>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->jdp 
Responsible-Changed-By: dd 
Responsible-Changed-When: Sun Oct 14 15:31:18 PDT 2001 
Responsible-Changed-Why:  
Over to maintainer (even though the program in question isn't maintained in 
the FreeBSD repo). 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=31264 
State-Changed-From-To: open->closed 
State-Changed-By: jdp 
State-Changed-When: Mon May 26 11:44:36 PDT 2003 
State-Changed-Why:  
Thanks for the patch.  I have added it to my CVSup to-do list. 

Since CVSup is not a part of FreeBSD, problem reports for it don't 
belong in FreeBSD's PR system.  So I am closing this PR. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=31264 
>Unformatted:
