Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 7 Mar 2014 14:27:09 -0800 (PST)
From:      Dru Lavigne <dru.lavigne@att.net>
To:        Remko Lodder <remko@FreeBSD.org>
Cc:        "svn-doc-head@freebsd.org" <svn-doc-head@freebsd.org>, "svn-doc-all@freebsd.org" <svn-doc-all@freebsd.org>, "doc-committers@freebsd.org" <doc-committers@freebsd.org>
Subject:   Re: svn commit: r44176 - head/en_US.ISO8859-1/books/handbook/advanced-networking
Message-ID:  <1394231229.8505.YahooMailNeo@web184906.mail.gq1.yahoo.com>
In-Reply-To: <22293A4C-0F7F-45E9-8712-67465A6E50AB@FreeBSD.org>
References:  <201403071642.s27GgbTr037300@svn.freebsd.org> <22293A4C-0F7F-45E9-8712-67465A6E50AB@FreeBSD.org>

next in thread | previous in thread | raw e-mail | index | archive | help

Good point. Thanks!

Dru




>________________________________
> From: Remko Lodder <remko@FreeBSD.org>
>To: Dru Lavigne <dru@freebsd.org> 
>Cc: doc-committers@freebsd.org; svn-doc-all@freebsd.org; svn-doc-head@freebsd.org 
>Sent: Friday, March 7, 2014 5:19 PM
>Subject: Re: svn commit: r44176 - head/en_US.ISO8859-1/books/handbook/advanced-networking
> 
>
>
>On 07 Mar 2014, at 17:42, Dru Lavigne <dru@freebsd.org> wrote:
>
>> Author: dru
>> Date: Fri Mar  7 16:42:37 2014
>> New Revision: 44176
>> URL: http://svnweb.freebsd.org/changeset/doc/44176
>> 
>> Log:
>>  Edits needed to close PR.
>
>These are rather..odd changelogs.. 
>
>Would it be possible to describe the problem you are trying to fix instead of ‘editing because a PR’? (It would be fun to see this happening in src/, people would loose it ;))
>
>Thanks!
>Remko
>
>> 
>>  PR: 121585
>>  Sponsored by: iXsystems
>> 
>> Modified:
>>  head/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.xml
>> 
>> Modified: head/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.xml
>> ==============================================================================
>> --- head/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.xml    Fri Mar  7 16:36:29 2014    (r44175)
>> +++ head/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.xml    Fri Mar  7 16:42:37 2014    (r44176)
>> @@ -4466,19 +4466,19 @@ Received 264951 bytes in 0.1 seconds</sc
>>         </row>
>> 
>>         <row>
>> -          <entry><systemitem>ff::</systemitem></entry>
>> +          <entry><systemitem>ff00::</systemitem></entry>
>>           <entry>8 bits</entry>
>>           <entry>multicast</entry>
>>           <entry>&nbsp;</entry>
>>         </row>
>> 
>>         <row>
>> -          <entry><systemitem>001</systemitem> (base 2)</entry>
>> +          <entry><systemitem>2000::-3fff:: </systemitem></entry>
>>           <entry>3 bits</entry>
>>           <entry>global unicast</entry>
>>           <entry>All global unicast addresses are assigned from
>>         this pool.  The first 3 bits are
>> -        <quote>001</quote>.</entry>
>> +        <literal>001</literal>.</entry>
>>         </row>
>>       </tbody>
>>     </tgroup>
>> 
>
>-- 
>
>/"\   Best regards,                      | remko@FreeBSD.org
>\ /   Remko Lodder                       | remko@EFnet
>X    http://www.evilcoder.org/          |
>/ \   ASCII Ribbon Campaign              | Against HTML Mail and News
>
>
>
From owner-svn-doc-head@FreeBSD.ORG  Sat Mar  8 00:15:43 2014
Return-Path: <owner-svn-doc-head@FreeBSD.ORG>
Delivered-To: svn-doc-head@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by hub.freebsd.org (Postfix) with ESMTPS id CFD43C77;
 Sat,  8 Mar 2014 00:15:43 +0000 (UTC)
Received: from svn.freebsd.org (svn.freebsd.org
 [IPv6:2001:1900:2254:2068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (No client certificate requested)
 by mx1.freebsd.org (Postfix) with ESMTPS id A283D73;
 Sat,  8 Mar 2014 00:15:43 +0000 (UTC)
Received: from svn.freebsd.org ([127.0.1.70])
 by svn.freebsd.org (8.14.8/8.14.8) with ESMTP id s280FhPW028196;
 Sat, 8 Mar 2014 00:15:43 GMT (envelope-from wblock@svn.freebsd.org)
Received: (from wblock@localhost)
 by svn.freebsd.org (8.14.8/8.14.8/Submit) id s280Fh1V028195;
 Sat, 8 Mar 2014 00:15:43 GMT (envelope-from wblock@svn.freebsd.org)
Message-Id: <201403080015.s280Fh1V028195@svn.freebsd.org>
From: Warren Block <wblock@FreeBSD.org>
Date: Sat, 8 Mar 2014 00:15:43 +0000 (UTC)
To: doc-committers@freebsd.org, svn-doc-all@freebsd.org,
 svn-doc-head@freebsd.org
Subject: svn commit: r44192 -
 head/en_US.ISO8859-1/books/fdp-primer/writing-style
X-SVN-Group: doc-head
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-doc-head@freebsd.org
X-Mailman-Version: 2.1.17
Precedence: list
List-Id: SVN commit messages for the doc tree for head
 <svn-doc-head.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/svn-doc-head>,
 <mailto:svn-doc-head-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-doc-head/>;
List-Post: <mailto:svn-doc-head@freebsd.org>
List-Help: <mailto:svn-doc-head-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/svn-doc-head>,
 <mailto:svn-doc-head-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Sat, 08 Mar 2014 00:15:43 -0000

Author: wblock
Date: Sat Mar  8 00:15:43 2014
New Revision: 44192
URL: http://svnweb.freebsd.org/changeset/doc/44192

Log:
  Add non-trivial indentation examples and an example of moving an element
  to the next line to improve readability.

Modified:
  head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml

Modified: head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml
=============================================================================--- head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml	Fri Mar  7 22:02:49 2014	(r44191)
+++ head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml	Sat Mar  8 00:15:43 2014	(r44192)
@@ -325,6 +325,33 @@
   <tag class="endtag">sect1</tag>
 <tag class="endtag">chapter</tag></programlisting>

+      <para>Tags containing long attributes follow the same
+	rules.  Following the indentation rules in this case helps
+	editors and writers see which content is inside the
+	tags:</para>
+
+      <programlisting><tag class="starttag">para</tag>See the <tag class="starttag">link
+    linkend="gmirror-troubleshooting"</tag>Troubleshooting<tag class="endtag">link</tag>
+  section if there are problems booting.  Powering down and
+  disconnecting the original <tag class="starttag">filename</tag>ada0<tag class="endtag">filename</tag> disk
+  will allow it to be kept as an offline backup.<tag class="endtag">para</tag>
+
+<tag class="starttag">para</tag>It is also possible to journal the boot disk of a &amp;os;
+  system.  Refer to the article <tag class="starttag">link
+    xlink:href="&amp;url.articles.gjournal-desktop;"</tag>Implementing UFS
+    Journaling on a Desktop PC<tag class="endtag">link</tag> for detailed
+  instructions.<tag class="endtag">para</tag>></programlisting>
+
+      <para>When an element is too long to fit on the remainder of a
+	line without wrapping, moving the start tag to the next line
+	can make the source easier to read.  In this example, the
+	<literal>systemitem</literal> element has been moved to the
+	next line to avoid wrapping and indenting:</para>
+
+      <programlisting><tag class="starttag">para</tag>With file flags, even
+  <tag class="starttag">systemitem class="username"</tag>root<tag class="endtag">systemitem</tag> can be
+  prevented from removing or altering files.<tag class="endtag">para</tag></programlisting>
+
       <para>Configurations to help various text editors conform to
 	these guidelines can be found in
 	<xref linkend="editor-config"/>.</para>



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?1394231229.8505.YahooMailNeo>