[patch #4145] grammatical and readability suggestions and fixes to find.texi

[Aaron Hawley]

URL:
  <http://savannah.gnu.org/patch/?func=detailitem&item_id=4145>

                 Summary: grammatical and readability suggestions and fixes to
find.texi
                 Project: findutils
            Submitted by: ashawley
            Submitted on: Tue 07/05/2005 at 20:21
                Category: documentation improvement
                Priority: 4
                  Status: None
                 Privacy: Public
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
                 Release: None
           Fixed Release: None

    _______________________________________________________

Details:

Attached is a patch to chapters 7, 9 and 10 for the find manual.  It is
against revision 1.96 of the file find.texi.

It contains grammatical and readability suggestions that are perhaps more
controversial.
I'll be following up with a whitespace-fixed patch.
Below is a list of descriptions for the changes: 

* Change "if all files are processed" to "if all files matched are
processed".
* Change mentions of "command line argument format" to "command line usage".
* Change "and so cannot" to "and consequently cannot"
* Add a summary for `locate' command.
* Chang "name of the file in locate database" to "name of a file in locate
database".
* Change "matches we found" to "matches found".
* Change "default file name database" to "default `locate' database".
* Change "This is the default." to "This is the default behavior.".
* Change "If you use the ---count option" to "When used with the --count
option".
* Change "which match the specified regular expression are printed (or
counted)." to just "are matched using the specified regular expression."
* Change "summary of the options" to "summary of the command line usage".
* Add summary for the `updatedb' command.
* Change "Default is `daemon'." to "Default `user' is `daeomon'.".
* Change "and the quotes and backslash are not special" to "and any quotes and
backslash characters are not considered special".
* Change uses of "nonblank" to "non-blank".
* Change "does not contain any nonblanks" to "is completely empty".
* Change "the terminating nulls at" to "any terminating nulls at".
* Change "Run up to `max-procs' processes at a time;" to "Run simultaneously
up to `max-procs' processes at once;".
* Change "run as many processes as possible at a time" to "run as many
processes as possible simultaneously".
* Remove use of "In general,".
* Change "are where" to "are when".
* Change "third parties can bring" to "third parties could bring".
* Change "where those programs allow them to do something" to "allowing them
to do something".
* Remove uses of "to do" by changing "to do something they would normally not
be able to do" to "to do something they would normally not be able to
accomplish".
* Remove use of "also" in "It is also common".
* Change "housekeeping purposes" to "self-maintenance purposes".
* Change "search the whole filesystem" to "search the entire filesystem".
* Add "Generally," to "the severity of any associated problem depends".
* Change "is going to do with the output of `find'" to "is going to do with
the files found by `find'".
* Markup first use of "Race conditions" in @dfn.
* Change "are important" to "are critically important in getting the correct
and expected result" in definition of a "race condition".
* Change "Typically," to "For `find',".
* Change"`find' notices a subdirectory" to `find' reaches and recognizes a
subdirectory".
* Change "autmounter" to "filesystem ``automounter''".
* Change "program will then - normally - perform" to "program will typically
then perform".

* Change "issues the @code{unlink()} system call" to "issues the
@code{unlink()} system call to delete the file from the filesystem".
* Change "via `-exec'" to "with `-exec'".
* Change "features translated error messages" to "features translations of
error messages".
* Change "where possible we try to make the error messages produced by the
programs self-explanatory" to "the error messages produced by the programs are
made to be as self-explanatory as possible".
* Change "figure out which English-language error message corresponds to a
test" to "figure out which test an English-language error message corresponds
to".
* Change "described or discussed in this document" to "mentioned in this
document".
* Change "discussed in this document" to "mentioned in this document".
* Change "If you intended it to be a test, check what you" to "If it was
intended to be a test, check what was".
* Change "on an NFS filesystem" to "on an network filesystem (NFS)".
* Change every en-dash (--) punctuation to proper em-dash (---).
* Change "changes directory" to "moves into a directory".
* Change quoted punctuation of "automount" to address@hidden' markup.
* Change "`autmount' does its thing" to "`autmount' intervenes"
* Add period to end of a sentence.
* Change "down it" to "down into it".
* Change "`find' changes directory" to "`find' moves into a directory".
* Change "the inode number of that directory once it's got there is different
to the inode number that it obtained when it examined the directory some time
previously." to "discovers that the inode number of that directory is
different to the inode number that it obtained when it examined the directory
some time previously."
* Change "This normally means" to "This usually means".
* Change "while `find' has been deep to "while `find' was deep".
* Change "doing something time consuming" to "doing a time consuming
operation".
* Change "This may have been done maliciously, or may not" to "This may or may
not have been done maliciously".
* Change "in order to avoid traversing" to "to avoid traversing".
* Change "that it wasn't intended to" to "that it wasn't intended."
* Change "if `ps' still works" to "with `ps', if possible".






    _______________________________________________________

File Attachments:


-------------------------------------------------------
Date: Tue 07/05/2005 at 20:21  Name: find.texi-1.96-ch-7,9,10-fixes.diff 
Size: 17.75KB   By: ashawley
diff -u patch for find.texi version 1.96
<http://savannah.gnu.org/patch/download.php?item_id=4145&item_file_id=4791>

    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/patch/?func=detailitem&item_id=4145>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/