Merge pull request #651 from IntersectMBO/wenkokke/haddock-not-home

doc: add `not-home` to all internal modules

Author: wenkokke

src/Database/LSMTree/Internal/Assertions.hs

@@ -1,5 +1,7 @@
 {-# LANGUAGE CPP       #-}
 {-# LANGUAGE MagicHash #-}
+{-# OPTIONS_HADDOCK not-home #-}
+
 module Database.LSMTree.Internal.Assertions (
     assert,
     isValidSlice,

src/Database/LSMTree/Internal/BitMath.hs

@@ -1,3 +1,5 @@
+{-# OPTIONS_HADDOCK not-home #-}
+
 -- | Some arithmetic implemented using bit operations
 --
 -- Valid for non-negative arguments.

src/Database/LSMTree/Internal/BlobFile.hs

@@ -1,4 +1,6 @@
 {-# LANGUAGE TypeFamilies #-}
+{-# OPTIONS_HADDOCK not-home #-}
+
 module Database.LSMTree.Internal.BlobFile (
     BlobFile (..)
   , BlobSpan (..)

src/Database/LSMTree/Internal/BlobRef.hs

@@ -2,7 +2,7 @@
 {-# LANGUAGE DeriveGeneric      #-}
 {-# LANGUAGE DerivingStrategies #-}
 {-# LANGUAGE TypeFamilies       #-}
-
+{-# OPTIONS_HADDOCK not-home #-}
 {- HLINT ignore "Use unless" -}
 
 module Database.LSMTree.Internal.BlobRef (

src/Database/LSMTree/Internal/BloomFilter.hs

@@ -1,3 +1,5 @@
+{-# OPTIONS_HADDOCK not-home #-}
+
 module Database.LSMTree.Internal.BloomFilter (
   bloomFilterToLBS,
   bloomFilterFromSBS,

src/Database/LSMTree/Internal/BloomFilterQuery1.hs

@@ -2,6 +2,8 @@
 {-# LANGUAGE MagicHash       #-}
 {-# LANGUAGE PatternSynonyms #-}
 {-# LANGUAGE UnboxedTuples   #-}
+{-# OPTIONS_HADDOCK not-home #-}
+
 module Database.LSMTree.Internal.BloomFilterQuery1 (
   bloomQueries,
   RunIxKeyIx(RunIxKeyIx),

src/Database/LSMTree/Internal/BloomFilterQuery2.hs

@@ -2,11 +2,12 @@
 {-# LANGUAGE PatternSynonyms     #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE UnboxedTuples       #-}
+{-# OPTIONS_HADDOCK not-home #-}
 
-{-# OPTIONS_GHC -O2 -fregs-iterative -fmax-inline-alloc-size=512 #-}
 -- The use of -fregs-iterative here does a better job in the hot loop for
 -- the bloomQueriesBody below. It eliminates all spilling to the stack.
 -- There's just 6 stack reads in the loop now, no writes.
+{-# OPTIONS_GHC -O2 -fregs-iterative -fmax-inline-alloc-size=512 #-}
 
 -- | An implementation of batched bloom filter query, optimised for memory
 -- prefetch.

src/Database/LSMTree/Internal/ByteString.hs

@@ -1,7 +1,10 @@
 {-# LANGUAGE CPP           #-}
 {-# LANGUAGE MagicHash     #-}
 {-# LANGUAGE UnboxedTuples #-}
+{-# OPTIONS_HADDOCK not-home #-}
+
 -- | @bytestring@ extras
+--
 module Database.LSMTree.Internal.ByteString (
     tryCheapToShort,
     tryGetByteArray,

src/Database/LSMTree/Internal/CRC32C.hs

@@ -2,6 +2,7 @@
 {-# LANGUAGE MagicHash           #-}
 {-# LANGUAGE OverloadedStrings   #-}
 {-# LANGUAGE ScopedTypeVariables #-}
+{-# OPTIONS_HADDOCK not-home #-}
 
 -- Needed by GHC <= 9.2 for newtype deriving Prim below
 {-# LANGUAGE DataKinds           #-}

src/Database/LSMTree/Internal/ChecksumHandle.hs

@@ -1,3 +1,5 @@
+{-# OPTIONS_HADDOCK not-home #-}
+
 module Database.LSMTree.Internal.ChecksumHandle
   (
     -- * Checksum handles