Copy edits for 'cygwin-ug-net/using-effectively.html' - patch and changelog entry

Copy edits for 'cygwin-ug-net/using-effectively.html' - patch and changelog entry

[korz_fred]

[-- Attachment #1: Type: text/plain, Size: 936 bytes --]

I was catching up on the documentation (which I last read years ago) and
as I read for content I spotted a few copy editing problems
(subject-verb agreement, "and" instead of "are", preposition and article
choice).

According to the archives the 'cygwin' list is the one to which to send
user guide patches. [Thread "Where to send corrections for user's manual
?", Igor Pechtchanski and Christopher Faylor, Oct 20, 2002].  Such
patches didn't fit any of the (other) lists.

Attached are (1) ChangeLog entry per the pointers in
http://cygwin.com/contrib.html and the GNU ChangeLog standards and (2)
unified diff against the anon cvs sources (as of about 2200GMT
20080626).

It's been quite a few years since I've last contributed to projects
(e.g. elisp manual in 1990s, gmake test builds, etc).
Given the overhead (pointer chasing, etc, etc), I hope these changes
make it into the tree and the online docs.

Fred


[-- Attachment #2: ChangeLog --]
[-- Type: application/octet-stream, Size: 142 bytes --]

	* using-effectively.html: Copy edits - subject-verb agreement,
	missing verb (typo), preposition and (definite vs indefinite)
	article use.
	

[-- Attachment #3: using-effectively.patch --]
[-- Type: application/octet-stream, Size: 2731 bytes --]

? using-effectively.patch
Index: using-effectively.html
===================================================================
RCS file: /cvs/cygwin/htdocs/cygwin-ug-net/using-effectively.html,v
retrieving revision 1.20
diff -u -p -r1.20 using-effectively.html
--- using-effectively.html	9 Dec 2007 09:38:46 -0000	1.20
+++ using-effectively.html	26 Jun 2008 21:21:53 -0000
@@ -49,15 +49,15 @@ which <span><strong class="command">cygp
 Since using quoting and subshells is somewhat awkward, it is often 
 preferable to use <span><strong class="command">cygpath</strong></span> in shell scripts.
 </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id324910"></a>Console Programs</h3></div></div></div><p>
-Another issue is receiving output from or giving input to the console-based 
+Another issue is receiving output from or giving input to console-based 
 Windows programs.  Unfortunately, interacting with Windows console 
 applications is not a simple matter of using a translation utility. Windows 
-console applications and designed to run under <span><strong class="command">command.com</strong></span> 
+console applications are designed to run under <span><strong class="command">command.com</strong></span> 
 or <span><strong class="command">cmd.exe</strong></span>, and some do not deal gracefully with other
 situations.  Cygwin can receive console input only if it
 is also running in a console (DOS box) since Windows does not provide
 any way to attach to the backend of the console device. Another
-traditional Unix input/output method, ptys (pseudo-terminals), are 
+traditional Unix input/output method, ptys (pseudo-terminals), is 
 supported by Cygwin but not entirely by Windows.  The basic problem is 
 that a Cygwin pty is a pipe and some Windows applications do not like 
 having their input or output redirected to pipes.  
@@ -65,8 +65,8 @@ having their input or output redirected 
 To help deal with these issues, Cygwin supports customizable levels of 
 Windows verses Unix compatibility behavior.  To be most compatible with 
 Windows programs, use a DOS prompt, running only the occasional Cygwin 
-command or script. Next would be to run <span><strong class="command">bash</strong></span> with 
-the default DOS box. To make Cygwin more Unix compatible in this case, 
+command or script. Next would be to run <span><strong class="command">bash</strong></span> within
+a default DOS box. To make Cygwin more Unix compatible in this case, 
 set <code class="envar">CYGWIN=tty</code> (see <a href="using-cygwinenv.html" title="The CYGWIN environment
 variable">the section called &#8220;The <code class="envar">CYGWIN</code> environment
 variable&#8221;</a>).

[-- Attachment #4: Type: text/plain, Size: 218 bytes --]

--
Unsubscribe info:      http://cygwin.com/ml/#unsubscribe-simple
Problem reports:       http://cygwin.com/problems.html
Documentation:         http://cygwin.com/docs.html
FAQ:                   http://cygwin.com/faq/

Re: Copy edits for 'cygwin-ug-net/using-effectively.html' - patch and changelog entry

[Brian Dessent]

korz_fred@emc.com wrote:

> Attached are (1) ChangeLog entry per the pointers in
> http://cygwin.com/contrib.html and the GNU ChangeLog standards and (2)
> unified diff against the anon cvs sources (as of about 2200GMT
> 20080626).

The HTML files are generated files, so you can't change the text there
as changes will just be overwritten the next time they're generated. 
The file you need to patch is winsup/doc/effectively.sgml.

Brian

--
Unsubscribe info:      http://cygwin.com/ml/#unsubscribe-simple
Problem reports:       http://cygwin.com/problems.html
Documentation:         http://cygwin.com/docs.html
FAQ:                   http://cygwin.com/faq/

Re: Copy edits for 'cygwin-ug-net/using-effectively.html' - patch and changelog entry

[Christopher Faylor]

On Thu, Jun 26, 2008 at 03:43:03PM -0700, Brian Dessent wrote:
>Fred Korz wrote:
>>Attached are (1) ChangeLog entry per the pointers in
>>http://cygwin.com/contrib.html and the GNU ChangeLog standards and (2)
>>unified diff against the anon cvs sources (as of about 2200GMT
>>20080626).
>
>The HTML files are generated files, so you can't change the text there
>as changes will just be overwritten the next time they're generated.
>The file you need to patch is winsup/doc/effectively.sgml.

The changes were small enough that I was able to adapt them to the
sgml sources.  They are checked in along with a slightly modified
ChangeLog.

Now I just have to figure out what to install to regenerate the pdf.

Thanks for the patch, Fred.

If I missed something please send another patch against the source
that Brian mentions above.  Documentation changes are always welcome.

cgf

--
Unsubscribe info:      http://cygwin.com/ml/#unsubscribe-simple
Problem reports:       http://cygwin.com/problems.html
Documentation:         http://cygwin.com/docs.html
FAQ:                   http://cygwin.com/faq/

Re: Copy edits for 'cygwin-ug-net/using-effectively.html' - patch and changelog entry

[Christopher Faylor]

On Thu, Jun 26, 2008 at 08:48:41PM -0400, Christopher Faylor wrote:
>On Thu, Jun 26, 2008 at 03:43:03PM -0700, Brian Dessent wrote:
>>Fred Korz wrote:
>>>Attached are (1) ChangeLog entry per the pointers in
>>>http://cygwin.com/contrib.html and the GNU ChangeLog standards and (2)
>>>unified diff against the anon cvs sources (as of about 2200GMT
>>>20080626).
>>
>>The HTML files are generated files, so you can't change the text there
>>as changes will just be overwritten the next time they're generated.
>>The file you need to patch is winsup/doc/effectively.sgml.
>
>The changes were small enough that I was able to adapt them to the
>sgml sources.  They are checked in along with a slightly modified
>ChangeLog.
>
>Now I just have to figure out what to install to regenerate the pdf.
>
>Thanks for the patch, Fred.
>
>If I missed something please send another patch against the source
>that Brian mentions above.  Documentation changes are always welcome.

One thing I apparently can't do is regenerate the pdf documentation
which looks like it was probably out of date anyway.

Can anyone rebuild the pdf files?

cgf

--
Unsubscribe info:      http://cygwin.com/ml/#unsubscribe-simple
Problem reports:       http://cygwin.com/problems.html
Documentation:         http://cygwin.com/docs.html
FAQ:                   http://cygwin.com/faq/