From petef@electron.databits.net  Wed Apr 18 18:41:04 2001
Return-Path: <petef@electron.databits.net>
Received: from electron.databits.net (electron.databits.net [207.29.204.16])
	by hub.freebsd.org (Postfix) with ESMTP id F271B37B423
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 18 Apr 2001 18:40:17 -0700 (PDT)
	(envelope-from petef@electron.databits.net)
Received: (from petef@localhost)
	by electron.databits.net (8.11.3/8.11.3) id f3J1d5O47518;
	Wed, 18 Apr 2001 21:39:05 -0400 (EDT)
	(envelope-from petef)
Message-Id: <200104190139.f3J1d5O47518@electron.databits.net>
Date: Wed, 18 Apr 2001 21:39:05 -0400 (EDT)
From: petef@databits.net
Reply-To: petef@databits.net
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: Update to ports(7)
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         26690
>Category:       docs
>Synopsis:       Update to ports(7)
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    dd
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Wed Apr 18 18:50:01 PDT 2001
>Closed-Date:    Tue May 1 19:22:16 PDT 2001
>Last-Modified:  Tue May 01 19:22:24 PDT 2001
>Originator:     Pete Fritchman
>Release:        FreeBSD 4.3-RC i386
>Organization:

  Databits Network Services, Inc.

>Environment:
System: FreeBSD electron.databits.net 4.3-RC FreeBSD 4.3-RC #0: Thu Apr 12 17:02:53 EDT 2001 root@electron.databits.net:/usr/obj/usr/src/sys/ELECTRON i386


>Description:

- update a few miswordings
- add descriptions for the 'search' and 'index' bsd.port.mk targets

>How-To-Repeat:

  N/A

>Fix:

Index: ports.7
===================================================================
RCS file: /home/ncvs/src/share/man/man7/ports.7,v
retrieving revision 1.21
diff -u -r1.21 ports.7
--- ports.7	2000/12/29 09:18:42	1.21
+++ ports.7	2001/04/19 01:34:28
@@ -92,8 +92,9 @@
 .Ar install ,
 and so on all the way to
 .Ar fetch .
-You will usually only target
-.Ar install .
+Usually, you will only use the
+.Ar install
+target.
 .Bl -tag -width configure
 .It Ar fetch
 Fetch all of the files needed to build this port from the site(s)
@@ -102,7 +103,8 @@
 and
 .Ev MASTER_SITE_OVERRIDE .
 .It Ar checksum
-Verify that the fetched distfile matches the one the port was tested against.
+Verify that the fetched distfile's checksum matches the one the port was
+tested against.
 Defining
 .Ev NO_CHECKSUM
 will skip this step.
@@ -152,7 +154,7 @@
 .It Ar distclean
 Remove the port's distfile(s) and perform the
 .Ar clean
-operation.  The
+target.  The
 .Sq clean
 portion recurses to dependencies unless
 .Ev NOCLEANDEPENDS
@@ -186,6 +188,20 @@
 This can be used from
 .Pa /usr/ports
 to create a browsable web of all ports on your system!
+.It Ar search
+Search the INDEX file for the keyword specified by the 
+.Ev KEY
+value.  Results include the path to the port, a short comment, and the
+build and run depends required.
+.It Ar index
+Create /usr/ports/INDEX, used by the
+.Pa pretty-print-*
+and
+.Pa search
+targets.  While the master INDEX file in the CVS repository is periodically
+updated, running the
+.Pa index
+target will ensure your INDEX file is up to date with your ports tree.
 .El
 .Sh ENVIRONMENT
 You can change all of these.
>Release-Note:
>Audit-Trail:

From: Dima Dorfman <dima@unixfreak.org>
To: petef@databits.net
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/26690: Update to ports(7) 
Date: Wed, 18 Apr 2001 19:19:01 -0700

 petef@databits.net writes:
 > >Fix:
 > 
 > Index: ports.7
 > ===================================================================
 > RCS file: /home/ncvs/src/share/man/man7/ports.7,v
 > retrieving revision 1.21
 > diff -u -r1.21 ports.7
 > [...]
 > @@ -186,6 +188,20 @@
 >  This can be used from
 >  .Pa /usr/ports
 >  to create a browsable web of all ports on your system!
 > +.It Ar search
 > +Search the INDEX file for the keyword specified by the 
 
 This should be:
 
 Search the
 .Pa INDEX
 file for the....
 
 > +.Ev KEY
 
 ``KEY'' is not an environment variable.  Perhaps you could explain
 that the syntax is `make search name=query' and `make search
 key=query'.  Ideally it wouldn't be too long.
 
 > +value.  Results include the path to the port, a short comment, and the
 
 Please put a newline instead of two spaces at the end of sentences, e.g.:
 
 value.
 Results include the path...
 
 > +build and run depends required.
 > +.It Ar index
 > +Create /usr/ports/INDEX, used by the
 > +.Pa pretty-print-*
 > +and
 > +.Pa search
 
 This should be:
 
 Create
 .Pa /usr/ports/INDEX ,
 which is used by the
 .Ar pretty-print-*
 and
 .Ar search
 targets.
 
 Other than that (and a few other places you made the same errors) it
 looks pretty good.  If you could fix that up I'd appreciate it.
 
 Thanks,
 
 					Dima Dorfman
 					dima@unixfreak.org
 

From: Pete Fritchman <petef@databits.net>
To: Dima Dorfman <dima@unixfreak.org>
Cc: FreeBSD-gnats-submit@FreeBSD.org
Subject: Re:  docs/26690: Update to ports(7)
Date: Fri, 20 Apr 2001 20:12:38 -0400

 ++ 18/04/01 19:20 -0700 - Dima Dorfman:
 | The following reply was made to PR docs/26690; it has been noted by GNATS.
 | 
 
 Thanks for your constructive comments, here's another go at it.  The one
 thing I was unsure of is when I was giving an example of make search, I
 used:
 
 +.Bd -literal -offset indent
 +cd /usr/ports && make search name=query
 +.Ed
 +.Pp
 
 Is that the best way to give an example command?  
 
 Thanks!
 
 --
 Pete Fritchman <petef@databits.net>
 Databits Network Services, Inc. <http://databits.net>
 finger petef@databits.net for PGP key
 
 
 [ also available http://hex.databits.net/~petef/freebsd/ports.7.diff ]
 
 Index: ports.7
 ===================================================================
 RCS file: /home/ncvs/src/share/man/man7/ports.7,v
 retrieving revision 1.21
 diff -u -r1.21 ports.7
 --- ports.7	2000/12/29 09:18:42	1.21
 +++ ports.7	2001/04/21 00:00:46
 @@ -92,8 +92,9 @@
  .Ar install ,
  and so on all the way to
  .Ar fetch .
 -You will usually only target
 -.Ar install .
 +Usually, you will only use the
 +.Ar install
 +target.
  .Bl -tag -width configure
  .It Ar fetch
  Fetch all of the files needed to build this port from the site(s)
 @@ -102,7 +103,8 @@
  and
  .Ev MASTER_SITE_OVERRIDE .
  .It Ar checksum
 -Verify that the fetched distfile matches the one the port was tested against.
 +Verify that the fetched distfile's checksum matches the one the port was
 +tested against.
  Defining
  .Ev NO_CHECKSUM
  will skip this step.
 @@ -152,7 +154,8 @@
  .It Ar distclean
  Remove the port's distfile(s) and perform the
  .Ar clean
 -operation.  The
 +target.
 +The
  .Sq clean
  portion recurses to dependencies unless
  .Ev NOCLEANDEPENDS
 @@ -186,6 +189,36 @@
  This can be used from
  .Pa /usr/ports
  to create a browsable web of all ports on your system!
 +.It Ar search
 +Search the
 +.Pa INDEX
 +file for the pattern specified by either the
 +.Pa key
 +(searches the port name, comment, and depends) or
 +.Pa name
 +(just searches the port name) make argument.
 +For example, one would type 
 +.Bd -literal -offset indent
 +cd /usr/ports && make search name=query
 +.Ed
 +.Pp
 +to find all ports whose
 +name matches
 +.Pa query .
 +Results include the matching ports' path, comment, maintainer, build depends,
 +and run depends.
 +.It Ar index
 +Create
 +.Pa /usr/ports/INDEX ,
 +which is used by the
 +.Ar pretty-print-*
 +and
 +.Ar search
 +targets.
 +While the master INDEX file in the CVS repository is periodically
 +updated, running the
 +.Pa index
 +target will ensure your INDEX file is up to date with your ports tree.
  .El
  .Sh ENVIRONMENT
  You can change all of these.
 
State-Changed-From-To: open->analyzed 
State-Changed-By: dd 
State-Changed-When: Sat Apr 21 17:28:53 PDT 2001 
State-Changed-Why:  
Committed to -current, thanks!  I'll MFC this in a few days. 


Responsible-Changed-From-To: freebsd-doc->dd 
Responsible-Changed-By: dd 
Responsible-Changed-When: Sat Apr 21 17:28:53 PDT 2001 
Responsible-Changed-Why:  
My MFC reminder. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=26690 

From: Dima Dorfman <dima@unixfreak.org>
To: Pete Fritchman <petef@databits.net>
Cc: FreeBSD-gnats-submit@FreeBSD.org
Subject: Re: docs/26690: Update to ports(7) 
Date: Sat, 21 Apr 2001 17:28:47 -0700

 Pete Fritchman <petef@databits.net> writes:
 > +.Bd -literal -offset indent
 > +cd /usr/ports && make search name=query
 > +.Ed
 > +.Pp
 > 
 > Is that the best way to give an example command?  
 
 This is fine.  For one-line examples like the above, you can also do:
 
 .Pp
 .Dl cd /usr/ports && make search name=query
 .Pp
 
 to achieve the same thing.
 
 > +.Pa key
 > +(searches the port name, comment, and depends) or
 > +.Pa name
 
 ".Pa" is used to markup pathnames.  `key' and `name' aren't paths.
 
 > +While the master INDEX file in the CVS repository is periodically
 > +updated, running the
 > +.Pa index
 
 In this context, `index' is a make target (marked up with .Ar), not a path.
 
 Since the problems are very minor, I've went ahead and fixed them and
 committed the change to HEAD.  Thanks!
 
 					Dima Dorfman
 					dima@unixfreak.org
State-Changed-From-To: analyzed->closed 
State-Changed-By: dd 
State-Changed-When: Tue May 1 19:22:16 PDT 2001 
State-Changed-Why:  
MFC'd 

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