Bug 34547

Summary:	[patch] edits of FAQ Introduction
Product:	Documentation	Reporter:	jayed <jayed>
Component:	Books & Articles	Assignee:	Giorgos Keramidas <keramida>
Status:	Closed FIXED
Severity:	Affects Only Me
Priority:	Normal
Version:	Latest
Hardware:	Any
OS:	Any

Description jayed 2002-02-02 06:50:00 UTC

	in 1.5:
		-- change "and/or" to "and" or "or"
		-- remove reference to native language when explaining dual meaning of "free"
		-- replace "you really can do" with "you can do"
	in 1.6:
		-- change "Briefly explained" to "Briefly"
		-- remove reference to "ISP or corporate user"; any type of user could use STABLE
		-- replace "low change count" with "minimal number of changes"
		-- replace "wizzy" with "new (and possibly unstable)
		-- rewrite last sentence in second para to elimiate a lot of "you"s
		-- change "Releases are only made" to "Releases are made"
	in 1.7:
		-- change "are sometimes treated" with "may be treated"
		-- remove "Nowadays"
		-- change "are now being made available" with "are available"
		-- change "and/or" to "and" or "or"
		-- change "bootstrapping it onto" to "installing it on"
		-- change "preserve" to "maintain"; implies an ongoing process 
		-- change "code in question" to "branch in question"
		-- remove use of "we"
		-- remove use of "like"
		-- change "any new feature in need of testing" with "all new features and fixes"
		-- change "once a day" with "daily"
	in 1.9:
		-- change "As a general principle" with "As a rule"
		-- make "FreeBSD core team" agree with verb
		-- change "when they believe that" with "when"
		-- change "and/or" to "and"
		-- major rewrite of the rest of the first sentence; emphasise stability and testing 
		-- change "the people working" to "the developers working"
		-- change "although" to "though" 
		-- remove "on average"
		-- change "every day" to "daily"
	in 1.11:
		-- change "once a day" to "daily"
		-- change "once a day" to "every day"
		-- change "being of service purely" to "only useful"

There are possibly other minor changes that have not been documented.  If you accept my patch, PLEASE look for whitespace issues carefully, jade is currently broken on my CURRENT so I couldn't build it.

Fix: 

patch
How-To-Repeat: 	NA

Comment 1 jayed 2002-02-02 07:56:47 UTC

(Oops.  Forgot the patch).

Index: book.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/faq/book.sgml,v
retrieving revision 1.400
diff -c -r1.400 book.sgml
*** book.sgml	2002/02/02 00:43:51	1.400
--- book.sgml	2002/02/02 06:15:14
***************
*** 225,244 ****
              </listitem>
<listitem>
!               <para>Anyone who has an improvement and/or bug fix is free
                  to submit their code and have it added to the source tree
                  (subject to one or two obvious provisions).</para>
</listitem>
</itemizedlist>
!           <para>For those of our readers whose first language is not
!             English, it may be worth pointing out that the word
!             <quote>free</quote> is being used in two ways here, one meaning
!             <quote>at no cost</quote>, the other meaning <quote>you can do
!             whatever you like</quote>.  Apart from one or two things you
!             <emphasis>cannot</emphasis> do with the FreeBSD code, for
!             example pretending you wrote it, you really can do whatever you
!             like with it.</para>
</answer>
</qandaentry>
--- 225,242 ----
              </listitem>
<listitem>
!               <para>Anyone who has an improvement or bug fix is free
                  to submit their code and have it added to the source tree
                  (subject to one or two obvious provisions).</para>
</listitem>
</itemizedlist>
!             <para>It is worth pointing out that the word <quote>free</quote>
!             is being used in two ways here, one meaning <quote>at no cost
!             </quote>, the other meaning <quote>you can do whatever you like
!             Apart from one or two things you <emphasis>cannot</emphasis>
!             do with the FreeBSD code (for example, pretending that you
!             wrote it, you can do whatever you like with it.</para>
</answer>
</qandaentry>
***************
*** 254,270 ****
              released in &rel.current.date;. This is also the latest
              <emphasis>RELEASE</emphasis> version.</para>
!           <para>Briefly explained, <emphasis>-STABLE</emphasis> is aimed
!             at the ISP or other corporate user who wants stability and a
!             low change count over the wizzy new features of the latest
!             <emphasis>-CURRENT</emphasis> snapshot.  Releases can come
!             from either branch, but you should only use
!             <emphasis>-CURRENT</emphasis> if you are sure that you are
!             prepared for its increased volatility (relative to
!             <emphasis>-STABLE</emphasis>, that is).</para>
!           <para>Releases are only made <link linkend="release-freq">every
!             few months</link>. While many people stay more up-to-date with
              the FreeBSD sources (see the questions on <link
              linkend="current">FreeBSD-CURRENT</link> and <link
              linkend="stable">FreeBSD-STABLE</link>) than that, doing so
--- 252,267 ----
              released in &rel.current.date;. This is also the latest
              <emphasis>RELEASE</emphasis> version.</para>
!           <para>Briefly, <emphasis>-STABLE</emphasis> is aimed at the user
!             who wants stability and a minimal number of changes more than
!             they want the new (and possibly unstable) features of the
!             latest <emphasis>-CURRENT</emphasis> snapshot.  Releases can
!             come from either branch, but <emphasis>-CURRENT</emphasis>
!             should only be used if you are prepared for its increased
!             volatility (relative to <emphasis>-STABLE</emphasis>, that 
is.</para>
!           <para>Releases are made <link linkend="release-freq">every few 
!             months</link>. While many people stay more up-to-date with
              the FreeBSD sources (see the questions on <link
              linkend="current">FreeBSD-CURRENT</link> and <link
              linkend="stable">FreeBSD-STABLE</link>) than that, doing so
***************
*** 299,313 ****
              analyze any problems and only report them if they are deemed
              to be mistakes rather than <quote>glitches</quote>. Questions
              such as <quote>make world produces some error about
!             groups</quote> on the -CURRENT mailing list are sometimes
!             treated with contempt.</para>
<para>Every day, <ulink
              URL="../../../../releases/snapshots.html">snapshot
              </ulink> releases are made based on the current state of the
!             -CURRENT and -STABLE branches. Nowadays, distributions of the
!             occasional snapshot are now being made available. The goals
!             behind each snapshot release are:</para>
<itemizedlist>
<listitem>
--- 296,310 ----
              analyze any problems and only report them if they are deemed
              to be mistakes rather than <quote>glitches</quote>. Questions
              such as <quote>make world produces some error about
!             groups</quote> on the -CURRENT mailing list may be treated
!             with contempt.</para>
<para>Every day, <ulink
              URL="../../../../releases/snapshots.html">snapshot
              </ulink> releases are made based on the current state of the
!             -CURRENT and -STABLE branches. Distributions of the
!             occasional snapshot are available. The goals behind each
!             snapshot release are:</para>
<itemizedlist>
<listitem>
***************
*** 317,338 ****
  
              <listitem>
<para>To give people who would like to run -CURRENT or
!                 -STABLE but who do not have the time and/or bandwidth to
                  follow it on a day-to-day basis an easy way of
!                 bootstrapping it onto their systems.</para>
</listitem>
<listitem>
!               <para>To preserve a fixed reference point for the code in
!                 question, just in case we break something really badly
!                 later.  (Although CVS normally prevents anything horrible
!                 like this happening :)</para>
</listitem>
<listitem>
!               <para>To ensure that any new features in need of testing
!                 have the greatest possible number of potential
!                 testers.</para>
</listitem>
</itemizedlist>
--- 314,334 ----
  
              <listitem>
<para>To give people who would like to run -CURRENT or
!                 -STABLE but who do not have the time or bandwidth to
                  follow it on a day-to-day basis an easy way of
!                 installing it on their systems.</para>
</listitem>
<listitem>
!               <para>To maintain a fixed reference point for the branch in
!                 question, just in case something gets very badly broken
!                 later.  (Although CVS normally prevents anything this
!                 horrible from happening :)</para>
</listitem>
<listitem>
!               <para>To ensure that all new features and fixes have the
!                 greatest possible number of potential testers.</para>
</listitem>
</itemizedlist>
***************
*** 350,357 ****
              3-STABLE snapshots are not being produced at the time of
              this writing (May 2000).</para>
!           <para>Snapshots are generated, on the average, once a day for
!             all actively developed branches.</para>
</answer>
</qandaentry>
--- 346,353 ----
              3-STABLE snapshots are not being produced at the time of
              this writing (May 2000).</para>
!           <para>Snapshots are usually generated daily for all
!             actively developed branches.</para>
</answer>
</qandaentry>
***************
*** 431,453 ****
          </question>
<answer>
!           <para>As a general principle, the FreeBSD core team only release
!             a new version of FreeBSD when they believe that there are
!             sufficient new features and/or bug fixes to justify one, and
!             are satisfied that these new developments have been tested
!             sufficiently to avoid compromising the stability of the
!             release.  Release dates are generally announced well in
!             advance, so that the people working on the system know
!             when their projects need to be finished and tested.  
!             Many users regard this caution as one of the best
!             things about FreeBSD, although 
!             waiting for all the latest goodies to reach -STABLE
!             can be a little frustrating.</para>
!           <para>Releases are made about every 4 months on average.</para>
<para>For people who need or want a little more excitement,
!             binary snapshots are made every day as discussed above.</para>
</answer>
</qandaentry>
--- 427,448 ----
          </question>
<answer>
!           <para>As a rule, the FreeBSD core team only releases a new
!             version of FreeBSD when there are a sufficient number of new
!             features and bug fixes to justify it, and, more imprtantly,
!             when they are satisfied that these changes have been
!             thoroughly tested and do not compromise the stability of
!             the release.  Release dates are generally announced well in
!             advance so the developers know when their projects need to
!             to be finished and tested.  Many users regard this caution 
!             as one of the best things about FreeBSD, though waiting for
!             all the latest goodies to reach -STABLE can be a little
!             frustrating.</para>
!           <para>Releases are made about every 4 months.</para>
<para>For people who need or want a little more excitement,
!             binary snapshots are made daily as discussed above.</para>
</answer>
</qandaentry>
***************
*** 501,516 ****
              <listitem>
<para><ulink
                  URL="ftp://releng4.FreeBSD.org/pub/FreeBSD/">4.X
!                 snapshots</ulink> are usually made once a day.</para>
</listitem>
<listitem>
<para><ulink
                  URL="ftp://current.FreeBSD.org/pub/FreeBSD/">
5.0 Snapshot</ulink> releases are made once a day for the
!                 <link linkend="current">-CURRENT</link> branch, these being
!                 of service purely to bleeding-edge testers and
!                 developers.</para>
</listitem>
</itemizedlist>
--- 496,510 ----
              <listitem>
<para><ulink
                  URL="ftp://releng4.FreeBSD.org/pub/FreeBSD/">4.X
!                 snapshots</ulink> are usually made daily.</para>
</listitem>
<listitem>
<para><ulink
                  URL="ftp://current.FreeBSD.org/pub/FreeBSD/">
5.0 Snapshot</ulink> releases are made every day for the
!                 <link linkend="current">-CURRENT</link> branch, these are
!                 only useful to bleeding-edge testers and developers.</para>
</listitem>
</itemizedlist>

Comment 2 Giorgos Keramidas freebsd_committer

2002-02-03 02:44:30 UTC

Hello Jay,

>
>  (Oops.  Forgot the patch).
>

The patch cannot be applied cleanly :(
Something has messed up with the diff output and whitespaces.
I suggest saving the diff output to a file, and using the send-pr -a
option to attach your patches for other PRs.

Now, I'll try to read the diff and see if I can manually make those
changes that are Good Things(TM) :-)

- Giorgos

Comment 3 Giorgos Keramidas freebsd_committer

2002-02-03 03:17:09 UTC

Responsible Changed
From-To: freebsd-doc->keramida

The patch included does not apply cleanly. 
I'm working with Jay Edwards (the submitter) to extract what 
changes we want to make and then commit what we come up with. 
Thank you Jay, for the work you'veput into the FAQ.

Comment 4 Giorgos Keramidas freebsd_committer

2002-08-24 00:54:27 UTC

State Changed
From-To: open->closed

All the changes that I could work out from the diff 
have now been applied.  Our new, shining FAQ, will 
soon be available online, after the next web build :) 

Many thanks to Jay, for patiently answering my comments 
when I was working on this, and waiting until I got around 
to (eventually) doing the last changes.