From owner-freebsd-doc@FreeBSD.ORG Fri Nov 16 17:48:16 2012 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 8D08ADD9; Fri, 16 Nov 2012 17:48:16 +0000 (UTC) (envelope-from gjb@FreeBSD.org) Received: from onyx.glenbarber.us (onyx.glenbarber.us [IPv6:2607:fc50:1000:c200::face]) by mx1.freebsd.org (Postfix) with ESMTP id 4D6468FC08; Fri, 16 Nov 2012 17:48:16 +0000 (UTC) Received: from glenbarber.us (75-146-225-65-Philadelphia.hfc.comcastbusiness.net [75.146.225.65]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) (Authenticated sender: gjb) by onyx.glenbarber.us (Postfix) with ESMTPSA id 75A6023F6D8; Fri, 16 Nov 2012 12:48:15 -0500 (EST) Date: Fri, 16 Nov 2012 12:48:13 -0500 From: Glen Barber To: Warren Block Subject: Re: Request for Review: pkgng documentation for the Handbook Message-ID: <20121116174813.GF1335@glenbarber.us> References: <20121116165810.GC1335@glenbarber.us> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="8bBEDOJVaa9YlTAt" Content-Disposition: inline In-Reply-To: X-Operating-System: FreeBSD 10.0-CURRENT amd64 User-Agent: Mutt/1.5.21 (2010-09-15) Cc: freebsd-doc@freebsd.org X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 16 Nov 2012 17:48:16 -0000 --8bBEDOJVaa9YlTAt Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Fri, Nov 16, 2012 at 10:34:57AM -0700, Warren Block wrote: > On Fri, 16 Nov 2012, Glen Barber wrote: >=20 > > I would like to get feedback on recent commits to the projects/pkgng/ > > branch, which adds documentation for pkgng to the Handbook. > > > > There are a few sections on my todo list, but I feel what is there now > > covers the basics for FreeBSD users. > > > > The diff is attached, and rendered output is here: > > > > http://people.freebsd.org/~gjb/pkgng/data/doc/en/books/handbook/pkgn= g-intro.html >=20 > Nice! I do have some suggestions: >=20 > pkgng is not a replacement for port management tools like > ports-mgmt/portmaster or ports-mgmt/portupgrade. >=20 > That sentence ends a little abruptly. A second sentence could elaborate= =20 > a little on why those two tools still work or are needed. >=20 Ok, thanks. >=20 > "Getting Started with pkgng" > Markup on bootstrap should be tags. >=20 Hmm. I didn't think tags actually worked. > "Existing FreeBSD installations require conversion of the pkg_install=20 > package database" > pkg_install should be a man page ref. There actually is no pkg_install manual page. > To ensure the FreeBSD Ports Collection registers new software with > pkgng, and not pkg_install, add the following lines to /etc/make.conf: >=20 > pkg_install should be a man page ref. I'd also suggest "these" or=20 > "this" instead of "the following". >=20 Ok, thanks. > The visually-disruptive Note at the end of that step about it not being= =20 > required on 10.x could be added to the preceding paragraph: >=20 > For versions of &os; before 10.X, add this line to /etc/make.conf: >=20 >=20 >=20 > "Configuring the pkgng Environment" is kind of confusing, and could be=20 > simplified. Is it necessary to mention the environment variable at all? >=20 > The pkgng package management system uses a package repository for most > operations. The default package repository location is > defined in /usr/local/etc/pkg.conf or the PACKAGESITE environment > variable which overrides the configuration file. >=20 Looks good to me. Thanks. >=20 > "Basic pkgng Operations" > pkg(8) should be a man page ref. >=20 There are no manref entries for pkg* since it is from ports. I had to convert these from &man.pkg.*.N; to hard-coded text to unbreak the build. Glen --8bBEDOJVaa9YlTAt Content-Type: application/pgp-signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.19 (FreeBSD) iQEcBAEBCAAGBQJQpnxdAAoJEFJPDDeguUajFBAH/3n2N2AF24yBkc6hERW0UwR2 IjmOqAgZ3CEUN4C3LSEqJUl2Mw5HxPTkccJ8pCBthttpQKszHwJfG2hOlMo/WN5x 4xemVQzJ4jdgJ84RT3a2fxozc8oX7eJ6THROR4yu+STGvp6wqLNkOQBBYcDNTftd eJP/ITQQsMRhbqmXSyKZYGh5LD6qDUEtK8b6XqgzlDrehjUcInuxFigIXG+4ZT1F A3UzDrXLAJAWgtga9ArqWr+wy1dN2LhZ+dVWWOxsHlovtlVjQ1kZCAHW3T/P6vHI /CApcY5wksjhckjHbzXSNFNhX+ja+NGN30yd3EzuQhV5JNm2SC1lS8h5Ib8MPik= =IekG -----END PGP SIGNATURE----- --8bBEDOJVaa9YlTAt--