docs/122906: [patch] Fix makevar, maketarget Tags in Handbook Chapter 4.

Gabor PALI pgj at FreeBSD.org
Sat Apr 19 11:00:02 UTC 2008


>Number:         122906
>Category:       docs
>Synopsis:       [patch] Fix makevar, maketarget Tags in Handbook Chapter 4.
>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:   Sat Apr 19 11:00:01 UTC 2008
>Closed-Date:
>Last-Modified:
>Originator:     Gabor PALI
>Release:        FreeBSD 6.3-STABLE i386
>Organization:
>Environment:
System: FreeBSD disznohal 6.3-STABLE FreeBSD 6.3-STABLE #4: Fri Apr 4 23:29:43 CEST 2008 dezzy at disznohal:/usr/obj/usr/src/sys/GENERIC_ i386

>Description:
	I found a small inconsistency in the use of maketarget, makevar
	tags in SGML source of the Handbook chapter titled ``Packages and
	Ports''. So, I created a patch to unify their usage and
	<command>make <maketarget>all consistent</maketarget></command>
	in the <makevar>PORTS_CHAPTER</makevar> :)
	
>How-To-Repeat:

>Fix:

	Apply the following patch:

--- ports.patch.diff begins here ---
Index: chapter.sgml
===================================================================
RCS file: /doc/en_US.ISO8859-1/books/handbook/ports/chapter.sgml,v
retrieving revision 1.279
diff -u -r1.279 chapter.sgml
--- chapter.sgml	29 Mar 2008 04:00:09 -0000	1.279
+++ chapter.sgml	19 Apr 2008 10:42:24 -0000
@@ -318,7 +318,7 @@
         Ports Collection's built-in search mechanism.  To use the
         search feature, you will need to be in the
         <filename>/usr/ports</filename> directory.  Once in that
-        directory, run <command>make search
+        directory, run <command>make <maketarget>search</maketarget>
         name=<replaceable>program-name</replaceable></command> where
         <replaceable>program-name</replaceable> is the name of the
         program you want to find.  For example, if you were looking
@@ -341,7 +341,8 @@
         will not be covered here.</para>
 
       <para>For more in-depth searching you can also use <command>make
-       search key=<replaceable>string</replaceable></command> where
+       <maketarget>search</maketarget>
+       key=<replaceable>string</replaceable></command> where
        <replaceable>string</replaceable> is some text to search for.
        This searches port names, comments, descriptions and
        dependencies and can be used to find ports which relate to a
@@ -946,7 +947,7 @@
 	  returned to your prompt.  The next step is to install the
 	  port.  In order to install it, you simply need to tack one word
 	  onto the <command>make</command> command, and that word is
-	  <command>install</command>:</para>
+	  <maketarget>install</maketarget>:</para>
 
         <screen>&prompt.root; <userinput>make install</userinput>
 ===>  Installing for lsof-4.57
@@ -981,9 +982,11 @@
 
         <note>
           <para>You can save two extra steps by just running <command>make
-	    install clean</command> instead of <command>make</command>,
-	    <command>make install</command> and <command>make clean</command>
-	    as three separate steps.</para>
+	    <maketarget>install clean</maketarget></command> instead of
+	    <command>make</command>, <command>make
+	    <maketarget>install</maketarget></command> and <command>make
+	    <maketarget>clean</maketarget></command> as three separate
+	    steps.</para>
 	</note>
 
 	<note>
@@ -1042,7 +1045,7 @@
 	<note><para>You can build all the ports in a category or as a
 	  whole by running <command>make</command> in the top level
 	  directory, just like the aforementioned <command>make
-	  <makevar>fetch</makevar></command> method.  This is
+	  <maketarget>fetch</maketarget></command> method.  This is
 	  dangerous, however, as some ports cannot co-exist.  In other
 	  cases, some ports can install two different files with the
 	  same filename.</para></note>
@@ -1128,15 +1131,15 @@
 	  It is not uncommon for users to wish to revisit this menu to add,
 	  remove, or change these options after a port has been built.  There
 	  are many ways to do this.  One option is to go into the directory
-	  containing the port and type <command>make</command>
-	  <maketarget>config</maketarget>, which will simply present the menu
-	  again with the same options selected.  Another option is to use
-	  <command>make</command> <maketarget>showconfig</maketarget> which
+	  containing the port and type <command>make
+	  <maketarget>config</maketarget></command>, which will simply present
+	  the menu again with the same options selected.  Another option is to
+	  use <command>make <maketarget>showconfig</maketarget></command> which
 	  will show you all the configuration options for the port.  Yet
-	  another option is to execute <command>make</command>
-	  <maketarget>rmconfig</maketarget> which will remove all selected
-	  options and allow you to start over.  All of these options, and
-	  others, are explained in great detail in in the man page for
+	  another option is to execute <command>make
+	  <maketarget>rmconfig</maketarget></command> which will remove all
+	  selected options and allow you to start over.  All of these options,
+	  and others, are explained in great detail in in the man page for
 	  &man.ports.7;.</para>
       </sect3>
     </sect2>
@@ -1200,8 +1203,8 @@
       <para>The <application>portupgrade</application> utility is designed
 	to easily upgrade installed ports.  It is available from the <filename
 	role="package">ports-mgmt/portupgrade</filename> port.  Install it like
-	any other port, using the <command>make <makevar>install
-	clean</makevar></command> command:</para>
+	any other port, using the <command>make <maketarget>install
+	clean</maketarget></command> command:</para>
 
       <screen>&prompt.root; <userinput>cd /usr/ports/ports-mgmt/portupgrade</userinput>
 &prompt.root; <userinput>make install clean</userinput></screen>
@@ -1267,9 +1270,9 @@
 	  confirmation of every step <application>Portmanager</application>
 	  will perform.  <application>Portmanager</application> can also be
 	  used to install new ports on the system.  Unlike the usual
-	  <command>make install clean</command> command, it will upgrade all
-	  the dependencies prior to building and installing the
-	  selected port.</para>
+	  <command>make <maketarget>install clean</maketarget></command> command,
+	  it will upgrade all the dependencies prior to building and installing
+	  the selected port.</para>
 
 	<screen>&prompt.root; <userinput>portmanager <replaceable>x11/gnome2</replaceable></userinput></screen>
 
@@ -1385,9 +1388,9 @@
       <para>Using the Ports Collection will use up disk
 	space over time.  After building and installing software from the
 	ports, you should always remember to clean up
-	the temporary <filename class="directory">work</filename> directories using the <command>make
-	<makevar>clean</makevar></command> command.  You can sweep the whole
-	Ports Collection with the following command:</para>
+	the temporary <filename class="directory">work</filename> directories using the
+	<command>make <maketarget>clean</maketarget></command> command.  You can sweep
+	the whole Ports Collection with the following command:</para>
 
       <screen>&prompt.root; <userinput>portsclean -C</userinput></screen>
 
@@ -1503,8 +1506,8 @@
 
 	<listitem>
 	  <para>Ask the maintainer of the port for help.  Type
-	    <command>make maintainer</command> or read the
-	    <filename>Makefile</filename> to find the maintainer's
+	    <command>make <maketarget>maintainer</maketarget></command>
+	    or read the <filename>Makefile</filename> to find the maintainer's
 	    email address.  Remember to include the name and version
 	    of the port (send the <literal>$FreeBSD:</literal>
 	    line from the <filename>Makefile</filename>) and the
--- ports.patch.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted:



More information about the freebsd-doc mailing list