summaryrefslogtreecommitdiff
path: root/docs/users_guide/win32-dlls.rst
diff options
context:
space:
mode:
authorBen Gamari <bgamari.foss@gmail.com>2018-05-07 14:43:45 -0400
committerBen Gamari <ben@smart-cactus.org>2018-05-08 10:50:38 -0400
commit37acca7ecea6a7365a52ec92f864f25fa179095a (patch)
treeb39513f1817f86df30b2c424a5ffd704bd0a7ea6 /docs/users_guide/win32-dlls.rst
parentaa03ad885373f82c008ae7d75206f5305c395b61 (diff)
downloadhaskell-37acca7ecea6a7365a52ec92f864f25fa179095a.tar.gz
users-guide: Move discussion MAX_PATH out of release notes
This discussion will be useful for users; move it into the users-guide proper. Also fixes a few typos noted by @Phyx. Test Plan: Read it Reviewers: Phyx Reviewed By: Phyx Subscribers: dfeuer, Phyx, rwbarton, thomie, carter Differential Revision: https://phabricator.haskell.org/D4420
Diffstat (limited to 'docs/users_guide/win32-dlls.rst')
-rw-r--r--docs/users_guide/win32-dlls.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/users_guide/win32-dlls.rst b/docs/users_guide/win32-dlls.rst
index 26c3ffe3b0..4ecdd10f72 100644
--- a/docs/users_guide/win32-dlls.rst
+++ b/docs/users_guide/win32-dlls.rst
@@ -97,6 +97,52 @@ Windows.
``IOExts.hSetBinaryMode``. The ``IOExts`` module is part of the
``lang`` package.
+.. _windows-file-paths:
+
+File paths under Windows
+------------------------
+
+Windows paths are not all the same. The different kinds of paths each have
+different meanings. The ``MAX_PATH`` limitation is not a limitation of the operating
+system nor the file system. It is a limitation of the default namespace enforced
+by the Win32 API for backwards compatibility.
+
+The NT kernel however allows you ways to opt out of this path preprocessing by
+the Win32 APIs. This is done by explicitly using the desired namespace in the
+path.
+
+The namespaces are:
+
+ - file namespace: ``\\?\``
+ - device namespace: ``\\.\``
+ - NT namespace: ``\``
+
+Each of these turn off path processing completely by the Win32 API and the paths
+are passed untouched to the filesystem.
+
+Paths with a drive letter are *legacy* paths. The drive letters are actually
+meaningless to the kernel. Just like Unix operating systems, drive letters are
+just a mount point. You can view your mount points by using the :command:`mountvol`
+command.
+
+Since GHC 8.6.1, the Haskell I/O manager automatically promotes paths in the legacy
+format to Win32 file namespace. By default the I/O manager will do two things to
+your paths:
+
+ - replace ``\`` with ``\\``
+ - expand relative paths to absolute paths
+
+If you want to opt out of all preprocessing just expliticly use namespaces in
+your paths. Due to this change, if you need to open raw devices (e.g. COM ports)
+you need to use the device namespace explicitly. (e.g. ``\\.\COM1``). GHC and
+Haskell programs in general no longer support opening devices in the legacy
+format.
+
+See the
+`Windows documentation <https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247.aspx>`_
+for more details.
+
+
.. _ghci-cygwin:
Using GHC (and other GHC-compiled executables) with Cygwin