Skip to content

Commit e652832

Browse files
committed
Add information about the content of the snapshots directory
1 parent 9016151 commit e652832

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/GUIDE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -730,6 +730,16 @@ The reason we have this structure is that:
730730
As you probably guessed, there can be multiple snapshot databases available. See
731731
the contents of the `snapshots` directory in the Stack root.
732732

733+
* On Unix-like operating systems, each snapshot is in the last of a sequence of
734+
three subdirectories named after the platform, a 256-bit hash of the source
735+
map (how the package should be built -- including the compiler, options, and
736+
immutable dependencies), and the GHC version.
737+
738+
* On Windows, each snapshot is in a subdirectory that is a shorter hash (eight
739+
characters) of the sequence of three directories used on Unix-like operating
740+
systems. This is done to avoid problems created by default limits on file
741+
path lengths on Windows systems.
742+
733743
These snapshot databases don't get layered on top of each other; they are each
734744
used separately.
735745

0 commit comments

Comments
 (0)