2011-06-22 22:46:45 +00:00
|
|
|
{- git-annex command
|
|
|
|
-
|
2019-08-09 17:21:15 +00:00
|
|
|
- Copyright 2011-2019 Joey Hess <id@joeyh.name>
|
2011-06-22 22:46:45 +00:00
|
|
|
-
|
2019-03-13 19:48:14 +00:00
|
|
|
- Licensed under the GNU AGPL version 3 or higher.
|
2011-06-22 22:46:45 +00:00
|
|
|
-}
|
|
|
|
|
|
|
|
module Command.Merge where
|
|
|
|
|
|
|
|
import Command
|
2011-10-04 04:40:47 +00:00
|
|
|
import qualified Annex.Branch
|
2019-08-09 17:21:15 +00:00
|
|
|
import qualified Git
|
|
|
|
import qualified Git.Branch
|
2018-10-19 19:17:48 +00:00
|
|
|
import Annex.CurrentBranch
|
sync --only-annex and annex.synconlyannex
* Added sync --only-annex, which syncs the git-annex branch and annexed
content but leaves managing the other git branches up to you.
* Added annex.synconlyannex git config setting, which can also be set with
git-annex config to configure sync in all clones of the repo.
Use case is then the user has their own git workflow, and wants to use
git-annex without disrupting that, so they sync --only-annex to get the
git-annex stuff in sync in addition to their usual git workflow.
When annex.synconlyannex is set, --not-only-annex can be used to override
it.
It's not entirely clear what --only-annex --commit or --only-annex
--push should do, and I left that combination not documented because I
don't know if I might want to change the current behavior, which is that
such options do not override the --only-annex. My gut feeling is that
there is no good reasons to use such combinations; if you want to use
your own git workflow, you'll be doing your own committing and pulling
and pushing.
A subtle question is, how should import/export special remotes be handled?
Importing updates their remote tracking branch and merges it into master.
If --only-annex prevented that git branch stuff, then it would prevent
exporting to the special remote, in the case where it has changes that
were not imported yet, because there would be a unresolved conflict.
I decided that it's best to treat the fact that there's a remote tracking
branch for import/export as an implementation detail in this case. The more
important thing is that an import/export special remote is entirely annexed
content, and so it makes a lot of sense that --only-annex will still sync
with it.
2020-02-17 19:19:58 +00:00
|
|
|
import Command.Sync (prepMerge, mergeLocal, mergeConfig, merge, SyncOptions(..))
|
2011-06-22 22:46:45 +00:00
|
|
|
|
2015-07-08 16:33:27 +00:00
|
|
|
cmd :: Command
|
2015-07-08 19:08:02 +00:00
|
|
|
cmd = command "merge" SectionMaintenance
|
2019-08-09 17:21:15 +00:00
|
|
|
"merge changes from remotes"
|
|
|
|
(paramOptional paramRef) (withParams seek)
|
2011-06-22 22:46:45 +00:00
|
|
|
|
2015-07-08 19:08:02 +00:00
|
|
|
seek :: CmdParams -> CommandSeek
|
2019-08-09 17:21:15 +00:00
|
|
|
seek [] = do
|
|
|
|
prepMerge
|
|
|
|
commandAction mergeAnnexBranch
|
|
|
|
commandAction mergeSyncedBranch
|
|
|
|
seek bs = do
|
|
|
|
prepMerge
|
2020-04-07 21:41:09 +00:00
|
|
|
forM_ bs (commandAction . mergeBranch . Git.Ref . encodeBS')
|
2011-06-22 22:46:45 +00:00
|
|
|
|
2019-08-09 17:21:15 +00:00
|
|
|
mergeAnnexBranch :: CommandStart
|
|
|
|
mergeAnnexBranch = starting "merge" (ActionItemOther (Just "git-annex")) $ do
|
2020-04-09 17:54:43 +00:00
|
|
|
_ <- Annex.Branch.update
|
make CommandStart return a StartMessage
The goal is to be able to run CommandStart in the main thread when -J is
used, rather than unncessarily passing it off to a worker thread, which
incurs overhead that is signficant when the CommandStart is going to
quickly decide to stop.
To do that, the message it displays needs to be displayed in the worker
thread, after the CommandStart has run.
Also, the change will mean that CommandStart will no longer necessarily
run with the same Annex state as CommandPerform. While its docs already
said it should avoid modifying Annex state, I audited all the
CommandStart code as part of the conversion. (Note that CommandSeek
already sometimes runs with a different Annex state, and that has not been
a source of any problems, so I am not too worried that this change will
lead to breakage going forward.)
The only modification of Annex state I found was it calling
allowMessages in some Commands that default to noMessages. Dealt with
that by adding a startCustomOutput and a startingUsualMessages.
This lets a command start with noMessages and then select the output it
wants for each CommandStart.
One bit of breakage: onlyActionOn has been removed from commands that used it.
The plan is that, since a StartMessage contains an ActionItem,
when a Key can be extracted from that, the parallel job runner can
run onlyActionOn' automatically. Then commands won't need to worry about
this detail. Future work.
Otherwise, this was a fairly straightforward process of making each
CommandStart compile again. Hopefully other behavior changes were mostly
avoided.
In a few cases, a command had a CommandStart that called a CommandPerform
that then called showStart multiple times. I have collapsed those
down to a single start action. The main command to perhaps suffer from it
is Command.Direct, which used to show a start for each file, and no
longer does.
Another minor behavior change is that some commands used showStart
before, but had an associated file and a Key available, so were changed
to ShowStart with an ActionItemAssociatedFile. That will not change the
normal output or behavior, but --json output will now include the key.
This should not break it for anyone using a real json parser.
2019-06-06 19:42:30 +00:00
|
|
|
-- commit explicitly, in case no remote branches were merged
|
|
|
|
Annex.Branch.commit =<< Annex.Branch.commitMessage
|
|
|
|
next $ return True
|
2011-06-22 22:46:45 +00:00
|
|
|
|
2019-08-09 17:21:15 +00:00
|
|
|
mergeSyncedBranch :: CommandStart
|
|
|
|
mergeSyncedBranch = mergeLocal mergeConfig def =<< getCurrentBranch
|
|
|
|
|
|
|
|
mergeBranch :: Git.Ref -> CommandStart
|
|
|
|
mergeBranch r = starting "merge" (ActionItemOther (Just (Git.fromRef r))) $ do
|
|
|
|
currbranch <- getCurrentBranch
|
sync --only-annex and annex.synconlyannex
* Added sync --only-annex, which syncs the git-annex branch and annexed
content but leaves managing the other git branches up to you.
* Added annex.synconlyannex git config setting, which can also be set with
git-annex config to configure sync in all clones of the repo.
Use case is then the user has their own git workflow, and wants to use
git-annex without disrupting that, so they sync --only-annex to get the
git-annex stuff in sync in addition to their usual git workflow.
When annex.synconlyannex is set, --not-only-annex can be used to override
it.
It's not entirely clear what --only-annex --commit or --only-annex
--push should do, and I left that combination not documented because I
don't know if I might want to change the current behavior, which is that
such options do not override the --only-annex. My gut feeling is that
there is no good reasons to use such combinations; if you want to use
your own git workflow, you'll be doing your own committing and pulling
and pushing.
A subtle question is, how should import/export special remotes be handled?
Importing updates their remote tracking branch and merges it into master.
If --only-annex prevented that git branch stuff, then it would prevent
exporting to the special remote, in the case where it has changes that
were not imported yet, because there would be a unresolved conflict.
I decided that it's best to treat the fact that there's a remote tracking
branch for import/export as an implementation detail in this case. The more
important thing is that an import/export special remote is entirely annexed
content, and so it makes a lot of sense that --only-annex will still sync
with it.
2020-02-17 19:19:58 +00:00
|
|
|
let o = def { notOnlyAnnexOption = True }
|
|
|
|
next $ merge currbranch mergeConfig o Git.Branch.ManualCommit r
|