Date: Tue, 3 Jul 2007 23:20:06 GMT From: Ben Kaduk <minimarmot@gmail.com> To: freebsd-gnats-submit@FreeBSD.org Subject: docs/114272: minor grammar fixes and more to handbook/ports chapter Message-ID: <200707032320.l63NK6oI045496@www.freebsd.org> Resent-Message-ID: <200707032330.l63NU4M1091525@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 114272 >Category: docs >Synopsis: minor grammar fixes and more to handbook/ports chapter >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Tue Jul 03 23:30:03 GMT 2007 >Closed-Date: >Last-Modified: >Originator: Ben Kaduk >Release: 7.0-CURRENT >Organization: >Environment: System: FreeBSD prolepsis.scs.uiuc.edu 7.0-CURRENT FreeBSD 7.0-CURRENT #1: Sun Apr 1 16:59:00 UTC 2007 kaduk@prolepsis.scs.uiuc.edu:/usr/obj/usr/src/sys/GENERIC i386 >Description: I attach a patch (chapter.sgml.diff.txt) with many minor corrections to the ``ports'' handbook chapter, which I will detail here (not necessarily in order). o s/third party/third-party/g o s/Pentium IV/Pentium 4/ (preferred in at least one place on Intel's website o s/compile time/compile/time/g (a priori not a global change, but I checked) o PACKAGESITE: was used before defined as an environment variable, then defined as an environment variable. Move clarification to first usage o add a note that pkg_delete requires name and version (I forget this a lot). Please review the markup; I'm not sure that <literal> is the best tag for that text o add reference to sha256 as well as md5, and change the wording a bit to make clear that the checksums are not built, but included in distinfo. I suppose that the md5 and sha256 man pages are the same, so perhaps they both don't need to be mentioned, but md5 is not the only hash used for this purpose >How-To-Repeat: http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports.html and the rest of the chapter >Fix: patch attached Patch attached with submission follows: --- chapter.sgml.orig 2007-07-03 18:10:53.000000000 -0500 +++ chapter.sgml 2007-07-03 17:13:58.000000000 -0500 @@ -16,7 +16,7 @@ part of the base system. However, there is only so much one can do before needing to install an additional third-party application to get real work done. FreeBSD provides two - complementary technologies for installing third party software + complementary technologies for installing third-party software on your system: the FreeBSD Ports Collection (for installing from source), and packages (for installing from pre-built binaries). Either method may be used to install the @@ -53,7 +53,7 @@ <title>Overview of Software Installation</title> <para>If you have used a &unix; system before you will know that - the typical procedure for installing third party software goes + the typical procedure for installing third-party software goes something like this:</para> <procedure> @@ -97,7 +97,7 @@ <quote>traditional</quote> way with FreeBSD. However, FreeBSD provides two technologies which can save you a lot of effort: packages and ports. At the time of writing, over &os.numports; - third party applications have been made available in this + third-party applications have been made available in this way.</para> <para>For any given application, the FreeBSD package for that @@ -174,11 +174,11 @@ because they have to run on the maximum number of systems. By installing from the port, you can tweak the compilation options to (for example) generate code that is specific to a Pentium - IV or Athlon processor.</para> + 4 or Athlon processor.</para> </listitem> <listitem> - <para>Some applications have compile time options relating to + <para>Some applications have compile-time options relating to what they can and cannot do. For example, <application>Apache</application> can be configured with a wide variety of different built-in options. By building @@ -193,7 +193,7 @@ whether or not you have installed an X11 server. This sort of rough tweaking is possible with packages, but rapidly becomes impossible if an application has more than one or - two different compile time options.</para> + two different compile-time options.</para> </listitem> <listitem> @@ -238,7 +238,7 @@ </warning> <para>The remainder of this chapter will explain how to use - packages and ports to install and manage third party software on + packages and ports to install and manage third-party software on FreeBSD.</para> </sect1> @@ -414,8 +414,8 @@ <para>The example above would download the correct package and add it without any further user intervention. If you want to specify an alternative &os; Packages Mirror, - instead of the main distribution site, you have to set - <envar>PACKAGESITE</envar> accordingly, to + instead of the main distribution site, you have to set the + <envar>PACKAGESITE</envar> environment variable accordingly, to override the default settings. &man.pkg.add.1; uses &man.fetch.3; to download the files, which honors various environment variables, including @@ -436,8 +436,8 @@ &os.stable;. If you run a -RELEASE version, it will grab the version of the package that was built with your release. It is possible to change this behavior by - overriding the <envar>PACKAGESITE</envar> environment - variable. For example, if you run a &os; 5.4-RELEASE + overriding <envar>PACKAGESITE</envar>. + For example, if you run a &os; 5.4-RELEASE system, by default &man.pkg.add.1; will try to fetch packages from <literal>ftp://ftp.freebsd.org/pub/FreeBSD/ports/i386/packages-5.4-release/Latest/</literal>. @@ -553,6 +553,13 @@ </para> <screen>&prompt.root; <userinput>pkg_delete <replaceable>xchat-1.7.1</replaceable></userinput></screen> + + <para>Note that &man.pkg.delete.1; requires the full package name + and number; the above command would not work if + <literal>xchat</literal> was given instead of + <literal>xchat-1.7.1</literal>. It is, however, easy to use + &man.pkg.version.1; to find the version of the installed package. + </para> </sect2> <sect2> @@ -817,9 +824,10 @@ <listitem> <para>A <filename>distinfo</filename> file. This file contains information about the files that must be - downloaded to build the port and their checksums, to + downloaded to build the port, and their checksums + (using &man.md5.1; and &man.sha256.1;), to verify that files have not been corrupted during the - download using &man.md5.1;.</para> + download.</para> </listitem> <listitem> @@ -985,7 +993,7 @@ documentation for your shell for more information.</para> </note> - <para>Some third party DVD-ROM products such as the FreeBSD Toolkit + <para>Some third-party DVD-ROM products such as the FreeBSD Toolkit from the <ulink url="http://www.freebsdmall.com/">FreeBSD Mall</ulink> contain distfiles. They can be used with the Ports Collection. Mount the DVD-ROM on <filename>/cdrom</filename>. If >Release-Note: >Audit-Trail: >Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200707032320.l63NK6oI045496>