Improve readability

Author: martin-kolinek

src/Stack/Config.hs

@@ -792,13 +792,18 @@ resolvePackageLocation menv projRoot (PLRemote url remotePackageType) = do
                     throwM $ UnexpectedArchiveContents dirs files
         _ -> return dir
 
+-- | Remove path from package entry. If the package entry contains subdirs, then it removes
+-- the subdir. If the package entry points to the path to remove, this function returns
+-- Nothing. If the package entry doesn't mention the path to remove, it is returned unchanged
 removePathFromPackageEntry
     :: (StackMiniM env m, HasConfig env)
     => EnvOverride
     -> Path Abs Dir -- ^ project root
     -> Path Abs Dir -- ^ path to remove
     -> PackageEntry
     -> m (Maybe PackageEntry)
+    -- ^ Nothing if the whole package entry should be removed, otherwise
+    -- it returns the updated PackageEntry
 removePathFromPackageEntry menv projectRoot pathToRemove packageEntry = do
   locationPath <- resolvePackageLocation menv projectRoot (peLocation packageEntry)
   case peSubdirs packageEntry of

src/Stack/SDist.hs

@@ -375,7 +375,6 @@ checkPackageInExtractedTarball pkgDir = do
 
 buildExtractedTarball :: (StackM env m, HasEnvConfig env, MonadBaseUnlift IO m) => Path Abs Dir -> m ()
 buildExtractedTarball pkgDir = do
-  newPackagesRef <- liftIO (newIORef Nothing)
   projectRoot <- view projectRootL
   envConfig <- view envConfigL
   menv <- getMinimalEnvOverride
@@ -385,6 +384,7 @@ buildExtractedTarball pkgDir = do
         resolvedEntry <- resolvePackageEntry menv projectRoot entry
         return $ fmap fst resolvedEntry
   allPackagePaths <- fmap mconcat (mapM getPaths packageEntries)
+  -- We remove the path based on the name of the package
   let isPathToRemove path = do
         localPackage <- readLocalPackage path
         return $ packageName (lpPackage localPackage) == packageName (lpPackage localPackageToBuild)
@@ -394,6 +394,7 @@ buildExtractedTarball pkgDir = do
         return (catMaybes adjustedPackageEntries)
   entriesWithoutBuiltPackage <- foldM adjustPackageEntries packageEntries pathsToRemove
   let newEntry = PackageEntry Nothing (PLFilePath (toFilePath pkgDir)) []
+  newPackagesRef <- liftIO (newIORef Nothing)
   let adjustEnvForBuild env =
         let updatedEnvConfig = envConfig
               {envConfigPackagesRef = newPackagesRef