Skip to content

Commit 556e0a9

Browse files
committed
remote: fix GC haddock, add more
1 parent 40e057b commit 556e0a9

File tree

1 file changed

+3
-1
lines changed
  • hnix-store-remote/src/System/Nix/Store/Remote/Types

1 file changed

+3
-1
lines changed

hnix-store-remote/src/System/Nix/Store/Remote/Types/GC.hs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,15 @@ import Data.Word (Word64)
1313
import GHC.Generics (Generic)
1414
import System.Nix.StorePath (StorePath)
1515

16+
-- | Garbage collection action
1617
data GCAction
1718
= GCAction_ReturnLive -- ^ Return the set of paths reachable from roots (closure)
1819
| GCAction_ReturnDead -- ^ Return unreachable paths
1920
| GCAction_DeleteDead -- ^ Delete unreachable paths
2021
| GCAction_DeleteSpecific -- ^ Delete specified paths
2122
deriving (Bounded, Eq, Enum, Generic, Ord, Show)
2223

23-
-- | Garbage collector operation options
24+
-- | Garbage collector operation options
2425
data GCOptions = GCOptions
2526
{ -- | Operation
2627
gcOptions_operation :: GCAction
@@ -32,6 +33,7 @@ data GCOptions = GCOptions
3233
, gcOptions_maxFreed :: Integer
3334
} deriving (Eq, Generic, Ord, Show)
3435

36+
-- | Result of the garbage collection operation
3537
data GCResult = GCResult
3638
{ -- | Depending on the action, the GC roots,
3739
-- or the paths that would be or have been deleted

0 commit comments

Comments
 (0)