aboutsummaryrefslogtreecommitdiff
path: root/winsup/doc/cygwinenv.xml
diff options
context:
space:
mode:
authorCorinna Vinschen <corinna@vinschen.de>2013-05-23 14:26:53 +0000
committerCorinna Vinschen <corinna@vinschen.de>2013-05-23 14:26:53 +0000
commit6d383d0fded9d23dfd0cb5e0e21dab45e8863f3d (patch)
tree966c8ebf606d018184a971ce8cb7f90a9be36bfb /winsup/doc/cygwinenv.xml
parent33cb946e7ee09ba7725b383e55bbdc1ca441e62f (diff)
downloadnewlib-6d383d0fded9d23dfd0cb5e0e21dab45e8863f3d.zip
newlib-6d383d0fded9d23dfd0cb5e0e21dab45e8863f3d.tar.gz
newlib-6d383d0fded9d23dfd0cb5e0e21dab45e8863f3d.tar.bz2
* cygwinenv.xml (cygwinenv-implemented-options): Explain new
winsymliks:nativestrict option. Strip out description of symlink types and refer to new pathnames-symlinks section. * highlights.xml (ov-hi-files): Rip out most of symlink description and refer to new pathnames-symlinks section instead. * new-features.xml (ov-new1.7.19): Add CYGWIN=winsymlinks:nativestrict. * pathnames.xml (pathnames-symlinks): New section describing symbolic link handling.
Diffstat (limited to 'winsup/doc/cygwinenv.xml')
-rw-r--r--winsup/doc/cygwinenv.xml37
1 files changed, 19 insertions, 18 deletions
diff --git a/winsup/doc/cygwinenv.xml b/winsup/doc/cygwinenv.xml
index 0ba5def..a6d0eaa 100644
--- a/winsup/doc/cygwinenv.xml
+++ b/winsup/doc/cygwinenv.xml
@@ -82,26 +82,27 @@ time and when handles are inherited. Defaults to set.</para>
</listitem>
<listitem>
-<para><envar>winsymlinks:{lnk,native}</envar> - if set to just
+<para><envar>winsymlinks:{lnk,native,nativestrict}</envar> - if set to just
<literal>winsymlinks</literal> or <literal>winsymlinks:lnk</literal>,
Cygwin creates symlinks as Windows shortcuts with a special header and
-the R/O attribute set. If set to <literal>winsymlinks:native</literal>,
-Cygwin creates symlinks as native Windows symlinks as supported by NTFS
-since Windows Vista/2008.
-
-If not set, Cygwin creates symlinks as plain files with a magic number,
-a path and the DOS SYSTEM attribute set by default, unless this is not
-supported by the underlying filesystem. For instance, on MVFS symlinks
-are always created as Windows shortcuts, because it doesn't support the
-DOS SYSTEM attribute, on AFS always as native symlink because it doesn't
-support DOS attributes. On NFS, symlinks are always created as native
-symlinks of the underlying filesystem.
-</para>
-
-<para>Please note that symlinks created under Cygwin 1.7 or later are
-not readable by older Cygwin releases because the new symlinks use UTF-16
-to encode the target filename, while the old symlinks used the current
-ANSI or OEM charset.</para>
+the R/O attribute set.</para>
+
+<para>If set to <literal>winsymlinks:native</literal> or
+<literal>winsymlinks:nativestrict</literal>, Cygwin creates symlinks as
+native Windows symlinks on filesystems and OS versions supporting them.
+If the OS is known not to support native symlinks (Windows XP, Windows
+Server 2003), a warning message is produced once per session.</para>
+
+<para>The difference between <literal>winsymlinks:native</literal> and
+<literal>winsymlinks:nativestrict</literal> is this: If the filesystem
+supports native symlinks and Cygwin fails to create a native symlink for
+some reason, it will fall back to creating Cygwin default symlinks
+with <literal>winsymlinks:native</literal>, while with
+<literal>winsymlinks:nativestrict</literal> the <literal>symlink(2)</literal>
+system call will immediately fail.</para>
+
+<para>For more information on symbolic links, see
+<xref linkend="pathnames-symlinks"></xref>.</para>
</listitem>
</itemizedlist>