docs/125346: [patch] updates to developers handbook: tools section

Gavin Atkinson gavin at FreeBSD.org
Sun Jul 6 20:40:01 UTC 2008


>Number:         125346
>Category:       docs
>Synopsis:       [patch] updates to developers handbook: tools section
>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:   Sun Jul 06 20:40:01 UTC 2008
>Closed-Date:
>Last-Modified:
>Originator:     Gavin Atkinson
>Release:        FreeBSD 7.0-STABLE amd64
>Organization:
>Environment:
System: FreeBSD buffy.york.ac.uk 7.0-STABLE FreeBSD 7.0-STABLE #3: Fri Jun 20 09:21:51 UTC 2008 root at buffy.york.ac.uk:/usr/obj/usr/src/sys/GENERIC amd64

>Description:
	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
>Fix:

	

--- devh-tools.diff begins here ---
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 18:25:17 -0000
@@ -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,8 +1430,8 @@
 	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
+	off-putting, there is a graphical front-end for it
+	(<filename role="package">devel/xxgdb</filename>) in the ports
 	collection.</para>
 
       <para>This section is intended to be an introduction to using
@@ -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—it will
 	start at the beginning of the set-up code and then get stopped
 	by the debugger when it calls <function>main()</function>.
@@ -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="package">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—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
--- devh-tools.diff ends here ---


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



More information about the freebsd-doc mailing list