[newlib-cygwin] Cygwin: FAQ: convert ulinks to FAQ to xrefs

Corinna Vinschen corinna@sourceware.org
Fri Dec 2 21:42:06 GMT 2022


https://sourceware.org/git/gitweb.cgi?p=newlib-cygwin.git;h=cf65cbcea40bfd2be7c925641db37e23a9b473ae

commit cf65cbcea40bfd2be7c925641db37e23a9b473ae
Author:     Corinna Vinschen <corinna@vinschen.de>
AuthorDate: Fri Dec 2 22:38:47 2022 +0100
Commit:     Corinna Vinschen <corinna@vinschen.de>
CommitDate: Fri Dec 2 22:38:47 2022 +0100

    Cygwin: FAQ: convert ulinks to FAQ to xrefs
    
    Using ulinks here makes the result work on cygwin.com only, while
    xrefs to FAQs are creating realtive links.  Add xreflabel where
    appropriate.
    
    Signed-off-by: Corinna Vinschen <corinna@vinschen.de>

Diff:
---
 winsup/doc/faq-api.xml         |  9 ++++-----
 winsup/doc/faq-programming.xml |  9 ++++-----
 winsup/doc/faq-setup.xml       | 12 ++++++------
 winsup/doc/faq-using.xml       |  6 +++---
 4 files changed, 17 insertions(+), 19 deletions(-)

diff --git a/winsup/doc/faq-api.xml b/winsup/doc/faq-api.xml
index eecb84000b73..6b5824cf2799 100644
--- a/winsup/doc/faq-api.xml
+++ b/winsup/doc/faq-api.xml
@@ -32,22 +32,21 @@ User's Guide.
 
 <para>Starting December 2022, the old developer snapshots have been
 deprecated by regular, automated test releases.  See the next FAQ entry
-<ulink url="https://cygwin.com/faq/faq-api.html#faq.api.testrels"/>)
+<xref linkend="faq.api.testrels"></xref>
 </para>
 </answer></qandaentry>
 
-<qandaentry id="faq.api.testrels">
+<qandaentry id="faq.api.testrels" xreflabel="Test Releases">
 <question><para>Are test releases for the Cygwin library available?</para></question>
 <answer>
 
 <para>Yes.  Starting December 2022, regular, automated test releases
 are created whenever a considerable patch is pushed to the Cygwin git
-repo at
-<ulink url="https://cygwin.com/git/newlib-cygwin.git"/>.
+repo at <ulink url="https://cygwin.com/git/newlib-cygwin.git"/>.
 You can download the cygwin package test releases just like any other
 test release for any Cgywin package using the Cygwin Setup program.
 For more info, see
-<ulink url="https://cygwin.com/faq/faq-setup.html#faq.setup.testrels"/>
+<xref linkend="faq.setup.testrels"></xref>.
 </para>
 </answer></qandaentry>
 
diff --git a/winsup/doc/faq-programming.xml b/winsup/doc/faq-programming.xml
index 06dfb76f5613..632d1a173d66 100644
--- a/winsup/doc/faq-programming.xml
+++ b/winsup/doc/faq-programming.xml
@@ -357,7 +357,7 @@ package at runtime.
 <answer>
 
 <para>Beware of using non-portable shell features in your Makefiles (see tips
-at <ulink url="https://cygwin.com/faq/faq.html#faq.using.shell-scripts"/>).
+at <xref linkend="faq.using.shell-scripts"></xref>).
 </para>
 <para>Errors of <literal>make: execvp: /bin/sh: Illegal Argument</literal> or 
 <literal>make: execvp: /bin/sh: Argument list too long</literal> are often
@@ -671,7 +671,7 @@ rewriting the runtime library in question from specs...
 </para>
 </answer></qandaentry>
 
-<qandaentry id="faq.programming.building-cygwin">
+<qandaentry id="faq.programming.building-cygwin" xreflabel="Build Cygwin">
 <question><para>How do I build Cygwin on my own?</para></question>
 <answer>
 
@@ -766,12 +766,11 @@ operation e.g. when checking a pointer is valid)
 <para>
 It is also a good idea to use the latest code in case the bug has been fixed,
 so we recommend trying the latest cygwin test release (see
-<ulink url="https://cygwin.com/faq/faq-setup.html#faq.setup.testrels"/>)
-or building the DLL from git.
+<xref linkend="faq.setup.testrels"></xref>) or building the DLL from git.
 </para>
 
 <para>To build a debugging version of the Cygwin DLL, you will need to follow
-the instructions at <ulink url="https://cygwin.com/faq/faq.html#faq.programming.building-cygwin"/>.
+the instructions at <xref linkend="faq.programming.building-cygwin"></xref>.
 </para>
 
 <para>
diff --git a/winsup/doc/faq-setup.xml b/winsup/doc/faq-setup.xml
index 981a7246a036..15ae84c50f17 100644
--- a/winsup/doc/faq-setup.xml
+++ b/winsup/doc/faq-setup.xml
@@ -23,7 +23,7 @@ is available on using the Cygwin Setup program.
 <para>If you do it any other way, you're on your own!
 If something doesn't work right for you, and it's not covered here or in
 the latest Cygwin test package (see
-<ulink url="https://cygwin.com/faq/faq-api.html#faq.api.testrels"/>),
+<xref linkend="faq.setup.testrels"></xref>),
 then by all means report it to the mailing list.
 </para>
 <para>For a searchable list of packages that can be installed with Cygwin,
@@ -183,7 +183,7 @@ and that installing the older version will not help improve Cygwin.
 </para>
 </answer></qandaentry>
 
-<qandaentry id="faq.setup.install-security">
+<qandaentry id="faq.setup.install-security" xreflable="Secure Installation">
 <question><para>How does Cygwin secure the installation and update process?</para></question>
 <answer>
 
@@ -292,7 +292,7 @@ We also provide automatic mechanisms
 do not want to perform the signature checking on the Cygwin Setup program itself.
 Once the correct Setup program is running, it will counter other attacks
 as described in
-<ulink url="https://cygwin.com/faq/faq.html#faq.setup.install-security"/>.
+<xref linkend="faq.setup.install-security"></xref>.
 </para>
 </answer></qandaentry>
 
@@ -339,12 +339,12 @@ disk if you are paranoid.
 <para>This should be safe, but only if the Cygwin Setup program is not substituted by
 something malicious.
 See also
-<ulink url="https://cygwin.com/faq/faq.html#faq.setup.install-security"/>
+<xref linkend="faq.setup.install-security"></xref>
 for a description of how the
 Cygwin project counters man-in-the-middle (MITM) attacks.
 </para>
 
-<para>See also <ulink url="https://cygwin.com/faq/faq.html#faq.using.bloda"/>
+<para>See also <xref linkend="faq.using.bloda"></xref>
 for a list of applications that have been known, at one time or another, to
 interfere with the normal functioning of Cygwin.
 </para>
@@ -627,7 +627,7 @@ directory has been stored in the registry at all.
 
 </answer></qandaentry>
 
-<qandaentry id="faq.setup.testrels">
+<qandaentry id="faq.setup.testrels" xreflabel="Install Test Releases">
 <question><para>How do I install Cygwin test releases?</para></question>
 <answer>
 
diff --git a/winsup/doc/faq-using.xml b/winsup/doc/faq-using.xml
index ea5f5a797dfa..e6a1a7c3f819 100644
--- a/winsup/doc/faq-using.xml
+++ b/winsup/doc/faq-using.xml
@@ -401,7 +401,7 @@ for more information on how Cygwin maps Windows permissions.
 </para>
 </answer></qandaentry>
 
-<qandaentry id="faq.using.shell-scripts">
+<qandaentry id="faq.using.shell-scripts" xreflabel="Using Shell Scripts">
 <question><para>Why doesn't my shell script work?</para></question>
 <answer>
 
@@ -743,7 +743,7 @@ of poorly written firewall-type software that causes things to break.
 Note that with many of these products, simply disabling the firewall
 does not remove these changes; it must be completely uninstalled.
 </para>
-<para>See also <ulink url="https://cygwin.com/faq/faq.html#faq.using.bloda"/>
+<para>See also <xref linkend="faq.using.bloda"></xref>
 for a list of applications that have been known, at one time or another, to 
 interfere with the normal functioning of Cygwin.
 </para>
@@ -891,7 +891,7 @@ contents are exempt from scanning.  In a default installation, this
 would be <literal>C:\cygwin\bin</literal>.  Obviously, this could be
 exploited by a hostile non-Cygwin program, so do this at your own risk.
 </para>
-<para>See also <ulink url="https://cygwin.com/faq/faq.html#faq.using.bloda"/>
+<para>See also <xref linkend="faq.using.bloda"></xref>
 for a list of applications that have been known, at one time or another, to
 interfere with the normal functioning of Cygwin.
 </para>


More information about the Cygwin-cvs mailing list