Bug 125346

Summary:

[patch] updates to developers handbook: tools section

Product:

Documentation

Reporter:

Gavin Atkinson <gavin>

Component:

Books & Articles

Assignee:

Gabor Pali <pgj>

Status:

Closed FIXED

Severity:

Affects Only Me

Priority:

Normal

Version:

Latest

Hardware:

Any

OS:

Any

Attachments:

Description	Flags
devh-tools.diff	none

Description Gavin Atkinson freebsd_committer

2008-07-06 21:40:01 UTC

	Updates to the tools section of the developers-handbook.
- Change "most" to "many" wrt people who run gdb inside emacs.  I
suspect "most" people don't usually run gdb inside emacs, but even
if they do, "many" is no less true.
- use role="package" for two ports mentioned.
- reword a paragraph that is either confusing, or plain wrong.
- Change a mention of 2.1.0-RELEASE to 7.0, where is is still valid

How-To-Repeat: 	N/A

Comment 1 Gabor Pali freebsd_committer

2008-07-06 22:50:00 UTC

Responsible Changed
From-To: freebsd-doc->pgj

I will take it.

Comment 2 Gavin Atkinson freebsd_committer

2008-07-06 22:50:26 UTC

Updated patch, including corrections requested by pgj and gabor:

- use role="port" rather than role="package" throughout the document, 
where it's not specifically referring to the package.

- Capitalise Ports Collection.


Index: doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml
===================================================================
RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml,v
retrieving revision 1.48
diff -u -r1.48 chapter.sgml
--- doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml	3 Feb 2008 18:26:28 -0000	1.48
+++ doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml	6 Jul 2008 21:43:01 -0000
@@ -138,10 +138,10 @@

  	    <para>The Bywater Basic Interpreter can be found in the
  	      Ports Collection as
-	      <filename role="package">lang/bwbasic</filename>
+	      <filename role="port">lang/bwbasic</filename>
  	      and the Phil Cockroft's Basic Interpreter
  	      (formerly Rabbit Basic) is available as
-	      <filename role="package">lang/pbasic</filename>.</para>
+	      <filename role="port">lang/pbasic</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -163,14 +163,14 @@
  	    <para>Various implementations of Lisp that can run on &unix;
  	      systems are available in the Ports Collection for &os;.
  	      GNU Common Lisp can be found as
-	      <filename role="package">lang/gcl</filename>.  CLISP
+	      <filename role="port">lang/gcl</filename>.  CLISP
  	      by Bruno Haible and Michael Stoll is available as
-	      <filename role="package">lang/clisp</filename>.
+	      <filename role="port">lang/clisp</filename>.
  	      For CMUCL, which includes a highly-optimizing compiler too, or
  	      simpler Lisp implementations like SLisp, which implements most
  	      of the Common Lisp constructs in a few hundred lines of C code,
-	      <filename role="package">lang/cmucl</filename> and
-	      <filename role="package">lang/slisp</filename> are available
+	      <filename role="port">lang/cmucl</filename> and
+	      <filename role="port">lang/slisp</filename> are available
  	      respectively.</para>
  	  </listitem>
  	</varlistentry>
@@ -184,7 +184,7 @@
  	      writing <acronym>CGI</acronym> scripts.</para>

  	    <para>Perl is available in the Ports Collection as 
-	      <filename role="package">lang/perl5</filename> for all
+	      <filename role="port">lang/perl5</filename> for all
  	      &os; releases, and is installed as <command>/usr/bin/perl</command>
  	      in the base system 4.X releases.</para>
  	  </listitem>
@@ -201,12 +201,12 @@
  	      abstraction to be used in research work.</para>

  	    <para>Scheme is available from the Ports Collection as
-	      <filename role="package">lang/elk</filename> for the
+	      <filename role="port">lang/elk</filename> for the
  		Elk Scheme Interpreter.  The MIT Scheme Interpreter
  		can be found in
-		<filename role="package">lang/mit-scheme</filename>
+		<filename role="port">lang/mit-scheme</filename>
  		and the SCM Scheme Interpreter in
-		<filename role="package">lang/scm</filename>.</para>
+		<filename role="port">lang/scm</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -218,7 +218,7 @@
  	      facilities for processing strings and structures.
  	      The version of Icon for &os; can be found in the
  	      Ports Collection as
-	      <filename role="package">lang/icon</filename>.</para>
+	      <filename role="port">lang/icon</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -235,7 +235,7 @@

  	    <para>The latest version of Logo for &os; is available from
  	      the Ports Collection in
-	      <filename role="package">lang/logo</filename>.</para>
+	      <filename role="port">lang/logo</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -253,7 +253,7 @@

  	    <para>The latest version of Python is available from the
  	      Ports Collection in
-	      <filename role="package">lang/python</filename>.</para>
+	      <filename role="port">lang/python</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -268,7 +268,7 @@
  	      programs.</para>

  	    <para>Ruby is available from the Ports Collection as
-	      <filename role="package">lang/ruby18</filename>.</para> 
+	      <filename role="port">lang/ruby18</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -285,7 +285,7 @@

  	    <para>Various versions of Tcl are available as ports
  	      for &os;.  The latest version, Tcl 8.4, can be found in
-	      <filename role="package">lang/tcl84</filename>.</para>
+	      <filename role="port">lang/tcl84</filename>.</para>
  	  </listitem>
  	</varlistentry>
        </variablelist>
@@ -327,16 +327,16 @@
  	language to start with.  FreeBSD does not include Pascal
  	support in the base system, but both GNU Pascal Compiler (GPC)
  	and the Free Pascal Compiler
-	are available in the ports collection as
-	<filename role="package">lang/gpc</filename> and
-	<filename role="package">lang/fpc</filename>.</para>
+	are available in the Ports Collection as
+	<filename role="port">lang/gpc</filename> and
+	<filename role="port">lang/fpc</filename>.</para>

        <para>As the edit-compile-run-debug cycle is rather tedious when
  	using separate programs, many commercial compiler makers have
  	produced Integrated Development Environments
  	(<acronym>IDE</acronym>s for short).  FreeBSD does not include
-	an IDE in the base system, but <filename role="package">devel/kdevelop</filename> is
-	available in the ports tree and many use
+	an IDE in the base system, but <filename role="port">devel/kdevelop</filename> is
+	available in the Ports Collection and many use
  	<application>Emacs</application> for this purpose.  Using
  	<application>Emacs</application> as an IDE is discussed in
  	<xref linkend="emacs">.</para>
@@ -1410,7 +1410,7 @@

        <screen>&prompt.user; <userinput>gdb <replaceable>progname</replaceable></userinput></screen>

-      <para>although most people prefer to run it inside
+      <para>although many people prefer to run it inside
  	<application>Emacs</application>.  You can do this by:</para>

        <screen><userinput>M-x gdb RET <replaceable>progname</replaceable> RET</userinput></screen>
@@ -1430,9 +1430,9 @@
  	on a few of the basic commands.</para>

        <para>Finally, if you find its text-based command-prompt style
-	off-putting, there is a graphical front-end for it (<ulink
-	  url="&url.base;/ports/devel.html">xxgdb</ulink>) in the ports
-	collection.</para>
+	off-putting, there is a graphical front-end for it
+	(<filename role="port">devel/xxgdb</filename>) in the Ports
+	Collection.</para>

        <para>This section is intended to be an introduction to using
  	<command>gdb</command> and does not cover specialized topics
@@ -1456,8 +1456,9 @@

        <para>At the <command>gdb</command> prompt, type
  	<userinput>break main</userinput>.  This will tell the
-	debugger to skip over the preliminary set-up code in the
-	program and start at the beginning of your code.  Now type
+	debugger that you are not interested in watching the
+	preliminary set-up code in the program being run, and that it
+	should stop executing at the beginning of your code.  Now type
  	<userinput>run</userinput> to start the program&mdash;it will
  	start at the beginning of the set-up code and then get stopped
  	by the debugger when it calls <function>main()</function>.
@@ -1681,7 +1682,7 @@

  	<footnote>
  	  <para>Some powerful, free IDEs now exist, such as KDevelop
-	    in the ports collection.</para>
+	    in the Ports Collection.</para>
  	</footnote>

  	However, it is possible to set up your own environment.  It
@@ -1757,9 +1758,9 @@

        <para>And doubtless many more that I have overlooked.</para>

-      <para>Emacs can be installed on FreeBSD using <ulink
-	  url="&url.base;/ports/editors.html">the Emacs
-	  port</ulink>.</para>
+      <para>Emacs can be installed on FreeBSD using
+	the <filename role="port">editors/emacs</filename>
+	port.</para>

        <para>Once it is installed, start it up and do <userinput>C-h
  	  t</userinput> to read an Emacs tutorial&mdash;that means
@@ -2234,7 +2235,7 @@
        <screen>&prompt.user; <userinput>find /usr/ports/lang/whizbang -name "*.el" -print</userinput></screen>

        <para>and install them by copying them into the Emacs site Lisp
-	directory.  On FreeBSD 2.1.0-RELEASE, this is
+	directory.  On FreeBSD 7.0-RELEASE, this is
  	<filename>/usr/local/share/emacs/site-lisp</filename>.</para>

        <para>So for example, if the output from the find command

Comment 3 Daniel Gerzo freebsd_committer

2008-07-07 00:20:05 UTC

Hello,

+      <para>Emacs can be installed on FreeBSD using
+        the <filename role="port">editors/emacs</filename>
+        port.</para>

use &os; here please.

-- 
Best regards,
 Daniel                          mailto:danger@FreeBSD.org

Comment 4 Gavin Atkinson freebsd_committer

2008-07-08 16:35:37 UTC

Patch updated to change FreeBSD -> &os; in the two lines already being 
touched by other changes, as requested by danger@


Index: doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml
===================================================================
RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml,v
retrieving revision 1.48
diff -u -r1.48 chapter.sgml
--- doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml	3 Feb 2008 18:26:28 -0000	1.48
+++ doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml	10 Jul 2008 16:31:20 -0000
@@ -138,10 +138,10 @@

  	    <para>The Bywater Basic Interpreter can be found in the
  	      Ports Collection as
-	      <filename role="package">lang/bwbasic</filename>
+	      <filename role="port">lang/bwbasic</filename>
  	      and the Phil Cockroft's Basic Interpreter
  	      (formerly Rabbit Basic) is available as
-	      <filename role="package">lang/pbasic</filename>.</para>
+	      <filename role="port">lang/pbasic</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -163,14 +163,14 @@
  	    <para>Various implementations of Lisp that can run on &unix;
  	      systems are available in the Ports Collection for &os;.
  	      GNU Common Lisp can be found as
-	      <filename role="package">lang/gcl</filename>.  CLISP
+	      <filename role="port">lang/gcl</filename>.  CLISP
  	      by Bruno Haible and Michael Stoll is available as
-	      <filename role="package">lang/clisp</filename>.
+	      <filename role="port">lang/clisp</filename>.
  	      For CMUCL, which includes a highly-optimizing compiler too, or
  	      simpler Lisp implementations like SLisp, which implements most
  	      of the Common Lisp constructs in a few hundred lines of C code,
-	      <filename role="package">lang/cmucl</filename> and
-	      <filename role="package">lang/slisp</filename> are available
+	      <filename role="port">lang/cmucl</filename> and
+	      <filename role="port">lang/slisp</filename> are available
  	      respectively.</para>
  	  </listitem>
  	</varlistentry>
@@ -184,7 +184,7 @@
  	      writing <acronym>CGI</acronym> scripts.</para>

  	    <para>Perl is available in the Ports Collection as 
-	      <filename role="package">lang/perl5</filename> for all
+	      <filename role="port">lang/perl5</filename> for all
  	      &os; releases, and is installed as <command>/usr/bin/perl</command>
  	      in the base system 4.X releases.</para>
  	  </listitem>
@@ -201,12 +201,12 @@
  	      abstraction to be used in research work.</para>

  	    <para>Scheme is available from the Ports Collection as
-	      <filename role="package">lang/elk</filename> for the
+	      <filename role="port">lang/elk</filename> for the
  		Elk Scheme Interpreter.  The MIT Scheme Interpreter
  		can be found in
-		<filename role="package">lang/mit-scheme</filename>
+		<filename role="port">lang/mit-scheme</filename>
  		and the SCM Scheme Interpreter in
-		<filename role="package">lang/scm</filename>.</para>
+		<filename role="port">lang/scm</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -218,7 +218,7 @@
  	      facilities for processing strings and structures.
  	      The version of Icon for &os; can be found in the
  	      Ports Collection as
-	      <filename role="package">lang/icon</filename>.</para>
+	      <filename role="port">lang/icon</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -235,7 +235,7 @@

  	    <para>The latest version of Logo for &os; is available from
  	      the Ports Collection in
-	      <filename role="package">lang/logo</filename>.</para>
+	      <filename role="port">lang/logo</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -253,7 +253,7 @@

  	    <para>The latest version of Python is available from the
  	      Ports Collection in
-	      <filename role="package">lang/python</filename>.</para>
+	      <filename role="port">lang/python</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -268,7 +268,7 @@
  	      programs.</para>

  	    <para>Ruby is available from the Ports Collection as
-	      <filename role="package">lang/ruby18</filename>.</para> 
+	      <filename role="port">lang/ruby18</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -285,7 +285,7 @@

  	    <para>Various versions of Tcl are available as ports
  	      for &os;.  The latest version, Tcl 8.4, can be found in
-	      <filename role="package">lang/tcl84</filename>.</para>
+	      <filename role="port">lang/tcl84</filename>.</para>
  	  </listitem>
  	</varlistentry>
        </variablelist>
@@ -327,16 +327,16 @@
  	language to start with.  FreeBSD does not include Pascal
  	support in the base system, but both GNU Pascal Compiler (GPC)
  	and the Free Pascal Compiler
-	are available in the ports collection as
-	<filename role="package">lang/gpc</filename> and
-	<filename role="package">lang/fpc</filename>.</para>
+	are available in the Ports Collection as
+	<filename role="port">lang/gpc</filename> and
+	<filename role="port">lang/fpc</filename>.</para>

        <para>As the edit-compile-run-debug cycle is rather tedious when
  	using separate programs, many commercial compiler makers have
  	produced Integrated Development Environments
  	(<acronym>IDE</acronym>s for short).  FreeBSD does not include
-	an IDE in the base system, but <filename role="package">devel/kdevelop</filename> is
-	available in the ports tree and many use
+	an IDE in the base system, but <filename role="port">devel/kdevelop</filename> is
+	available in the Ports Collection and many use
  	<application>Emacs</application> for this purpose.  Using
  	<application>Emacs</application> as an IDE is discussed in
  	<xref linkend="emacs">.</para>
@@ -1410,7 +1410,7 @@

        <screen>&prompt.user; <userinput>gdb <replaceable>progname</replaceable></userinput></screen>

-      <para>although most people prefer to run it inside
+      <para>although many people prefer to run it inside
  	<application>Emacs</application>.  You can do this by:</para>

        <screen><userinput>M-x gdb RET <replaceable>progname</replaceable> RET</userinput></screen>
@@ -1430,9 +1430,9 @@
  	on a few of the basic commands.</para>

        <para>Finally, if you find its text-based command-prompt style
-	off-putting, there is a graphical front-end for it (<ulink
-	  url="&url.base;/ports/devel.html">xxgdb</ulink>) in the ports
-	collection.</para>
+	off-putting, there is a graphical front-end for it
+	(<filename role="port">devel/xxgdb</filename>) in the Ports
+	Collection.</para>

        <para>This section is intended to be an introduction to using
  	<command>gdb</command> and does not cover specialized topics
@@ -1456,8 +1456,9 @@

        <para>At the <command>gdb</command> prompt, type
  	<userinput>break main</userinput>.  This will tell the
-	debugger to skip over the preliminary set-up code in the
-	program and start at the beginning of your code.  Now type
+	debugger that you are not interested in watching the
+	preliminary set-up code in the program being run, and that it
+	should stop executing at the beginning of your code.  Now type
  	<userinput>run</userinput> to start the program&mdash;it will
  	start at the beginning of the set-up code and then get stopped
  	by the debugger when it calls <function>main()</function>.
@@ -1681,7 +1682,7 @@

  	<footnote>
  	  <para>Some powerful, free IDEs now exist, such as KDevelop
-	    in the ports collection.</para>
+	    in the Ports Collection.</para>
  	</footnote>

  	However, it is possible to set up your own environment.  It
@@ -1757,9 +1758,9 @@

        <para>And doubtless many more that I have overlooked.</para>

-      <para>Emacs can be installed on FreeBSD using <ulink
-	  url="&url.base;/ports/editors.html">the Emacs
-	  port</ulink>.</para>
+      <para>Emacs can be installed on &os; using
+	the <filename role="port">editors/emacs</filename>
+	port.</para>

        <para>Once it is installed, start it up and do <userinput>C-h
  	  t</userinput> to read an Emacs tutorial&mdash;that means
@@ -2234,7 +2235,7 @@
        <screen>&prompt.user; <userinput>find /usr/ports/lang/whizbang -name "*.el" -print</userinput></screen>

        <para>and install them by copying them into the Emacs site Lisp
-	directory.  On FreeBSD 2.1.0-RELEASE, this is
+	directory.  On &os;, this is
  	<filename>/usr/local/share/emacs/site-lisp</filename>.</para>

        <para>So for example, if the output from the find command

Comment 5 Gabor Pali freebsd_committer

2008-07-19 06:46:39 UTC

I grabbed some suggestions from other people meanwhile:

"should stop executing at the beginning of your code."
-->
"should stop execuTION at the beginning of your code."


"<para>Emacs can be installed on FreeBSD using the <filename
role="port">editors/emacs</filename> port.</para>"
-->
"The <filename role="package">editors/emacs</filename> may then be
installed using the port."

Comment 6 Gavin Atkinson 2008-07-21 22:13:16 UTC

I've updated the patch to include the executing->execution change, which I 
agree with.  I have considered, but not made the second change, as it 
doesn't make sense to me in the wider context of the article - there are 
around 20 sentences in the section that start with the word "Emacs", and 
this is one of the ones towards the end.  If they should all be changed so 
that none of the paragraphs should start with "Emacs" then I'll submit a 
patch fixing up the whole subsection separately.



Index: doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml
===================================================================
RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml,v
retrieving revision 1.48
diff -u -r1.48 chapter.sgml
--- doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml	3 Feb 2008 18:26:28 -0000	1.48
+++ doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml	21 Jul 2008 19:55:52 -0000
@@ -138,10 +138,10 @@

  	    <para>The Bywater Basic Interpreter can be found in the
  	      Ports Collection as
-	      <filename role="package">lang/bwbasic</filename>
+	      <filename role="port">lang/bwbasic</filename>
  	      and the Phil Cockroft's Basic Interpreter
  	      (formerly Rabbit Basic) is available as
-	      <filename role="package">lang/pbasic</filename>.</para>
+	      <filename role="port">lang/pbasic</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -163,14 +163,14 @@
  	    <para>Various implementations of Lisp that can run on &unix;
  	      systems are available in the Ports Collection for &os;.
  	      GNU Common Lisp can be found as
-	      <filename role="package">lang/gcl</filename>.  CLISP
+	      <filename role="port">lang/gcl</filename>.  CLISP
  	      by Bruno Haible and Michael Stoll is available as
-	      <filename role="package">lang/clisp</filename>.
+	      <filename role="port">lang/clisp</filename>.
  	      For CMUCL, which includes a highly-optimizing compiler too, or
  	      simpler Lisp implementations like SLisp, which implements most
  	      of the Common Lisp constructs in a few hundred lines of C code,
-	      <filename role="package">lang/cmucl</filename> and
-	      <filename role="package">lang/slisp</filename> are available
+	      <filename role="port">lang/cmucl</filename> and
+	      <filename role="port">lang/slisp</filename> are available
  	      respectively.</para>
  	  </listitem>
  	</varlistentry>
@@ -184,7 +184,7 @@
  	      writing <acronym>CGI</acronym> scripts.</para>

  	    <para>Perl is available in the Ports Collection as 
-	      <filename role="package">lang/perl5</filename> for all
+	      <filename role="port">lang/perl5</filename> for all
  	      &os; releases, and is installed as <command>/usr/bin/perl</command>
  	      in the base system 4.X releases.</para>
  	  </listitem>
@@ -201,12 +201,12 @@
  	      abstraction to be used in research work.</para>

  	    <para>Scheme is available from the Ports Collection as
-	      <filename role="package">lang/elk</filename> for the
+	      <filename role="port">lang/elk</filename> for the
  		Elk Scheme Interpreter.  The MIT Scheme Interpreter
  		can be found in
-		<filename role="package">lang/mit-scheme</filename>
+		<filename role="port">lang/mit-scheme</filename>
  		and the SCM Scheme Interpreter in
-		<filename role="package">lang/scm</filename>.</para>
+		<filename role="port">lang/scm</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -218,7 +218,7 @@
  	      facilities for processing strings and structures.
  	      The version of Icon for &os; can be found in the
  	      Ports Collection as
-	      <filename role="package">lang/icon</filename>.</para>
+	      <filename role="port">lang/icon</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -235,7 +235,7 @@

  	    <para>The latest version of Logo for &os; is available from
  	      the Ports Collection in
-	      <filename role="package">lang/logo</filename>.</para>
+	      <filename role="port">lang/logo</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -253,7 +253,7 @@

  	    <para>The latest version of Python is available from the
  	      Ports Collection in
-	      <filename role="package">lang/python</filename>.</para>
+	      <filename role="port">lang/python</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -268,7 +268,7 @@
  	      programs.</para>

  	    <para>Ruby is available from the Ports Collection as
-	      <filename role="package">lang/ruby18</filename>.</para> 
+	      <filename role="port">lang/ruby18</filename>.</para>
  	  </listitem>
  	</varlistentry>

@@ -285,7 +285,7 @@

  	    <para>Various versions of Tcl are available as ports
  	      for &os;.  The latest version, Tcl 8.4, can be found in
-	      <filename role="package">lang/tcl84</filename>.</para>
+	      <filename role="port">lang/tcl84</filename>.</para>
  	  </listitem>
  	</varlistentry>
        </variablelist>
@@ -327,16 +327,16 @@
  	language to start with.  FreeBSD does not include Pascal
  	support in the base system, but both GNU Pascal Compiler (GPC)
  	and the Free Pascal Compiler
-	are available in the ports collection as
-	<filename role="package">lang/gpc</filename> and
-	<filename role="package">lang/fpc</filename>.</para>
+	are available in the Ports Collection as
+	<filename role="port">lang/gpc</filename> and
+	<filename role="port">lang/fpc</filename>.</para>

        <para>As the edit-compile-run-debug cycle is rather tedious when
  	using separate programs, many commercial compiler makers have
  	produced Integrated Development Environments
  	(<acronym>IDE</acronym>s for short).  FreeBSD does not include
-	an IDE in the base system, but <filename role="package">devel/kdevelop</filename> is
-	available in the ports tree and many use
+	an IDE in the base system, but <filename role="port">devel/kdevelop</filename> is
+	available in the Ports Collection and many use
  	<application>Emacs</application> for this purpose.  Using
  	<application>Emacs</application> as an IDE is discussed in
  	<xref linkend="emacs">.</para>
@@ -1410,7 +1410,7 @@

        <screen>&prompt.user; <userinput>gdb <replaceable>progname</replaceable></userinput></screen>

-      <para>although most people prefer to run it inside
+      <para>although many people prefer to run it inside
  	<application>Emacs</application>.  You can do this by:</para>

        <screen><userinput>M-x gdb RET <replaceable>progname</replaceable> RET</userinput></screen>
@@ -1430,9 +1430,9 @@
  	on a few of the basic commands.</para>

        <para>Finally, if you find its text-based command-prompt style
-	off-putting, there is a graphical front-end for it (<ulink
-	  url="&url.base;/ports/devel.html">xxgdb</ulink>) in the ports
-	collection.</para>
+	off-putting, there is a graphical front-end for it
+	(<filename role="port">devel/xxgdb</filename>) in the Ports
+	Collection.</para>

        <para>This section is intended to be an introduction to using
  	<command>gdb</command> and does not cover specialized topics
@@ -1456,8 +1456,9 @@

        <para>At the <command>gdb</command> prompt, type
  	<userinput>break main</userinput>.  This will tell the
-	debugger to skip over the preliminary set-up code in the
-	program and start at the beginning of your code.  Now type
+	debugger that you are not interested in watching the
+	preliminary set-up code in the program being run, and that it
+	should stop execution at the beginning of your code.  Now type
  	<userinput>run</userinput> to start the program&mdash;it will
  	start at the beginning of the set-up code and then get stopped
  	by the debugger when it calls <function>main()</function>.
@@ -1681,7 +1682,7 @@

  	<footnote>
  	  <para>Some powerful, free IDEs now exist, such as KDevelop
-	    in the ports collection.</para>
+	    in the Ports Collection.</para>
  	</footnote>

  	However, it is possible to set up your own environment.  It
@@ -1757,9 +1758,9 @@

        <para>And doubtless many more that I have overlooked.</para>

-      <para>Emacs can be installed on FreeBSD using <ulink
-	  url="&url.base;/ports/editors.html">the Emacs
-	  port</ulink>.</para>
+      <para>Emacs can be installed on &os; using
+	the <filename role="port">editors/emacs</filename>
+	port.</para>

        <para>Once it is installed, start it up and do <userinput>C-h
  	  t</userinput> to read an Emacs tutorial&mdash;that means
@@ -2234,7 +2235,7 @@
        <screen>&prompt.user; <userinput>find /usr/ports/lang/whizbang -name "*.el" -print</userinput></screen>

        <para>and install them by copying them into the Emacs site Lisp
-	directory.  On FreeBSD 2.1.0-RELEASE, this is
+	directory.  On &os;, this is
  	<filename>/usr/local/share/emacs/site-lisp</filename>.</para>

        <para>So for example, if the output from the find command

Comment 7 Gabor Pali freebsd_committer

2008-07-21 23:17:50 UTC

Gavin Atkinson wrote:
>  I've updated the patch to include the executing->execution change, which I 
>  agree with.  I have considered, but not made the second change, as it 
>  doesn't make sense to me in the wider context of the article - there are 
>  around 20 sentences in the section that start with the word "Emacs", and 
>  this is one of the ones towards the end.  If they should all be changed so 
>  that none of the paragraphs should start with "Emacs" then I'll submit a 
>  patch fixing up the whole subsection separately.

I think it is all right.  If there are no more objections, I ask for the
 necessary approval required for this and I will commit the patch.
Thank you for your hard work! ;)

Comment 8 Tom Rhodes freebsd_committer

2008-07-22 14:34:49 UTC

On Tue, 22 Jul 2008 00:17:50 +0200
Gabor PALI <pgj@FreeBSD.org> wrote:

> Gavin Atkinson wrote:
> >  I've updated the patch to include the executing->execution change, which I 
> >  agree with.  I have considered, but not made the second change, as it 
> >  doesn't make sense to me in the wider context of the article - there are 
> >  around 20 sentences in the section that start with the word "Emacs", and 
> >  this is one of the ones towards the end.  If they should all be changed so 
> >  that none of the paragraphs should start with "Emacs" then I'll submit a 
> >  patch fixing up the whole subsection separately.
> 
> I think it is all right.  If there are no more objections, I ask for the
>  necessary approval required for this and I will commit the patch.
> Thank you for your hard work! ;)
> 
> 

Go!

-- 
Tom Rhodes

Comment 9 dfilter service freebsd_committer

2008-07-23 21:40:03 UTC

pgj         2008-07-23 20:39:55 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/developers-handbook/tools chapter.sgml 
  Log:
  - Update to the tools section of the developers-handbook
  
  PR:             docs/125346
  Submitted by:   gavin
  Reviewed by:    danger, trhodes, Ben Kaduk <minimarmot (at) gmail (dot) com>
  Approved by:    trhodes
  
  Revision  Changes    Path
  1.49      +32 -31    doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"

Comment 10 Gabor Pali freebsd_committer

2008-07-23 22:01:38 UTC

State Changed
From-To: open->closed

Committed.  Thank you for your submission.