[RFC] Q&A propose to add into FAQ

Edward edward at rdtan.net
Thu Jan 3 18:03:03 UTC 2013


On 12/19/12 11:55 PM, Eitan Adler wrote:
> I've made more content and editorial changes and turned this into
> docbook markup (like HTML).
> 
> Please comment a bit more on this.  In particular the answer for
> finding bottlenecks needs more content:
> just knowing which utilities isn't enough, we also need some content
> on what to look for.

Hi Eitan,

My bad on this late reply. Attached is a diff for some changes made.
I've put tags "<!-- -->" around my comments to reflect the changes that
I've made, in the diff.

Please do let me know if further content add/change needed.

There are a few Q&A excluded in this formatting, can I assume that
there's more changes needed to work on it before it can be included?

Regards,
Edward.
-------------- next part --------------
--- lots-more-faq.diff	2012-12-20 00:00:00.000000000 +0800
+++ edited-lots-more-faq.diff	2013-01-04 01:50:36.000000000 +0800
@@ -102,7 +102,8 @@
 +	  <para>In short, tune <varname>net.inet.tcp.msl</varname> to
 +	    a lower value such as 7500:</para>
 +
-+	  <para>In more detail, the the default timeout value for
+	  <!-- extra word, "the" -->
++	  <para>In more detail, the default timeout value for
 +	    <literal>TIME_WAIT</literal> is 60 seconds.  This value is
 +	    based on RFC 793.  A busy server opening and closing
 +	    TCP connections should set this value to a shorter time,
@@ -140,21 +141,32 @@
 +
 +      <qandaentry>
 +	<question id="server-is-slow">
-+	  <para>My server performance seems to be slow. How can I find
-+	    out what the bottleneck is?</para>
+	  <!-- including suggestion from Derek Wood, dated 22/12/2012 -->
++	  <para>My server performance seems to be slow. I suspect it has 
+			something to do with CPU/network/harddisk/memory. How can
+			I find out what the bottleneck is?</para>
 +	</question>
 +
 +	<answer>
 +	  <!-- this needs to be completed -->
 +	  <para>Use &man.iostat.8; or &man.systat.1;.</para>
 +
-+	  <para>For example, to see deviice statistics
++	  <para>For example, to see device statistics
 +	    refreshing the output every 2 second try:</para>
 +
 +	  <screen>&prompt.user; <userinput>iostat -dw2</userinput></screen>
 +
-+	  <para>Another interactive tool &man.systat.1;
-+	    ......????</para>
++	  <para>&man.systat.1; is an interactive system statistics tool.
+			It's keyboard operation is similar to "vim" editor. For
+			example, to monitor network interface traffic:</para>
+			
+	  <screen>&prompt.user; <userinput>systat -ifstat</userinput></screen>
+
+	  <para>In order to display memory related statistics, try this:</para>
+
+	  <screen>&prompt.user; <userinput>systat -vmstat</userinput></screen>
+	
+	  <para>Check out &man.systat.1; for more info.</para>
 +	</answer>
 +      </qandaentry>
      </qandaset>
@@ -259,7 +271,9 @@
 +	    processing. Otherwise, it is likely to be a 32 bit
 +	    processor.</para>
 +
-+	  <para>An example 64 bit processor looks like:</para>
+	  <!-- a slight change of wording to sound more "friendly". Not too sure if this is appropriate -->
++	  <para>This is an example of how a 64 bit processor capabilities
+			looks like:</para>
 +
 +	  <programlisting>AMD Features=0x28100000<NX,RDTSCP,LM></programlisting>
 +	</answer>
@@ -287,10 +301,10 @@
 +++ b/en_US.ISO8859-1/books/faq/book.xml
 @@ -579,6 +579,21 @@
        </qandaentry>
- 
+	  <!-- remove extra white line -->
        <qandaentry>
 +	<question id="get-ancient-versions">
-+	  <para>I have some software which only works on old versions
++	  <para>I have some software which only works on older versions
 +	    of &os;, where can I get these?</para>
 +	</question>
 +
@@ -334,12 +348,13 @@
 +	    find them?</para>
 +	</question>
 +
+	<!-- slight change of wording to sound more "friendly". Not too sure if this is appropriate -->
 +	<answer>
 +	  <para>Kernel log messages are recorded in
 +	    <filename>/var/log/messages</filename>,
 +	    <filename>/var/log/dmesg.yesterday</filename>, and
 +	    <filename>/var/log/dmesg.today</filename>.  Boot time
-+	    messages are recorded in
++	    messages are also recorded in
 +	    <filename>/var/run/dmesg.boot</filename>.
 +	  </para>
 +	</answer>


More information about the freebsd-doc mailing list