Skip to content

Commit 9d303f2

Browse files
committed
Add more docs for contents of pantry/hackage
1 parent 936fa7a commit 9d303f2

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

doc/stack_root.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -166,9 +166,18 @@ it, Stack will recreate the contents of the directory.
166166

167167
### `pantry\hackage` directory
168168

169-
This contains the package index. If the contents of the directory are deleted,
170-
and Stack needs to consult the package index, Stack will seek to download the
171-
latest package index.
169+
This contains a local cache of the package index. If the contents of the
170+
directory are deleted, and Stack needs to consult the package index, Stack will
171+
seek to download the latest package index.
172+
173+
!!! info
174+
175+
Stack depends on package `pantry` which, in turn, depends on package
176+
`hackage-security`. The latter handles the local cache of the package index.
177+
The type `CacheLayout` represents the location of the files that are cached.
178+
`pantry` uses `cabalCacheLayout :: CacheLayout`, the layout that Cabal (the
179+
tool) uses. That is what specifies the names of the files used to cache the
180+
package index, including `00-index.tar` and `00-index.tar.gz`.
172181

173182
### `pantry` directory
174183

0 commit comments

Comments
 (0)