From nobody@FreeBSD.org  Sat Dec  1 06:08:11 2012
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52])
	by hub.freebsd.org (Postfix) with ESMTP id 939741CC
	for <freebsd-gnats-submit@FreeBSD.org>; Sat,  1 Dec 2012 06:08:11 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from red.freebsd.org (red.freebsd.org [IPv6:2001:4f8:fff6::22])
	by mx1.freebsd.org (Postfix) with ESMTP id 7BF088FC13
	for <freebsd-gnats-submit@FreeBSD.org>; Sat,  1 Dec 2012 06:08:11 +0000 (UTC)
Received: from red.freebsd.org (localhost [127.0.0.1])
	by red.freebsd.org (8.14.5/8.14.5) with ESMTP id qB168BGH016462
	for <freebsd-gnats-submit@FreeBSD.org>; Sat, 1 Dec 2012 06:08:11 GMT
	(envelope-from nobody@red.freebsd.org)
Received: (from nobody@localhost)
	by red.freebsd.org (8.14.5/8.14.5/Submit) id qB168BAd016461;
	Sat, 1 Dec 2012 06:08:11 GMT
	(envelope-from nobody)
Message-Id: <201212010608.qB168BAd016461@red.freebsd.org>
Date: Sat, 1 Dec 2012 06:08:11 GMT
From: Derek Wood <ddwood@outlook.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [patch] faq: update #minimal-sh
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         174029
>Category:       docs
>Synopsis:       [patch] faq: update #minimal-sh
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    eadler
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Dec 01 06:10:00 UTC 2012
>Closed-Date:    Sat Dec 08 04:12:10 UTC 2012
>Last-Modified:  Sat Dec 08 04:12:10 UTC 2012
>Originator:     Derek Wood
>Release:        
>Organization:
>Environment:
>Description:
The attached patch updates the #minimal-sh question in the FAQ to link to the sh(1) man page, include the fact that tcsh(1) is in the base FreeBSD installation (and link to its man page), and refill the text of the question to be 70 columns wide.
>How-To-Repeat:

>Fix:


Patch attached with submission follows:

Index: en_US.ISO8859-1/books/faq/book.xml
===================================================================
--- en_US.ISO8859-1/books/faq/book.xml	(revision 40165)
+++ en_US.ISO8859-1/books/faq/book.xml	(working copy)
@@ -3975,8 +3975,8 @@
 
       <qandaentry>
 	<question id="minimal-sh">
-	  <para>Why is <command>/bin/sh</command> so minimal?  Why does
-	    &os; not use <command>bash</command> or another
+	  <para>Why is <command>/bin/sh</command> so minimal?  Why
+	    does &os; not use <command>bash</command> or another
 	    shell?</para>
 	</question>
 
@@ -3986,25 +3986,26 @@
 
 	  <para>The more complicated answer: many people need to write
 	    shell scripts which will be portable across many systems.
-	    That is why &posix; specifies the shell and utility commands
-	    in great detail.  Most scripts are written in Bourne shell,
-	    and because several important programming interfaces
-	    (&man.make.1;, &man.system.3;, &man.popen.3;, and analogues
-	    in higher-level scripting languages like Perl and Tcl) are
-	    specified to use the Bourne shell to interpret commands.
-	    Because the Bourne shell is so often and widely used, it is
-	    important for it to be quick to start, be deterministic in
-	    its behavior, and have a small memory footprint.</para>
+	    That is why &posix; specifies the shell and utility
+	    commands in great detail.  Most scripts are written in
+	    Bourne shell (&man.sh.1;), and because several important
+	    programming interfaces (&man.make.1;, &man.system.3;,
+	    &man.popen.3;, and analogues in higher-level scripting
+	    languages like Perl and Tcl) are specified to use the
+	    Bourne shell to interpret commands.  Because the Bourne
+	    shell is so often and widely used, it is important for it
+	    to be quick to start, be deterministic in its behavior,
+	    and have a small memory footprint.</para>
 
 	  <para>The existing implementation is our best effort at
 	    meeting as many of these requirements simultaneously as we
-	    can.  In order to keep <command>/bin/sh</command> small, we
-	    have not provided many of the convenience features that
-	    other shells have.  That is why the Ports Collection
-	    includes more featureful shells like
+	    can.  In order to keep <command>/bin/sh</command> small,
+	    we have not provided many of the convenience features that
+	    other shells have.  That is why &os; and the Ports
+	    Collection include more featureful shells like
 	    <command>bash</command>, <command>scsh</command>,
-	    <command>tcsh</command>, and <command>zsh</command>.  (You
-	    can compare for yourself the memory utilization of all these
+	    &man.tcsh.1;, and <command>zsh</command>.  (You can
+	    compare for yourself the memory utilization of all these
 	    shells by looking at the <quote>VSZ</quote> and
 	    <quote>RSS</quote> columns in a <command>ps
 	    <option>-u</option></command> listing.)</para>


>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->eadler 
Responsible-Changed-By: eadler 
Responsible-Changed-When: Sat Dec 1 06:40:45 UTC 2012 
Responsible-Changed-Why:  
I'll take it. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=174029 

From: Derek Wood <ddwood@highdensity.org>
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/174029: [patch] faq: update #minimal-sh
Date: Mon, 3 Dec 2012 05:03:25 -0700

 --6TrnltStXW4iwmi0
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: inline
 
 The included patches split the original patch into content and
 whitespace patches and incorporate suggestions from jilles@ and
 eadler@.
 
 --6TrnltStXW4iwmi0
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: attachment; filename="sh-minimal-content.patch.txt"
 
 diff --git a/en_US.ISO8859-1/books/faq/book.xml b/en_US.ISO8859-1/books/faq/book.xml
 index 81f334b..52e2965 100644
 --- a/en_US.ISO8859-1/books/faq/book.xml
 +++ b/en_US.ISO8859-1/books/faq/book.xml
 @@ -3981,13 +3981,10 @@ kern.timecounter.hardware: TSC -&gt; i8254</screen>
  	</question>
  
  	<answer>
 -	  <para>Because &posix; says that there shall be such a
 -	    shell.</para>
 -
 -	  <para>The more complicated answer: many people need to write
 +	  <para>Many people need to write
  	    shell scripts which will be portable across many systems.
  	    That is why &posix; specifies the shell and utility commands
 -	    in great detail.  Most scripts are written in Bourne shell,
 +	    in great detail.  Most scripts are written in Bourne shell (&man.sh.1;),
  	    and because several important programming interfaces
  	    (&man.make.1;, &man.system.3;, &man.popen.3;, and analogues
  	    in higher-level scripting languages like Perl and Tcl) are
 @@ -4003,7 +4000,7 @@ kern.timecounter.hardware: TSC -&gt; i8254</screen>
  	    other shells have.  That is why the Ports Collection
  	    includes more featureful shells like
  	    <command>bash</command>, <command>scsh</command>,
 -	    <command>tcsh</command>, and <command>zsh</command>.  (You
 +	    &man.tcsh.1;, and <command>zsh</command>.  (You
  	    can compare for yourself the memory utilization of all these
  	    shells by looking at the <quote>VSZ</quote> and
  	    <quote>RSS</quote> columns in a <command>ps
 
 --6TrnltStXW4iwmi0
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: attachment; filename="sh-minimal-whitespace.patch.txt"
 
 diff --git a/en_US.ISO8859-1/books/faq/book.xml b/en_US.ISO8859-1/books/faq/book.xml
 index 52e2965..0ba4377 100644
 --- a/en_US.ISO8859-1/books/faq/book.xml
 +++ b/en_US.ISO8859-1/books/faq/book.xml
 @@ -3975,33 +3975,34 @@ kern.timecounter.hardware: TSC -&gt; i8254</screen>
  
        <qandaentry>
  	<question id="minimal-sh">
 -	  <para>Why is <command>/bin/sh</command> so minimal?  Why does
 -	    &os; not use <command>bash</command> or another
 +	  <para>Why is <command>/bin/sh</command> so minimal?  Why
 +	    does &os; not use <command>bash</command> or another
  	    shell?</para>
  	</question>
  
  	<answer>
 -	  <para>Many people need to write
 -	    shell scripts which will be portable across many systems.
 -	    That is why &posix; specifies the shell and utility commands
 -	    in great detail.  Most scripts are written in Bourne shell (&man.sh.1;),
 -	    and because several important programming interfaces
 -	    (&man.make.1;, &man.system.3;, &man.popen.3;, and analogues
 -	    in higher-level scripting languages like Perl and Tcl) are
 -	    specified to use the Bourne shell to interpret commands.
 -	    Because the Bourne shell is so often and widely used, it is
 -	    important for it to be quick to start, be deterministic in
 -	    its behavior, and have a small memory footprint.</para>
 +	  <para>Many people need to write shell scripts which will be
 +	    portable across many systems.  That is why &posix;
 +	    specifies the shell and utility commands in great detail.
 +	    Most scripts are written in Bourne shell (&man.sh.1;), and
 +	    because several important programming interfaces
 +	    (&man.make.1;, &man.system.3;, &man.popen.3;, and
 +	    analogues in higher-level scripting languages like Perl
 +	    and Tcl) are specified to use the Bourne shell to
 +	    interpret commands.  Because the Bourne shell is so often
 +	    and widely used, it is important for it to be quick to
 +	    start, be deterministic in its behavior, and have a small
 +	    memory footprint.</para>
  
  	  <para>The existing implementation is our best effort at
  	    meeting as many of these requirements simultaneously as we
 -	    can.  In order to keep <command>/bin/sh</command> small, we
 -	    have not provided many of the convenience features that
 +	    can.  In order to keep <command>/bin/sh</command> small,
 +	    we have not provided many of the convenience features that
  	    other shells have.  That is why the Ports Collection
  	    includes more featureful shells like
  	    <command>bash</command>, <command>scsh</command>,
 -	    &man.tcsh.1;, and <command>zsh</command>.  (You
 -	    can compare for yourself the memory utilization of all these
 +	    &man.tcsh.1;, and <command>zsh</command>.  (You can
 +	    compare for yourself the memory utilization of all these
  	    shells by looking at the <quote>VSZ</quote> and
  	    <quote>RSS</quote> columns in a <command>ps
  	    <option>-u</option></command> listing.)</para>
 
 --6TrnltStXW4iwmi0--
State-Changed-From-To: open->analyzed 
State-Changed-By: eadler 
State-Changed-When: Tue Dec 4 00:23:25 UTC 2012 
State-Changed-Why:  
awaiting approval or review prior to commit (no action needed from 
submitter) 

http://www.freebsd.org/cgi/query-pr.cgi?pr=174029 
State-Changed-From-To: analyzed->closed 
State-Changed-By: eadler 
State-Changed-When: Sat Dec 8 04:12:09 UTC 2012 
State-Changed-Why:  
r40297 

http://www.freebsd.org/cgi/query-pr.cgi?pr=174029 
>Unformatted:
