[PATCH v3] Clarify FAQ 1.5 What version of Cygwin is this, anyway?

[PATCH v3] Clarify FAQ 1.5 What version of Cygwin is this, anyway?

[Brian Inglis]

Patch to:
	https://cygwin.com/git/?p=cygwin-htdocs.git;f=faq/faq.html;hb=HEAD
as a result of thread:
	https://cygwin.com/pipermail/cygwin/2020-July/245442.html
and comments:
	https://cygwin.com/pipermail/cygwin-patches/2020q3/010331.html

Relate Cygwin DLL to Unix kernel,
add required options to command examples,
differentiate Unix and Cygwin commands;
mention that the cygwin package contains the DLL.
---
 faq/faq.html | 49 +++++++++++++++++++++++++++++++++----------------
 1 file changed, 33 insertions(+), 16 deletions(-)

diff --git a/faq/faq.html b/faq/faq.html
index 1f2686c6..8659db5d 100644
--- a/faq/faq.html
+++ b/faq/faq.html
@@ -53,22 +53,39 @@ such freedom is that the people who use a given piece of software
 should be able to change it to fit their needs, learn from it, share
 it with their friends, etc.  The GPL or LGPL licenses allows you those
 freedoms, so it is free software.
-</p></td></tr><tr class="question"><td align="left" valign="top"><a name="faq.what.version"></a><p><b>1.5.</b></p></td><td align="left" valign="top"><p>What version of Cygwin <span class="emphasis"><em>is</em></span> this, anyway?</p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>To find the version of the Cygwin DLL installed, you can use
-<code class="filename">uname</code> as on Linux or <code class="filename">cygcheck</code>. Refer to each command's
-<code class="literal">--help</code> output and the
-<a class="ulink" href="https://cygwin.com/cygwin-ug-net/" target="_top">Cygwin User's Guide</a>
-for more information.
-</p><p>If you are looking for the version number for the whole Cygwin
-release, there is none. Each package in the Cygwin release has its own
-version.  The packages in Cygwin are continually improving, thanks to
-the efforts of net volunteers who maintain the Cygwin binary ports.
-Each package has its own version numbers and its own release process.
+</p></td></tr>
+<tr class="question"><td align="left" valign="top"><a name="faq.what.version"></a><p><b>1.5.</b></p></td>
+    <td align="left" valign="top"><p>What version of Cygwin <span class="emphasis"><em>is</em></span> this, anyway?</p></td></tr>
+<tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top">
+    <p>To find the version of the Cygwin DLL installed,
+	you can use:
+	<code class="command"><strong>uname&nbsp;-a</strong></code>;
+        as you would for a Unix kernel.
+        As the Cygwin DLL takes the place of a Unix kernel,
+	you can also use any of the Unix compatible commands:
+	<code class="command"><strong>uname&nbsp;-srvm</strong></code>;
+	<code class="command"><strong>head&nbsp;/proc/version</strong></code>;
+	or the Cygwin command:
+	<code class="command"><strong>cygcheck&nbsp;-V</strong></code>.
+	Refer to each command's
+	<code class="option">--help</code> output or the
+	<a class="ulink" href="https://cygwin.com/cygwin-ug-net/" target="_top">Cygwin User's Guide</a>
+	for more information.</p>
+    <p>If you are looking for the version number for the whole Cygwin release,
+	there is none.
+	Each package in the Cygwin release has its own version, and the
+	<code class="package">cygwin</code> package containing the Cygwin DLL
+	and Cygwin system specific utilities is just another (but very
+	important!) package.
+	The packages in Cygwin are continually improving, thanks to
+	the efforts of net volunteers who maintain the Cygwin binary ports.
+	Each package has its own version numbers and its own release process.
 </p><p>So, how do you get the most up-to-date version of Cygwin?  Easy.  Just
 download the Cygwin Setup program by following the instructions
 <a class="ulink" href="https://cygwin.com/install.html" target="_top">here</a>.
-The setup program will handle the task of updating the packages on your system
-to the latest version. For more information about using Cygwin's
-<code class="filename">setup.exe</code>, see 
+The Setup program will handle the task of updating the packages on your system
+to the latest version. For more information about using Cygwin's Setup program,
+see 
 <a class="ulink" href="https://cygwin.com/cygwin-ug-net/setup-net.html" target="_top">Setting Up Cygwin</a>
 in the Cygwin User's Guide. 
 </p></td></tr><tr class="question"><td align="left" valign="top"><a name="faq.what.who"></a><p><b>1.6.</b></p></td><td align="left" valign="top"><p>Who's behind the project?</p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p><span class="bold"><strong>(Please note that if you have cygwin-specific
@@ -692,7 +709,8 @@ user with <code class="literal">cygrunsrv -u</code> (see
 information).
 </p></td></tr><tr class="question"><td align="left" valign="top"><a name="faq.using.path"></a><p><b>4.5.</b></p></td><td align="left" valign="top"><p>How should I set my PATH?</p></td></tr><tr class="answer"><td align="left" valign="top"></td><td align="left" valign="top"><p>This is done for you in the file /etc/profile, which is sourced by bash
 when you start it from the Desktop or Start Menu shortcut, created by
-<code class="literal">setup.exe</code>.  The line is
+the Cygwin Setup program.
+The line is
 </p><pre class="screen">
 	PATH="/usr/local/bin:/usr/bin:/bin:$PATH"
 </pre><p>Effectively, this <span class="bold"><strong>prepends</strong></span> /usr/local/bin and /usr/bin to your
@@ -889,8 +907,7 @@ services like sshd) beforehand.</p><p>The only DLL that is sanctioned by the Cyg
 you get by running <a class="ulink" href="https://cygwin.com/install.html" target="_top">setup-x86.exe or setup-x86_64.exe</a>,
 installed in a directory controlled by this program.  If you have other
 versions on your system and desire help from the cygwin project, you should
-delete or rename all DLLs that are not installed by
-<code class="filename">setup.exe</code>.
+delete or rename all DLLs that are not installed by the Cygwin Setup program.
 </p><p>If you're trying to find multiple versions of the DLL that are causing
 this problem, reboot first, in case DLLs still loaded in memory are the
 cause.  Then use the Windows System find utility to search your whole
-- 
2.27.0

Re: [PATCH v3] Clarify FAQ 1.5 What version of Cygwin is this, anyway?

[Corinna Vinschen]

Hi Brian,

On Jul 10 11:34, Brian Inglis wrote:
> Patch to:
> 	https://cygwin.com/git/?p=cygwin-htdocs.git;f=faq/faq.html;hb=HEAD
> as a result of thread:
> 	https://cygwin.com/pipermail/cygwin/2020-July/245442.html
> and comments:
> 	https://cygwin.com/pipermail/cygwin-patches/2020q3/010331.html
> 
> Relate Cygwin DLL to Unix kernel,
> add required options to command examples,
> differentiate Unix and Cygwin commands;
> mention that the cygwin package contains the DLL.
> ---
>  faq/faq.html | 49 +++++++++++++++++++++++++++++++++----------------
>  1 file changed, 33 insertions(+), 16 deletions(-)
> 
> diff --git a/faq/faq.html b/faq/faq.html
> index 1f2686c6..8659db5d 100644
> --- a/faq/faq.html
> +++ b/faq/faq.html

Huh?  This file doesn't exist in the repo.  The path is not relative to
the repo root, and the file is called faq-what.xml.  Can you please
check this again?


Thanks,
Corinna

-- 
Corinna Vinschen
Cygwin Maintainer

Re: [PATCH v3] Clarify FAQ 1.5 What version of Cygwin is this, anyway?

[Brian Inglis]

On 2020-07-13 01:04, Corinna Vinschen wrote:
> On Jul 10 11:34, Brian Inglis wrote:
>> Patch to:
>> 	https://cygwin.com/git/?p=cygwin-htdocs.git;f=faq/faq.html;hb=HEAD
>> as a result of thread:
>> 	https://cygwin.com/pipermail/cygwin/2020-July/245442.html
>> and comments:
>> 	https://cygwin.com/pipermail/cygwin-patches/2020q3/010331.html
>>
>> Relate Cygwin DLL to Unix kernel,
>> add required options to command examples,
>> differentiate Unix and Cygwin commands;
>> mention that the cygwin package contains the DLL.
>> ---
>>  faq/faq.html | 49 +++++++++++++++++++++++++++++++++----------------
>>  1 file changed, 33 insertions(+), 16 deletions(-)
>>
>> diff --git a/faq/faq.html b/faq/faq.html
>> index 1f2686c6..8659db5d 100644
>> --- a/faq/faq.html
>> +++ b/faq/faq.html
> 
> Huh?  This file doesn't exist in the repo.  The path is not relative to
> the repo root, and the file is called faq-what.xml.  Can you please
> check this again?

See top. So does:

	https://cygwin.com/git/?p=cygwin-htdocs.git;f=faq/faq.html

get generated from:

https://cygwin.com/git/?p=newlib-cygwin.git;a=blob;f=winsup/doc/faq-what.xml

which is where I should be making FAQ patches?
I was looking around for FAQ files and this connection between cygwin-doc and
cygwin-htdocs was not obvious.

-- 
Take care. Thanks, Brian Inglis, Calgary, Alberta, Canada

This email may be disturbing to some readers as it contains
too much technical detail. Reader discretion is advised.
[Data in IEC units and prefixes, physical quantities in SI.]

Re: [PATCH v3] Clarify FAQ 1.5 What version of Cygwin is this, anyway?

[Corinna Vinschen]

On Jul 13 06:06, Brian Inglis wrote:
> On 2020-07-13 01:04, Corinna Vinschen wrote:
> > On Jul 10 11:34, Brian Inglis wrote:
> >> Patch to:
> >> 	https://cygwin.com/git/?p=cygwin-htdocs.git;f=faq/faq.html;hb=HEAD
> >> as a result of thread:
> >> 	https://cygwin.com/pipermail/cygwin/2020-July/245442.html
> >> and comments:
> >> 	https://cygwin.com/pipermail/cygwin-patches/2020q3/010331.html
> >>
> >> Relate Cygwin DLL to Unix kernel,
> >> add required options to command examples,
> >> differentiate Unix and Cygwin commands;
> >> mention that the cygwin package contains the DLL.
> >> ---
> >>  faq/faq.html | 49 +++++++++++++++++++++++++++++++++----------------
> >>  1 file changed, 33 insertions(+), 16 deletions(-)
> >>
> >> diff --git a/faq/faq.html b/faq/faq.html
> >> index 1f2686c6..8659db5d 100644
> >> --- a/faq/faq.html
> >> +++ b/faq/faq.html
> > 
> > Huh?  This file doesn't exist in the repo.  The path is not relative to
> > the repo root, and the file is called faq-what.xml.  Can you please
> > check this again?
> 
> See top. So does:
> 
> 	https://cygwin.com/git/?p=cygwin-htdocs.git;f=faq/faq.html
> 
> get generated from:
> 
> https://cygwin.com/git/?p=newlib-cygwin.git;a=blob;f=winsup/doc/faq-what.xml
> 
> which is where I should be making FAQ patches?

Exactly.  cygwin-htdocs is just an upload area for the cygwin website.


Thanks,
Corinna

-- 
Corinna Vinschen
Cygwin Maintainer