patchfindutils - Patches: patch #4145, grammatical and readability...

 
 

You are not allowed to post comments on this tracker with your current authentication level.

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

Submitter:  Aaron Hawley <ashawley>
Submitted:  Tue 05 Jul 2005 08:21:29 PM UTC
   
 
Category:  documentation improvement Priority:  4
Status:  Done Privacy:  Public
Assigned to:  jay Originator Name: 
Open/Closed:  Closed Release:  None
Fixed Release:  4.2.24

Thu 14 Jul 2005 07:46:47 PM UTC, comment #4: 

Here's the same patch against 1.99 with white spacing corrected.

Aaron Hawley <ashawley>
Thu 14 Jul 2005 07:44:44 PM UTC, comment #3: 

Attached is patch against 1.99 of find.texi including some new material related to World Wide Web permissions for the "Common Tasks" section, along with more suggestions and fixes for chapters 4 and 5.  Here is the list of changes:

  • Change "power of these programs" to "power of the findutils package".
  • Change "run your file viewing program" to "run your pager, a file viewing program,".
  • Change "so the whole command looks like this:" to "The following finds header files in /usr/include with the string 'mode_t':".
  • Change "file viewing program" to "pager".
  • Add "The above directs the list of matched files to the file todo."
  • Change "Here" to "Then".
  • Change "You can pass a list of files produced by find to a file archiving program" to "find can produce a list of files to pass to a file archiving program".
  • Change "give them the --null option" to "provide the --null option".
  • Change "to do the same things using tar" to "commands to do the above using tar".
  • Change "You can run this" to "Here is a command".
  • Change "clean out your clutter in /tmp" to "clean out unused files in /tmp".
  • Change "You might place it in" to "useful for placing in".
  • Change "rename the file instead" to "rename the file instead of delete".
  • Add examples on permissions for the World Wide Web to the "Fixing Permissions" section.
  • Add description of output for --statistics locate command.
  • Add "unique" before "part of the name that follows the shared prefix".
  • Change "second and following databases" to "concatenated databases".
  • Change "used by Unix locate and find programs and earlier releases of the GNU ones" to "used by Unix and early GNU releases of the locate and find programs".
  • Remove "though" in "used to generate the database though relies on".
  • Change "result in both incorrect matches and incorrect failures to match" to "result in both false matches and failures to match".


Aaron Hawley <ashawley>
Sun 10 Jul 2005 07:44:57 PM UTC, comment #2: 

I've applied all the patches (teh resulting version of find.texi is 1.98). 

I attach the ".rej" file for the whitespace patch; not all the hunks were applied.  As for your preferred way of proceeding, that's fine with me.  I'm not sure why the whitespace patch didn't fully apply, though.

Thanks for your help!

James Youngman <jay>
Group administrator
Thu 07 Jul 2005 11:39:34 PM UTC, comment #1: 

Attached is an initial proofreading of Chapter 8 "Worked Examples".  The diff patch is against version 1.96 of find.texi.  I'll also attach a pdiff (pretty-print diff) output as a PDF.

This patch should work alongside the Chapter 7, 8 and 9 patch that is missig the whitespace fixes.  The following patch command worked for me:

  $ cat find.texi-1.96-ch-*.diff | patch

I'd prefer to proceed with these patches by chapter(s), but I can combine these or any future patches into a single patch.  Let me know.


Aaron Hawley <ashawley>
Tue 05 Jul 2005 08:21:29 PM UTC, original submission:  

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 `@code' 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".


Aaron Hawley <ashawley>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attached Files
file #9041:  find.texi-1.99-ch-4,5-wspace-fixes.diff added by ashawley (11KiB - text/plain - diff -u for find.texi version 1.99 with paragraph-filling)
file #9040:  find.texi-1.99-ch-4,5-fixes.diff added by ashawley (7KiB - text/plain - diff -u patch for find.texi version 1.99)
file #9038:  find.texi-ch-8-pdiff.pdf added by ashawley (21KiB - application/pdf - Pretty-prit diff PDF of chapter 8 proofreadig)
file #9037:  find.texi-1.96-ch-8-proofreading.diff added by ashawley (18KiB - text/plain - diff -u patch for find.texi version 1.96)
file #9031:  find.texi-1.96-ch-7,9,10-wspace-fixes.diff added by ashawley (23KiB - text/plain - diff -u patch for find.texi version 1.96 with paragraph-filling)
file #9005:  find.texi-1.96-ch-7,9,10-fixes.diff added by ashawley (18KiB - text/plain - diff -u patch for find.texi version 1.96)

 

Depends on the following items: None found

Items that depend on this one: None found

 

CC list is empty

 

There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

 

Follow 10 latest changes.

Date Changed by Updated Field Previous Value => Replaced by
2005-07-29 jay Open/ClosedOpen Closed
    Fixed ReleaseNone 4.2.24
2005-07-14 ashawley Attached File- Added find.texi-1.99-ch-4,5-wspace-fixes.diff, #4836
2005-07-14 ashawley Attached File- Added find.texi-1.99-ch-4,5-fixes.diff, #4835
2005-07-10 jay StatusNone Done
    Assigned toNone jay
2005-07-07 ashawley Attached File- Added find.texi-ch-8-pdiff.pdf, #4804
2005-07-07 ashawley Attached File- Added find.texi-1.96-ch-8-proofreading.diff, #4803
2005-07-05 ashawley Attached File- Added find.texi-1.96-ch-7,9,10-wspace-fixes.diff, #4792
2005-07-05 ashawley Attached File- Added find.texi-1.96-ch-7,9,10-fixes.diff, #4791

Back to the top

Powered by Savane 3.12.
Corresponding source code