Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 12 Jun 2002 00:27:18 -0400 (EDT)
From:      Chris Pepper <pepper@rockefeller.edu>
To:        FreeBSD-gnats-submit@FreeBSD.org
Cc:        Akinori MUSHA <knu@FreeBSD.org>
Subject:   ports/39183: Typos in pkgdb man page
Message-ID:  <200206120427.g5C4RIA02899@guest.reppep.com>

next in thread | raw e-mail | index | archive | help

>Number:         39183
>Category:       ports
>Synopsis:       Typos in pkgdb man page
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-ports
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Jun 11 21:30:00 PDT 2002
>Closed-Date:
>Last-Modified:
>Originator:     Chris Pepper
>Release:        FreeBSD 4.6-RC i386
>Organization:
>Environment:
System: FreeBSD guest.reppep.com 4.6-RC FreeBSD 4.6-RC #0: Fri Jun 7 21:51:10 EDT 2002 root@guest.reppep.com:/usr/obj/usr/src/sys/GENERIC i386


	
>Description:
	I found some typos in the pkgdb man page (pkgdb.1). Patch is below.

	I also found an incomplete paragraph -- it's not clear what should come next:

As you see, you can omit version numbers.  If multiple versions are
installed, each of them is upgraded unless they share a port origin.
(For example you may probably have
.Ar foo-1.02
and
.El

>How-To-Repeat:
	
>Fix:

--- pkgdb.1.diff begins here ---
--- pkgdb.1	Tue Jun 11 23:58:51 2002
+++ pkgdb.1.fixed	Wed Jun 12 00:15:29 2002
@@ -6,7 +6,7 @@
 .Sh NAME
 .Nm pkgdb ,
 .Nm pkg_which
-.Nd tools to manage and look up the packages database
+.Nd tools to manage and search the package database
 .Sh SYNOPSIS
 .Nm
 .Op Fl hfFquv
@@ -20,22 +20,23 @@
 .Sh DESCRIPTION
 The
 .Nm
-command is a tool to create or update packages database which is
-commonly used among the tool suite.  It keeps a hash that maps an
+command is a tool to create or update the system package database which is
+used by the
+.Xr portupgrade 1
+tool suite.  It maintains a hash that maps an
 installed file to a pacakge name, a hash that maps a package to an
 origin, and a list of installed packages.
 .Pp
 .Nm pkg_which
-looks up the packages database to tell which package each specified
-file came from.  If you do not have permission to update the database
-although it is outdated, it delegates tasks to
+looks in the package database to tell which package each specified
+file came from.  If the database is outdated but you do not have permission to update it, it delegates tasks to
 .Xr pkg_info 1 .
 .Pp
 Actually,
 .Nm
 and
 .Nm pkg_which
-share an entity and are totally equivalent.
+are the same command, and are equivalent.
 .Pp
 The
 .Nm
@@ -44,11 +45,11 @@
 .Fl F
 is specified.  It helps you resolve stale dependencies, unlink cyclic
 dependencies, complete stale or missing origins and remove duplicates.
-You have to run this periodically so
+You should run this command periodically so
 .Xr portupgrade 1
 and other
 .Cm pkg_*
-tools can work effectively and unfailingly.
+tools can work effectively and reliably.
 .Sh OPTIONS
 The following command line arguments are supported:
 .Pp
@@ -107,7 +108,7 @@
 .Pp
 .It Fl u
 .It Fl -update
-Update or create the packages database file
+Update or create the package database file
 .Pa pkgdb.db
 in
 .Pa $PKG_DBDIR ,
@@ -115,8 +116,7 @@
 .Pa /var/db/pkg
 by default.
 .Pp
-Note: the ports database files are automatically updated if it is not
-up-to-date when looked up, so manual updating is not mandatory.
+Note: if the ports database files are stale, pkgdb will automatically update them before proceding, so manual updating is not mandatory.
 .Pp
 .It Fl v
 .It Fl -verbose
@@ -188,7 +188,7 @@
 .An Akinori MUSHA Aq knu@iDaemons.org
 .Sh BUGS
 .Pp
-Sometimes a database may get corrupt and the pkgtools commands start
-to abort due to segmentation fault.  In such cases, run
+Sometimes a database may get corrupt, and the pkgtools commands will then
+to abort due with a segmentation fault.  In such cases, run
 .Dq Cm pkgdb -fu
-to rebuild the database, and the problems will go away.
+to rebuild the database, and the problems should go away.
--- pkgdb.1.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted:
 	
 
 FreeBSD guest.reppep.com 4.5-RELEASE FreeBSD 4.5-RELEASE #0: Mon Jan 28 14:31:56 GMT 2002     murray@builder.freebsdmall.com:/usr/src/sys/compile/GENERIC  i386
 

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-ports" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200206120427.g5C4RIA02899>