doc-el commit 858:0bfc690621f5 - Introduce the new Handbook chap...

freebsd-doc-el at lists.hellug.gr freebsd-doc-el at lists.hellug.gr
Mon Oct 6 17:05:03 EEST 2008


changeset:      858:0bfc690621f5
user:           Manolis Kiagias <sonicy at otenet.gr>
date:           2008-10-04 15:47 +0300
details:        http://hg.hellug.gr/freebsd/doc-el/?cmd=changeset;node=0bfc690621f5

description:
	Introduce the new Handbook chapters into the Greek build

diffs (truncated from 1745 to 300 lines):

diff -r 1f072a4e9dda -r 0bfc690621f5 el_GR.ISO8859-7/books/handbook/Makefile
--- a/el_GR.ISO8859-7/books/handbook/Makefile	Sat Oct 04 05:06:35 2008 +0300
+++ b/el_GR.ISO8859-7/books/handbook/Makefile	Sat Oct 04 15:47:50 2008 +0300
@@ -4,7 +4,7 @@
 # Μορφοποίηση του Εγχειριδίου του FreeBSD
 #
 # %SOURCE%	en_US.ISO8859-1/books/handbook/Makefile
-# %SRCID%	1.109
+# %SRCID%	1.110
 #
 
 # ------------------------------------------------------------------------
@@ -202,6 +202,7 @@
 SRCS+= audit/chapter.sgml
 SRCS+= book.sgml
 SRCS+= colophon.sgml
+SRCS+= dtrace/chapter.sgml
 SRCS+= freebsd-glossary.sgml
 SRCS+= advanced-networking/chapter.sgml
 SRCS+= basics/chapter.sgml
@@ -213,6 +214,7 @@
 SRCS+= disks/chapter.sgml
 SRCS+= eresources/chapter.sgml
 SRCS+= firewalls/chapter.sgml
+SRCS+= filesystems/chapter.sgml
 SRCS+= geom/chapter.sgml
 SRCS+= install/chapter.sgml
 SRCS+= introduction/chapter.sgml
@@ -232,6 +234,7 @@
 SRCS+= printing/chapter.sgml
 SRCS+= security/chapter.sgml
 SRCS+= serialcomms/chapter.sgml
+SRCS+= updating/chapter.sgml
 SRCS+= users/chapter.sgml
 SRCS+= vinum/chapter.sgml
 SRCS+= virtualization/chapter.sgml
diff -r 1f072a4e9dda -r 0bfc690621f5 el_GR.ISO8859-7/books/handbook/book.sgml
--- a/el_GR.ISO8859-7/books/handbook/book.sgml	Sat Oct 04 05:06:35 2008 +0300
+++ b/el_GR.ISO8859-7/books/handbook/book.sgml	Sat Oct 04 15:47:50 2008 +0300
@@ -7,7 +7,7 @@
   $FreeBSD: doc/el_GR.ISO8859-7/books/handbook/book.sgml,v 1.5 2008/09/10 12:43:57 manolis Exp $
 
   %SOURCE%      en_US.ISO8859-1/books/handbook/book.sgml
-  %SRCID%       1.172
+  %SRCID%       1.173
 
 -->
 
@@ -291,10 +291,12 @@
     <![ %chap.audit;			[ &chap.audit;		      ]]>
     <![ %chap.disks;                    [ &chap.disks;                ]]>
     <![ %chap.geom;			[ &chap.geom;		      ]]>
+    <![ %chap.filesystems;		[ &chap.filesystems;	      ]]>
     <![ %chap.vinum;                    [ &chap.vinum;                ]]>
     <![ %chap.virtualization;           [ &chap.virtualization;       ]]>
     <![ %chap.l10n;                     [ &chap.l10n;                 ]]>
     <![ %chap.cutting-edge;             [ &chap.cutting-edge;         ]]>
+    <![ %chap.dtrace;			[ &chap.dtrace;		      ]]>
   </part>
 
   <part id="network-communication">
@@ -339,6 +341,7 @@
 	το &os;.</para>
     </partintro>
 
+    <![ %chap.updating;			[ &chap.updating;	      ]]>
     <![ %chap.serialcomms;              [ &chap.serialcomms;          ]]>
     <![ %chap.ppp-and-slip;             [ &chap.ppp-and-slip;         ]]>
     <![ %chap.mail;                     [ &chap.mail;                 ]]>
diff -r 1f072a4e9dda -r 0bfc690621f5 el_GR.ISO8859-7/books/handbook/chapters.ent
--- a/el_GR.ISO8859-7/books/handbook/chapters.ent	Sat Oct 04 05:06:35 2008 +0300
+++ b/el_GR.ISO8859-7/books/handbook/chapters.ent	Sat Oct 04 15:47:50 2008 +0300
@@ -12,7 +12,7 @@
      $FreeBSD: doc/el_GR.ISO8859-7/books/handbook/chapters.ent,v 1.3 2008/09/02 14:04:26 keramida Exp $
 
      %SOURCE%	en_US.ISO8859-1/books/handbook/chapters.ent
-     %SRCID%	1.37
+     %SRCID%	1.38
 
 -->
 
@@ -42,12 +42,15 @@
 <!ENTITY chap.audit			SYSTEM "audit/chapter.sgml">
 <!ENTITY chap.disks			SYSTEM "disks/chapter.sgml">
 <!ENTITY chap.geom			SYSTEM "geom/chapter.sgml">
+<!ENTITY chap.filesystems		SYSTEM "filesystems/chapter.sgml">
 <!ENTITY chap.vinum			SYSTEM "vinum/chapter.sgml">
 <!ENTITY chap.virtualization		SYSTEM "virtualization/chapter.sgml">
 <!ENTITY chap.l10n			SYSTEM "l10n/chapter.sgml">
 <!ENTITY chap.cutting-edge		SYSTEM "cutting-edge/chapter.sgml">
+<!ENTITY chap.dtrace			SYSTEM "dtrace/chapter.sgml">
 
 <!-- Part four -->
+<!ENTITY chap.updating			SYSTEM "updating/chapter.sgml">
 <!ENTITY chap.serialcomms		SYSTEM "serialcomms/chapter.sgml">
 <!ENTITY chap.ppp-and-slip		SYSTEM "ppp-and-slip/chapter.sgml">
 <!ENTITY chap.mail			SYSTEM "mail/chapter.sgml">
diff -r 1f072a4e9dda -r 0bfc690621f5 el_GR.ISO8859-7/books/handbook/dtrace/Makefile
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/el_GR.ISO8859-7/books/handbook/dtrace/Makefile	Sat Oct 04 15:47:50 2008 +0300
@@ -0,0 +1,18 @@
+#
+# Build the Handbook with just the content from this chapter.
+#
+# $FreeBSD$
+#
+# %SOURCE%	en_US.ISO8859-1/books/handbook/dtrace/Makefile
+# %SRCID%	1.1
+#
+
+CHAPTERS= 	dtrace/chapter.sgml
+
+VPATH=		..
+
+MASTERDOC=	${.CURDIR}/../${DOC}.${DOCBOOKSUFFIX}
+
+DOC_PREFIX?= 	${.CURDIR}/../../../..
+
+.include "../Makefile"
diff -r 1f072a4e9dda -r 0bfc690621f5 el_GR.ISO8859-7/books/handbook/dtrace/chapter.sgml
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/el_GR.ISO8859-7/books/handbook/dtrace/chapter.sgml	Sat Oct 04 15:47:50 2008 +0300
@@ -0,0 +1,390 @@
+<!--
+
+  Το Εγχειρίδιο του FreeBSD: DTrace
+
+  The FreeBSD Greek Documentation Project
+  $FreeBSD$
+
+  %SOURCE%	en_US.ISO8859-1/books/handbook/dtrace/chapter.sgml
+  %SRCID%	1.1
+
+-->
+
+<chapter id="dtrace">
+  <chapterinfo>
+    <authorgroup>
+      <author>
+	<firstname>Tom</firstname>
+	<surname>Rhodes</surname>
+	<contrib>Written by </contrib>
+      </author>
+    </authorgroup>
+  </chapterinfo>
+
+  <title>DTrace</title>
+
+  <para>DTrace, also known as Dynamic Tracing, was developed by
+    &sun; as a tool for locating performance bottlenecks
+    in production and pre-production systems.  It is not, in any way,
+    a debugging tool, but a tool for real time system analysis to
+    locate performance and other issues.</para>
+
+  <para>DTrace is a remarkable profiling tool, with an impressive
+    array of features for diagnosing system issues.  It may also be
+    used to run pre-written scripts to take advantage of its
+    capabilities.  Users may even author their own utilities using
+    the DTrace D Language, allowing them to customize their profiling
+    based on specific needs.</para>
+
+  <sect1 id="dtrace-synopsis">
+    <title>Synopsis</title>
+
+    <indexterm><primary>DTrace</primary></indexterm>
+    <indexterm>
+      <primary>DTrace support</primary>
+      <see>DTrace</see>
+    </indexterm>
+
+    <para>After reading this chapter, you will know:</para>
+
+    <itemizedlist>
+      <listitem>
+	<para>What DTrace is and what features it provides.</para>
+      </listitem>
+
+      <listitem>
+	<para>Differences between the &solaris; DTrace implementation
+	  and the one provided by &os;.</para>
+      </listitem>
+
+      <listitem>
+	<para>How to enable and use DTrace on &os;.</para>
+      </listitem>
+    </itemizedlist>
+
+    <para>Before reading this chapter, you should:</para>
+
+    <itemizedlist>
+      <listitem>
+	<para>Understand &unix; and &os; basics
+	  (<xref linkend="basics">).</para>
+      </listitem>
+
+      <listitem>
+	<para>Be familiar with
+	  the basics of kernel configuration/compilation
+	  (<xref linkend="kernelconfig">).</para>
+      </listitem>
+
+      <listitem>
+	<para>Have some familiarity with security and how it
+	  pertains to &os; (<xref linkend="security">).</para>
+      </listitem>
+
+      <listitem>
+	<para>Understand how to obtain and rebuild the &os; sources
+	  (<xref linkend="cutting-edge">).</para>
+      </listitem>
+    </itemizedlist>
+
+    <!--
+      Temporary warning to avoid listing experimental versions
+      and production versions of FreeBSD with this technology.
+    -->
+    <warning>
+      <para>This feature is considered experimental.  Some options
+	may be lacking in functionality, other parts may not work
+	at all.  In time, this feature will be considered production
+	ready and this documentation will be altered to fit that
+	situation.</para>
+    </warning>
+  </sect1>
+
+  <sect1 id="dtrace-implementation">
+    <title>Implementation Differences</title>
+
+    <para>While the DTrace in &os; is very similar to that found
+      in &solaris;, differences exist that should be explained before
+      continuing.  The primary difference users will notice is that
+      on &os;, DTrace needs to be specifically enabled.  There are
+      kernel options and modules which must be enabled for DTrace to
+      work properly.  These will be explained later.</para>
+
+    <para>There is a <literal>DDB_CTF</literal> kernel option which
+      is used to enable support for loading the <acronym>CTF</acronym>
+      data from kernel modules and the kernel itself.
+      <acronym>CTF</acronym> is the &solaris; Compressed C Type format
+      which encapsulates a reduced form of debugging information
+      similar to <acronym>DWARF</acronym> and the venerable stabs.
+      This <acronym>CTF</acronym> data is added to the binaries by the
+      <command>ctfconvert</command> and <command>ctfmerge</command>
+      build tools.  The <command>ctfconvert</command> utility parses
+      <acronym>DWARF</acronym> debug <acronym>ELF</acronym> sections
+      created by the compiler and <command>ctfmerge</command> merges
+      <acronym>CTF</acronym> <acronym>ELF</acronym> sections from
+      objects into either executables or shared libraries.  More on
+      how to enable this for the kernel and &os; build is
+      forthcoming.</para>
+
+    <para>Some different providers exist for &os; than for &solaris;.
+      Most notable is the <literal>dtmalloc</literal> provider, which
+      allows tracing <function>malloc()</function> by type in the
+      &os; kernel.</para>
+
+    <para>Only <username>root</username> may use DTrace on &os;.
+      This is related to security differences, &solaris; has a few
+      low level security checks which do not yet exist in &os;.  As
+      such, the <devicename>/dev/dtrace/dtrace</devicename> is strictly
+      limited to <username>root</username> users only.</para>
+
+    <para>Finally, the DTrace software falls under &sun;'s
+      <acronym>CDDL</acronym> license.  The <literal>Common Development
+      and Distribution License</literal> comes with &os;, see the
+      <filename>/usr/src/cddl/contrib/opensolaris/OPENSOLARIS.LICENSE</filename>
+      or view it online at
+      <ulink url="http://www.opensolaris.org/os/licensing">
+      http://www.opensolaris.org/os/licensing</ulink>.</para>
+
+    <para>This license means that a &os; kernel with the DTrace options
+      is still <acronym>BSD</acronym> licensed; however the
+      <acronym>CDDL</acronym> kicks in when the modules are distributed
+      in binary form, or the binaries are loaded.</para>
+  </sect1>
+
+  <sect1 id="dtrace-enable">
+    <title>Enabling DTrace Support</title>
+
+    <para>To enable support for DTrace, add the following lines to
+      the kernel configuration file:</para>
+
+    <programlisting>options         KDTRACE_HOOKS
+options         DDB_CTF</programlisting>
+
+    <note>
+      <para>Users of the AMD64 architecture will want to add the
+	following line to their kernel configuration file:</para>
+
+      <programlisting>options         KDTRACE_FRAME</programlisting>
+
+      <para>This option provides support for the <acronym>FBT</acronym>
+	feature.  DTrace will work without this option; however, there
+	will be limited support for function boundary tracing.</para>
+      </note>
+
+    <para>All sources must be rebuilt and installed with CTF options.
+      To accomplish this task, rebuild the &os; sources using:</para>
+
+    <screen>&prompt.root; <userinput>cd /usr/src</userinput>




More information about the Freebsd-doc-el mailing list