Bug 49041 - Grammar (& whitespace) fixes for pkgtools.conf.5.
Summary: Grammar (& whitespace) fixes for pkgtools.conf.5.
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: Akinori MUSHA
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2003-03-09 03:00 UTC by Chris Pepper
Modified: 2003-03-23 10:02 UTC (History)
1 user (show)

See Also:


Attachments
pkgtools.conf.5.diff (559 bytes, patch)
2003-03-09 03:00 UTC, Chris Pepper
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Pepper 2003-03-09 03:00:24 UTC
	Advice on editing the file is confusing.

Fix: Apply this patch.

	
How-To-Repeat: 	man pkgtools.conf (with portupgrade installed)
Comment 1 Adam Weinberger freebsd_committer freebsd_triage 2003-03-09 03:02:42 UTC
Responsible Changed
From-To: freebsd-ports-bugs->knu

Over to maintainer.
Comment 2 Chris Pepper 2003-03-09 03:38:00 UTC
	On closer review, I have more suggestions, and a couple questions.

	Please explain *why* it is a good idea to avoid using a different PORTS_INDEX, and why this isn't the default.

>  # To completely hide the existence of a package, put a dummy file
>  # named "+IGNOREME" in the package directory.

	This is a little confusing -- I don't think of users as editing package directories. Assuming package isn't a typo for port, please explain why & how to do this.

	Expanded patch follows.


						Thanks,


						Chris Pepper

--- pkgtools.conf.sample	Sat Mar  8 22:08:34 2003
+++ pkgtools.conf.sample.fixed	Sat Mar  8 22:32:25 2003
@@ -5,9 +5,9 @@
 # $Idaemons: /home/cvs/pkgtools/etc/pkgtools.conf,v 1.23 2002/12/30 17:29:06 knu Exp $
 
 # Syntax:
-#   string:	'...' or "..."; use the `+' operator to concatinate
+#   string:	'...' or "..."; use the `+' operator to concatenate
 #   boolean:	true or false
-#   array:	[ value, ... ]; use the `+' operator to concatinate
+#   array:	[ value, ... ]; use the `+' operator to concatenate
 #   hash:	{ key => value, ... }
 #   procedure:	proc { |arglist| statements; return_value }
 
@@ -59,9 +59,9 @@
 #      deorigin('sysutils/portupgrade') => 'portupgrade-YYYYMMDD'
 #
 #  rc_file(origin_or_pkgname)
-#    Returns the full path name of a rc file ($PREFIX/etc/rc.d/*.sh)
-#    that was installed by the given package, if any.  When there
-#    appears a port that installs more than one rc file, rc_files()
+#    Returns the full path name of an rc file ($PREFIX/etc/rc.d/*.sh)
+#    that was installed by the given package, if any.  When
+#    the first port appears that installs more than one rc file, rc_files()
 #    will probably be provided.
 
 module PkgConfig
@@ -71,11 +71,11 @@
   # Uncomment and edit as necessary.  The `||=' operator means `set only
   # if it is not set', i.e. it gives a variable its default value.
   #
-  # It is particularly recommendable that you set PORTS_INDEX to
-  # something other than the default value to avoid conflict with CVS,
-  # CVSup, or CTM.
+  # It is particularly recommended that you set PORTS_INDEX to
+  # something other than the default value to avoid conflicts with CVS,
+  # CVSup, and CTM.
   #
-  # cf. portupgarde(1), pkg_which(1)
+  # cf. portupgrade(1), pkg_which(1)
   #
   # defaults:
   #   ENV['PORTSDIR'] ||= '/usr/ports'
@@ -110,7 +110,7 @@
   # If true, perform sanity checks on stale dependencies.  This makes
   # it up to 50% slower to parse package globs but offers unfailing
   # upgrades.  If you are sure you won't forget to run `pkgdb -F'
-  # regularly, turn this off to take performance. (default: true)
+  # regularly, turn this off to improve performance. (default: true)
   #
   # cf. -O/--omit-check of pkg_deinstall(1), pkg_glob(1),
   #     portupgrade(1) and portversion(1)
@@ -145,12 +145,12 @@
   # EXTRA_CATEGORIES: array
   #
   # This is a list of extra port categories you put your locally
-  # maintained ports.  You must prepare a Makefile in each directory
+  # maintained ports into.  You must prepare a Makefile in each directory
   # that defines a variable SUBDIR which lists all the ports in the
   # category.
   #
   # After configuring this list, you need to rebuild the ports
-  # database to reflect the changes. (run 'portsdb -Ufu')
+  # database to reflect the change. (run 'portsdb -Ufu')
   #
   # e.g.:
   #   EXTRA_CATEGORIES = [
@@ -165,7 +165,7 @@
   # This is a list of ports you don't want portupgrade(1) to upgrade,
   # portversion(1) to suggest upgrading, or pkgdb(1) to fix.
   # You can use wildcards ("ports glob" and "pkgname glob").
-  # -f/--force of each command will force the held status.
+  # -f/--force with each command will override the held status.
   #
   # To completely hide the existence of a package, put a dummy file
   # named "+IGNOREME" in the package directory.
@@ -215,12 +215,12 @@
   # This is a hash to define alternative package dependencies.  For
   # each pair A => B, when a package X claims that it depends on a
   # package that matches the "pkgname glob" pattern A which is not
-  # installed, the dependency is replaced with one on the installed
-  # package that matches the "pkgname glob" pattern B.  If the glob B
+  # installed, the dependency is replaced with one installed
+  # package that matches the "pkgname glob" pattern B.  If glob B
   # matches more than one installed package, replacement is not done
   # automatically.  <:delete> and <:skip> are special symbols that can
-  # be used as a B value besides pkgname glob patterns.  <:delete>
-  # means to delete the dependency and <:skip> to skip.
+  # be used as B values, instead of pkgname glob patterns.  <:delete>
+  # means to delete the dependency and <:skip> to skip it.
   #
   # cf. pkg_glob(1)
   #
@@ -254,7 +254,7 @@
   #
   # You can alternatively specify a procedure instead of a string if
   # you want to specify arguments which can vary depending on the port.
-  # The procedure is called with an argument of a port origin.
+  # The procedure is called with a port origin as an argument.
   #
   # e.g.:
   #   MAKE_ARGS = {
@@ -276,7 +276,7 @@
   #
   # You can alternatively specify a procedure instead of a string if
   # you want to run a command which can vary depending on the port.
-  # The procedure is called with an argument of a port origin.  See
+  # The procedure is called with a port origin as an argument.  See
   # the examples in the AFTERINSTALL paragraph.
   #
   # e.g.:
@@ -300,7 +300,7 @@
   #
   # You can alternatively specify a procedure instead of a string if
   # you want to run a command which can vary depending on the port.
-  # The procedure is called with an argument of a port origin.  See
+  # The procedure is called with a port origin as an argument.  See
   # the following examples.
   #
   # e.g.:

-- 
Chris Pepper:               <http://www.reppep.com/~pepper/>
Rockefeller University:     <http://www.rockefeller.edu/>
Comment 3 Akinori MUSHA 2003-03-09 07:24:50 UTC
At Sat, 8 Mar 2003 22:38:00 -0500,
Chris Pepper wrote:

> 	Please explain *why* it is a good idea to avoid using a
> different PORTS_INDEX,

Because INDEX (or INDEX-5 on FreeBSD 5.x) will either be clobbered by
the next run of "cvsup", or cause merge conflicts in the next run of
"cvs update", depending on the means you use to update the ports tree.

>                        and why this isn't the default.

This is because making it the default forces user to sit for half an
hour to generate an INDEX file even if he or she just wants to have a
bite at portupgrade after installing or updating to a new release,
which INDEX file is supposed to be up-to-date out-of-the-box.

> >  # To completely hide the existence of a package, put a dummy file
> >  # named "+IGNOREME" in the package directory.
> 
> 	This is a little confusing -- I don't think of users as
> editing package directories. Assuming package isn't a typo for port,
> please explain why & how to do this.

Some of the third party packages are known to be so broken or out of
date that portupgrade cannot handle, i.e. they often have got a broken
package name that cannot be parsed correctly, are in old package
format, or are missing origins, for they are not in the official tree.

> 	Expanded patch follows.

Thanks, that helps me a lot.  I have it applied in my CVS, to be
released soon, probably after the 4.8-RELEASE.

-- 
                     /
                    /__  __            Akinori.org / MUSHA.org
                   / )  )  ) )  /     FreeBSD.org / Ruby-lang.org
Akinori MUSHA aka / (_ /  ( (__(  @ iDaemons.org / and.or.jp

"It went right by me -- At the time it went over my head
   I was looking out the window.. I should have looked at your face instead"
Comment 4 Akinori MUSHA freebsd_committer freebsd_triage 2003-03-23 10:01:58 UTC
State Changed
From-To: open->closed

Fixed in the latest version.  Thanks.