Bug 66481

Summary: [patch] share/examples/diskless/README.TEMPLATING tyops
Product: Documentation Reporter: Michel Lavondes <fox>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Michel Lavondes 2004-05-10 18:40:15 UTC

Fix: Patch also available at: http://www.livejournal.com/users/pauamma/1231.html



TEMPLATE COPYING AND SAFETY
@@ -195,7 +195,7 @@
     softlinks, hardlinks, files, modification times, uid, gid, flags, perms,
     and so forth.  The program incorporates several major features:

-        *   The program refuses, absolutely, to cross partition boundries.
+        *   The program refuses, absolutely, to cross partition boundaries.
             i.e. if you were copying the template /usr from an NFS mount to
             your /usr, and you had a mount point called /usr/home, the
             template copying program would *NOT* descend into /usr/home on
@@ -204,7 +204,7 @@
             This is a safety.

         *   The program accesses a file called .cpignore in each directory
-            it descending into on the source to obtain a list of exceptions
+            it descends into on the source to obtain a list of exceptions
             for that directory -- that is, files not to copy or mess with.

             This is a templating function.--EvEyXdr18EoTdiBotp639RUQdu6sgql4OvEzayacDTj9YRnT
Content-Type: text/plain; name="file.diff"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename="file.diff"

--- share/examples/diskless/README.TEMPLATING.orig	Wed May  5 09:17:25 2004
+++ share/examples/diskless/README.TEMPLATING	Wed May  5 09:19:47 2004
@@ -184,7 +184,7 @@
     file in / or /usr on a target machine instead of the template machine.
     If the target machine is updated once a night from cron, the sysop
     quickly learns not to do this ( because his changes get overwritten
-    overnight ).  With a manual update, these sorts of mistakes can propogate
+    overnight ).  With a manual update, these sorts of mistakes can propagate
     for weeks or months before they are caught.
How-To-Repeat: more /usr/share/examples/diskless/README.TEMPLATING
Comment 1 Simon L. B. Nielsen freebsd_committer freebsd_triage 2004-05-10 21:39:43 UTC
State Changed
From-To: open->closed

Committed, thanks!
Comment 2 Warren Block 2004-05-11 00:12:01 UTC
On Mon, 10 May 2004, Michel Lavond=E8s wrote:

> Patch also available at: http://www.livejournal.com/users/pauamma/1231.ht=
ml
>
> --- share/examples/diskless/README.TEMPLATING.orig=09Wed May  5 09:17:25 =
2004
> +++ share/examples/diskless/README.TEMPLATING=09Wed May  5 09:19:47 2004

> -            it descending into on the source to obtain a list of excepti=
ons
> +            it descends into on the source to obtain a list of exception=
s
                                ^^
The "on" should be removed.

-Warren Block * Rapid City, South Dakota USA
Comment 3 Michel Lavondes 2004-05-11 07:30:32 UTC
On Mon, 10 May 2004, Warren Block wrote:

> On Mon, 10 May 2004, Michel Lavondès wrote:
> 
> > --- share/examples/diskless/README.TEMPLATING.orig	Wed May  5 09:17:25 2004
> > +++ share/examples/diskless/README.TEMPLATING	Wed May  5 09:19:47 2004
> 
> > -            it descending into on the source to obtain a list of exceptions
> > +            it descends into on the source to obtain a list of exceptions
>                                 ^^
> The "on" should be removed.

I don't think so. The whole sentence reads as follows:

        *   The program accesses a file called .cpignore in each directory
            it descends into on the source to obtain a list of exceptions
            for that directory -- that is, files not to copy or mess with.

Perhaps it could be reworded as "each directory of the source [tree] into 
which it descends", but this is (IMHO) a matter of taste, and I'd rather 
not get involved in those.

-- 
"I'd ask if you'd found the right sort of isolated wasteland for your
citadel of dread yet, but that would be a silly question; you're in Utah,
after all." --ESR to Darl McBride (Chief Excessive Ossifier of Squandered 
Clues Obstination), in http://www.catb.org/~esr/writings/mcbride.html
Comment 4 Warren Block 2004-05-12 00:37:28 UTC
On Tue, 11 May 2004, [ISO-8859-1] Michel Lavond=E8s wrote:

> > The "on" should be removed.
>
> I don't think so. The whole sentence reads as follows:
>
>         *   The program accesses a file called .cpignore in each director=
y
>             it descends into on the source to obtain a list of exceptions
>             for that directory -- that is, files not to copy or mess with=
=2E
>
> Perhaps it could be reworded as "each directory of the source [tree] into
> which it descends", but this is (IMHO) a matter of taste, and I'd rather
> not get involved in those.

Ah--it's not an extra word, but a clash of phrasing.  Sorry, I saw it
out of context.  How about:

             Each source directory is checked for a file called
             .cpignore. If present, this file contains a list of
             exceptions: files that are not to be copied or messed with.

"Messed with" is a little, uh, messy.  It doesn't really tell the reader
what might happen to a file.  It could be copied, or it could be
overwritten.  The last three words could be dropped if it just won't be
copied; otherwise, seems like "cpignore" is a misnomer.

-Warren Block * Rapid City, South Dakota USA
Comment 5 Michel Lavondes 2004-05-12 03:45:30 UTC
On Tue, 11 May 2004, Warren Block wrote:

> On Tue, 11 May 2004, [ISO-8859-1] Michel Lavondès wrote:
> 
> > I don't think so. The whole sentence reads as follows: [snipped]
> 
> How about:
> 
>              Each source directory is checked for a file called
>              .cpignore. If present, this file contains a list of
>              exceptions: files that are not to be copied or messed with.

Perhaps. Feel free to suggest (or commit if you're a committer) your own 
wording as a PR if you feel strongly about it. I just wanted the obvious 
grammar problem fixed, and it is, so I'm content. :-)

-- 
"I'd ask if you'd found the right sort of isolated wasteland for your
citadel of dread yet, but that would be a silly question; you're in Utah,
after all." --ESR to Darl McBride (Chief Excessive Ossifier of Squandered 
Clues Obstination), in http://www.catb.org/~esr/writings/mcbride.html