multiple -m

sync, assist, import: Allow -m option to be specified multiple times, to
provide additional paragraphs for the commit message.

The option parser didn't allow multiple -m before, so there is no risk of
behavior change breaking something that was for some reason using multiple
-m already.

Pass through to git commands, so that the method used to assemble the
paragrahs is whatever git does. Which might conceivably change in the
future.

Note that git commit-tree has supported -m since git 1.7.7. commitTree
was probably not using it since it predates that version. Since the
configure script prevents building git-annex with git older than 2.1,
there is no risk that it's not supported now.

Sponsored-by: Nicholas Golder-Manning on Patreon

diff --git a/Annex/AdjustedBranch.hs b/Annex/AdjustedBranch.hs
index a7b6f03ed7e55ec2459d959d57ef8c3443b9ee5d..c545930133f08ea3e6ae3e7d65fda89e12740bb2 100644 (file)
--- a/Annex/AdjustedBranch.hs
+++ b/Annex/AdjustedBranch.hs
@@ -469,7 +469,7 @@ commitAdjustedTree' treesha (BasisBranch basis) parents =
                        (commitCommitterMetaData basiscommit)
                        (mkcommit cmode)
        mkcommit cmode = Git.Branch.commitTree cmode
-               adjustedBranchCommitMessage parents treesha
+               [adjustedBranchCommitMessage] parents treesha
 
 {- This message should never be changed. -}
 adjustedBranchCommitMessage :: String
@@ -577,7 +577,7 @@ reverseAdjustedCommit commitparent adj (csha, basiscommit) origbranch
                        (commitAuthorMetaData basiscommit)
                        (commitCommitterMetaData basiscommit) $
                                Git.Branch.commitTree cmode
-                                       (commitMessage basiscommit)
+                                       [commitMessage basiscommit]
                                        [commitparent] treesha
                return (Right revadjcommit)
 

diff --git a/Annex/AdjustedBranch/Merge.hs b/Annex/AdjustedBranch/Merge.hs
index 26ab0e7e3ed41cdaa8e61c32b3aaf02c55f30045..904f4ee41280ec5cff45de414e82aa9b2eeaccfd 100644 (file)
--- a/Annex/AdjustedBranch/Merge.hs
+++ b/Annex/AdjustedBranch/Merge.hs
@@ -153,7 +153,8 @@ mergeToAdjustedBranch tomerge (origbranch, adj) mergeconfig canresolvemerge comm
                        then do
                                cmode <- annexCommitMode <$> Annex.getGitConfig
                                c <- inRepo $ Git.Branch.commitTree cmode
-                                       ("Merged " ++ fromRef tomerge) [adjmergecommit]
+                                       ["Merged " ++ fromRef tomerge]
+                                       [adjmergecommit]
                                        (commitTree currentcommit)
                                inRepo $ Git.Branch.update "updating adjusted branch" currbranch c
                                propigateAdjustedCommits origbranch adj

diff --git a/Annex/Branch.hs b/Annex/Branch.hs
index 9b5365b4567a2b941dfd3fd0b78ce88c864c4a45..bcc9ae114dedbb4f84f4196ee362257378fdcd6f 100644 (file)
--- a/Annex/Branch.hs
+++ b/Annex/Branch.hs
@@ -945,9 +945,9 @@ rememberTreeishLocked treeish graftpoint jl = do
        addedt <- inRepo $ Git.Tree.graftTree treeish graftpoint origtree
        cmode <- annexCommitMode <$> Annex.getGitConfig
        c <- inRepo $ Git.Branch.commitTree cmode
-               "graft" [branchref] addedt
+               ["graft"] [branchref] addedt
        c' <- inRepo $ Git.Branch.commitTree cmode
-               "graft cleanup" [c] origtree
+               ["graft cleanup"] [c] origtree
        inRepo $ Git.Branch.update' fullname c'
        -- The tree in c' is the same as the tree in branchref,
        -- and the index was updated to that above, so it's safe to

diff --git a/Annex/Import.hs b/Annex/Import.hs
index eaf41f4f79d5245c7aac6a0eeeae7669c8ad662e..27787403824930b0d87ce89bed551055a2eb5d41 100644 (file)
--- a/Annex/Import.hs
+++ b/Annex/Import.hs
@@ -86,7 +86,7 @@ data ImportCommitConfig = ImportCommitConfig
        { importCommitTracking :: Maybe Sha
        -- ^ Current commit on the remote tracking branch.
        , importCommitMode :: Git.Branch.CommitMode
-       , importCommitMessage :: String
+       , importCommitMessages :: [String]
        }
 
 {- Buils a commit for an import from a special remote.
@@ -251,7 +251,7 @@ buildImportCommit' remote importcommitconfig mtrackingcommit imported@(History t
 
        mkcommit parents tree = inRepo $ Git.Branch.commitTree
                (importCommitMode importcommitconfig)
-               (importCommitMessage importcommitconfig)
+               (importCommitMessages importcommitconfig)
                parents
                tree
 

diff --git a/Annex/RemoteTrackingBranch.hs b/Annex/RemoteTrackingBranch.hs
index ade303e02d7fa914564edaadafc896259ef6ff18..06591d091878345a66c5a6d75e0a3d09be9b006f 100644 (file)
--- a/Annex/RemoteTrackingBranch.hs
+++ b/Annex/RemoteTrackingBranch.hs
@@ -77,7 +77,7 @@ makeRemoteTrackingBranchMergeCommit' commitsha importedhistory treesha = do
        cmode <- annexCommitMode <$> Annex.getGitConfig
        inRepo $ Git.Branch.commitTree
                        cmode
-                       "remote tracking branch"
+                       ["remote tracking branch"]
                        [commitsha, importedhistory]
                        treesha
 

diff --git a/Annex/View.hs b/Annex/View.hs
index b47e34564b0a026817c35d130f3073455514782f..7372287380d6e65f1fe5ae55ff9989c02df1ed00 100644 (file)
--- a/Annex/View.hs
+++ b/Annex/View.hs
@@ -577,7 +577,7 @@ updateView view madj = do
                        cmode <- annexCommitMode <$> Annex.getGitConfig
                        let msg = "updated " ++ fromRef (branchView view madj)
                        let parent = catMaybes [oldcommit]
-                       inRepo (Git.Branch.commitTree cmode msg parent newtree)
+                       inRepo (Git.Branch.commitTree cmode [msg] parent newtree)
                else return Nothing
 
 {- Diff between currently checked out branch and staged changes, and

diff --git a/CHANGELOG b/CHANGELOG
index 83dfa02de9c30f9dc1f55bbefda62a021b38cb08..3a4adca1086f8122b3133a40ae67b1bda69151b9 100644 (file)
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -13,6 +13,8 @@ git-annex (10.20240228) UNRELEASED; urgency=medium
     the same repository.
   * Windows: Fix escaping output to terminal when using old
     versions of MinTTY.
+  * sync, assist, import: Allow -m option to be specified multiple
+    times, to provide additional paragraphs for the commit message.
 
  -- Joey Hess <id@joeyh.name>  Tue, 27 Feb 2024 13:07:10 -0400
 

diff --git a/Command/FilterBranch.hs b/Command/FilterBranch.hs
index 10f03cccda04bd52e38b5783595b00b162c25e47..6c565c5d2919f07e41665e4a91394a31c628e788 100644 (file)
--- a/Command/FilterBranch.hs
+++ b/Command/FilterBranch.hs
@@ -189,7 +189,7 @@ seek o = withOtherTmp $ \tmpdir -> do
        liftIO $ removeWhenExistsWith removeLink tmpindex
        cmode <- annexCommitMode <$> Annex.getGitConfig
        cmessage <- Annex.Branch.commitMessage
-       c <- inRepo $ Git.commitTree cmode cmessage [] t
+       c <- inRepo $ Git.commitTree cmode [cmessage] [] t
        liftIO $ putStrLn (fromRef c)
   where
        ww = WarnUnmatchLsFiles "filter-branch"

diff --git a/Command/Import.hs b/Command/Import.hs
index a37064eefc0d83321d2c5373639f281a13635b49..f5483cc7d5621b157f21503ae596cb594c2a76a8 100644 (file)
--- a/Command/Import.hs
+++ b/Command/Import.hs
@@ -1,6 +1,6 @@
 {- git-annex command
  -
- - Copyright 2012-2021 Joey Hess <id@joeyh.name>
+ - Copyright 2012-2024 Joey Hess <id@joeyh.name>
  -
  - Licensed under the GNU AGPL version 3 or higher.
  -}
@@ -70,7 +70,7 @@ data ImportOptions
                , importToSubDir :: Maybe FilePath
                , importContent :: Bool
                , checkGitIgnoreOption :: CheckGitIgnore
-               , messageOption :: Maybe String
+               , messageOption :: [String]
                }
 
 optParser :: CmdParamsDesc -> Parser ImportOptions
@@ -82,7 +82,7 @@ optParser desc = do
                )
        dupmode <- fromMaybe Default <$> optional duplicateModeParser
        ic <- Command.Add.checkGitIgnoreSwitch
-       message <- optional (strOption
+       message <- many (strOption
                ( long "message" <> short 'm' <> metavar "MSG"
                <> help "commit message"
                ))
@@ -322,8 +322,8 @@ verifyExisting key destfile (yes, no) = do
        verifyEnoughCopiesToDrop [] key Nothing needcopies mincopies [] preverified tocheck
                (const yes) no
 
-seekRemote :: Remote -> Branch -> Maybe TopFilePath -> Bool -> CheckGitIgnore -> Maybe String -> CommandSeek
-seekRemote remote branch msubdir importcontent ci mimportmessage = do
+seekRemote :: Remote -> Branch -> Maybe TopFilePath -> Bool -> CheckGitIgnore -> [String] -> CommandSeek
+seekRemote remote branch msubdir importcontent ci importmessages = do
        importtreeconfig <- case msubdir of
                Nothing -> return ImportTree
                Just subdir ->
@@ -336,7 +336,7 @@ seekRemote remote branch msubdir importcontent ci mimportmessage = do
        
        trackingcommit <- fromtrackingbranch Git.Ref.sha
        cmode <- annexCommitMode <$> Annex.getGitConfig
-       let importcommitconfig = ImportCommitConfig trackingcommit cmode importmessage
+       let importcommitconfig = ImportCommitConfig trackingcommit cmode importmessages'
        let commitimport = commitRemote remote branch tb trackingcommit importtreeconfig importcommitconfig
 
        importabletvar <- liftIO $ newTVarIO Nothing
@@ -353,9 +353,9 @@ seekRemote remote branch msubdir importcontent ci mimportmessage = do
                                includeCommandAction $ 
                                        commitimport imported
   where
-       importmessage = fromMaybe 
-               ("import from " ++ Remote.name remote)
-               mimportmessage
+       importmessages'
+               | null importmessages = ["import from " ++ Remote.name remote]
+               | otherwise = importmessages
 
        tb = mkRemoteTrackingBranch remote branch
 

diff --git a/Command/Sync.hs b/Command/Sync.hs
index e222dd087487182cba1115ce00a1b72c47ecbe34..5c4ba2ebe218291598bebab5825c78781a84dc12 100644 (file)
--- a/Command/Sync.hs
+++ b/Command/Sync.hs
@@ -1,7 +1,7 @@
 {- git-annex command
  -
  - Copyright 2011 Joachim Breitner <mail@joachim-breitner.de>
- - Copyright 2011-2023 Joey Hess <id@joeyh.name>
+ - Copyright 2011-2024 Joey Hess <id@joeyh.name>
  -
  - Licensed under the GNU AGPL version 3 or higher.
  -}
@@ -105,7 +105,7 @@ data SyncOptions = SyncOptions
        , notOnlyAnnexOption :: Bool
        , commitOption :: Bool
        , noCommitOption :: Bool
-       , messageOption :: Maybe String
+       , messageOption :: [String]
        , pullOption :: Bool
        , pushOption :: Bool
        , contentOption :: Maybe Bool
@@ -125,7 +125,7 @@ instance Default SyncOptions where
                , notOnlyAnnexOption = False
                , commitOption = False
                , noCommitOption = False
-               , messageOption = Nothing
+               , messageOption = []
                , pullOption = False
                , pushOption = False
                , contentOption = Just False
@@ -169,8 +169,8 @@ optParser mode desc = SyncOptions
                        ( long "no-commit"
                        <> help "avoid git commit" 
                        ))
-       <*> unlessmode [SyncMode, AssistMode] Nothing
-               (optional (strOption
+       <*> unlessmode [SyncMode, AssistMode] []
+               (many (strOption
                        ( long "message" <> short 'm' <> metavar "MSG"
                        <> help "commit message"
                        )))
@@ -402,17 +402,18 @@ syncRemotes' ps available =
 
 commit :: SyncOptions -> CommandStart
 commit o = stopUnless shouldcommit $ starting "commit" ai si $ do
-       commitmessage <- maybe commitMsg return (messageOption o)
        Annex.Branch.commit =<< Annex.Branch.commitMessage
+       mopts <- concatMap (\msg -> [Param "-m", Param msg])
+               <$> if null (messageOption o)
+                       then (:[]) <$> commitMsg
+                       else pure (messageOption o)
        next $ do
                showOutput
                let cmode = Git.Branch.ManualCommit
                cquiet <- Git.Branch.CommitQuiet <$> commandProgressDisabled
-               void $ inRepo $ Git.Branch.commitCommand cmode cquiet
-                       [ Param "-a"
-                       , Param "-m"
-                       , Param commitmessage
-                       ]
+               void $ inRepo $ Git.Branch.commitCommand
+                       cmode cquiet
+                       ([ Param "-a" ] ++ mopts)
                return True
   where
        shouldcommit = notOnlyAnnex o <&&>
@@ -426,7 +427,8 @@ commitMsg :: Annex String
 commitMsg = do
        u <- getUUID
        m <- uuidDescMap
-       return $ "git-annex in " ++ maybe "unknown" fromUUIDDesc (M.lookup u m)
+       return $ "git-annex in "
+               ++ maybe "unknown" fromUUIDDesc (M.lookup u m)
 
 mergeLocal :: [Git.Merge.MergeConfig] -> SyncOptions -> CurrBranch -> CommandStart
 mergeLocal mergeconfig o currbranch = stopUnless (notOnlyAnnex o) $
@@ -578,7 +580,7 @@ importRemote importcontent o remote currbranch
                        let (branch, subdir) = splitRemoteAnnexTrackingBranchSubdir b
                        if canImportKeys remote importcontent
                                then do
-                                       Command.Import.seekRemote remote branch subdir importcontent (CheckGitIgnore True) Nothing
+                                       Command.Import.seekRemote remote branch subdir importcontent (CheckGitIgnore True) []
                                        -- Importing generates a branch
                                        -- that is not initially connected
                                        -- to the current branch, so allow

diff --git a/Git/Branch.hs b/Git/Branch.hs
index f30e3572f269fc03192e4f231504a676f05dfa59..40ddaf78d8611e39878efdc48d30c3ab935e5063 100644 (file)
--- a/Git/Branch.hs
+++ b/Git/Branch.hs
@@ -178,7 +178,7 @@ commit commitmode allowempty message branch parentrefs repo = do
        tree <- writeTree repo
        ifM (cancommit tree)
                ( do
-                       sha <- commitTree commitmode message parentrefs tree repo
+                       sha <- commitTree commitmode [message] parentrefs tree repo
                        update' branch sha repo
                        return $ Just sha
                , return Nothing
@@ -207,15 +207,15 @@ writeTreeQuiet repo = extractSha <$> withNullHandle go
        go nullh = pipeReadStrict' (\p -> p { std_err = UseHandle nullh }) 
                [Param "write-tree"] repo
 
-commitTree :: CommitMode -> String -> [Ref] -> Ref -> Repo -> IO Sha
-commitTree commitmode message parentrefs tree repo =
-       getSha "commit-tree" $
-               pipeWriteRead ([Param "commit-tree", Param (fromRef tree)] ++ ps)
-                       sendmsg repo
+commitTree :: CommitMode -> [String] -> [Ref] -> Ref -> Repo -> IO Sha
+commitTree commitmode messages parentrefs tree repo =
+       getSha "commit-tree" $ pipeReadStrict ps repo
   where
-       sendmsg = Just $ flip hPutStr message
-       ps = applyCommitModeForCommitTree commitmode parentparams repo
-       parentparams = map Param $ concatMap (\r -> ["-p", fromRef r]) parentrefs
+       ps = [Param "commit-tree", Param (fromRef tree)]
+               ++ applyCommitModeForCommitTree commitmode baseparams repo
+       baseparams = map Param $
+               concatMap (\r -> ["-p", fromRef r]) parentrefs
+                       ++ concatMap (\msg -> ["-m", msg]) messages
 
 {- A leading + makes git-push force pushing a branch. -}
 forcePush :: String -> String

diff --git a/doc/git-annex-assist.mdwn b/doc/git-annex-assist.mdwn
index f71e2a28153ef44b0a427c54cfa9d25364d48c68..bc843be1a9355217ac7e25e8d83f97321afcc584 100644 (file)
--- a/doc/git-annex-assist.mdwn
+++ b/doc/git-annex-assist.mdwn
@@ -34,6 +34,9 @@ files that it does not match will instead be added with `git add`.
 
   Use this option to specify a commit message.
 
+  If multiple -m options are given, their values are concatenated
+  as separate paragraphs.
+
 * `--content-of=path` `-C path`
 
   Only add, pull, and push files in the given path.

diff --git a/doc/git-annex-import.mdwn b/doc/git-annex-import.mdwn
index b72fae5d5fd93695adf4c5cf89c34a3400cba9ea..e78fa0ac14b12283f7d7e68f86399495c746461d 100644 (file)
--- a/doc/git-annex-import.mdwn
+++ b/doc/git-annex-import.mdwn
@@ -107,6 +107,9 @@ the tree of files on the remote, even when importing into a subdirectory.
   Use this option to specify a commit message for the changes that have
   been made to the special remote since the last import from it.
 
+  If multiple -m options are given, their values are concatenated
+  as separate paragraphs.
+
 # IMPORTING FROM A DIRECTORY
 
 When run with a path, `git annex import` **moves** files from somewhere outside

diff --git a/doc/git-annex-sync.mdwn b/doc/git-annex-sync.mdwn
index d3e76be91a3f46a6238056ee2f9042c1cae3094d..6c7235ddf771545dd04ec782cc2b262e33346fb6 100644 (file)
--- a/doc/git-annex-sync.mdwn
+++ b/doc/git-annex-sync.mdwn
@@ -51,6 +51,9 @@ when syncing with repositories that have preferred content configured.
 
   Use this option to specify a commit message.
 
+  If multiple -m options are given, their values are concatenated
+  as separate paragraphs.
+
 * `--pull`, `--no-pull`
 
   Use this option to disable pulling.

diff --git a/doc/todo/multiple_-m.mdwn b/doc/todo/multiple_-m.mdwn
index c9c01b2ef9fb4ddc60152269f63981dc3a7b1617..14cb9189e32b5d247b7de19811e801564ec354c7 100644 (file)
--- a/doc/todo/multiple_-m.mdwn
+++ b/doc/todo/multiple_-m.mdwn
@@ -1,2 +1,4 @@
 git-annex sync etc -m should be able to be specified multiple times. In git
 commit, multiple -m can be used to make a multiparagraph commit. --[[Joey]]
+
+> [[done]]