add --branch option to git-annex find and mildly deprecate findref in favor of it

No deprecation warning at run time, just one on the man page.

One thing findref remains able to do that find cannot is to run in a bare
repo. Find was made to refuse to run in a bare repo because it seemed
confusing for it to not list any files ever in that situation. It would be
better for find --branch to work in a bare repo but not without --branch
but I don't currently have a way to do that.

Probably a better solution would be to make git-annex in a bare repo
default to --branch master or something like that instead of --all.

This commit was sponsored by Denis Dzyubenko on Patreon.
This commit is contained in:
Joey Hess 2018-12-09 14:10:37 -04:00
parent 029ae8d4db
commit 904be4e6be
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
8 changed files with 41 additions and 31 deletions

View file

@ -8,6 +8,8 @@ git-annex (7.20181206) UNRELEASED; urgency=medium
--exclude, --want-get, --want-drop to filenames from the branch. --exclude, --want-get, --want-drop to filenames from the branch.
Previously, combining --branch with those would fail to match anything. Previously, combining --branch with those would fail to match anything.
* add, import, findref: Support --time-limit. * add, import, findref: Support --time-limit.
* Add --branch option to git-annex find and mildly deprecate findref in
favor of it.
-- Joey Hess <id@joeyh.name> Thu, 06 Dec 2018 13:39:16 -0400 -- Joey Hess <id@joeyh.name> Thu, 06 Dec 2018 13:39:16 -0400

View file

@ -174,10 +174,7 @@ data KeyOptions
parseKeyOptions :: Parser KeyOptions parseKeyOptions :: Parser KeyOptions
parseKeyOptions = parseAllOption parseKeyOptions = parseAllOption
<|> WantBranchKeys <$> some (option (str >>= pure . Ref) <|> parseBranchKeysOption
( long "branch" <> metavar paramRef
<> help "operate on files in the specified branch or treeish"
))
<|> flag' WantUnusedKeys <|> flag' WantUnusedKeys
( long "unused" <> short 'U' ( long "unused" <> short 'U'
<> help "operate on files found by last run of git-annex unused" <> help "operate on files found by last run of git-annex unused"
@ -187,6 +184,13 @@ parseKeyOptions = parseAllOption
<> help "operate on specified key" <> help "operate on specified key"
)) ))
parseBranchKeysOption :: Parser KeyOptions
parseBranchKeysOption =
WantBranchKeys <$> some (option (str >>= pure . Ref)
( long "branch" <> metavar paramRef
<> help "operate on files in the specified branch or treeish"
))
parseFailedTransfersOption :: Parser KeyOptions parseFailedTransfersOption :: Parser KeyOptions
parseFailedTransfersOption = flag' WantFailedTransfers parseFailedTransfersOption = flag' WantFailedTransfers
( long "failed" ( long "failed"

View file

@ -79,22 +79,6 @@ withFilesNotInGit skipdotfiles a l
go fs = seekActions $ prepFiltered a $ go fs = seekActions $ prepFiltered a $
return $ concat $ segmentPaths (map (\(WorkTreeItem f) -> f) l) fs return $ concat $ segmentPaths (map (\(WorkTreeItem f) -> f) l) fs
withFilesInRefs :: ((FilePath, Key) -> CommandSeek) -> [Git.Ref] -> CommandSeek
withFilesInRefs a = mapM_ go
where
go r = do
matcher <- Limit.getMatcher
(l, cleanup) <- inRepo $ LsTree.lsTree r
forM_ l $ \ti -> do
let f = getTopFilePath $ LsTree.file ti
catKey (LsTree.sha ti) >>= \case
Nothing -> noop
Just k ->
let i = MatchingKey k (AssociatedFile (Just f))
in whenM (matcher i) $
a (f, k)
liftIO $ void cleanup
withPathContents :: ((FilePath, FilePath) -> CommandSeek) -> CmdParams -> CommandSeek withPathContents :: ((FilePath, FilePath) -> CommandSeek) -> CmdParams -> CommandSeek
withPathContents a params = do withPathContents a params = do
matcher <- Limit.getMatcher matcher <- Limit.getMatcher

View file

@ -1,6 +1,6 @@
{- git-annex command {- git-annex command
- -
- Copyright 2010-2012 Joey Hess <id@joeyh.name> - Copyright 2010-2018 Joey Hess <id@joeyh.name>
- -
- Licensed under the GNU GPL version 3 or higher. - Licensed under the GNU GPL version 3 or higher.
-} -}
@ -14,6 +14,8 @@ import Command
import Annex.Content import Annex.Content
import Limit import Limit
import Types.Key import Types.Key
import Types.ActionItem
import Git.FilePath
import qualified Utility.Format import qualified Utility.Format
import Utility.DataUnits import Utility.DataUnits
@ -28,6 +30,7 @@ mkCommand = noCommit . noMessages . withGlobalOptions [jsonOptions]
data FindOptions = FindOptions data FindOptions = FindOptions
{ findThese :: CmdParams { findThese :: CmdParams
, formatOption :: Maybe Utility.Format.Format , formatOption :: Maybe Utility.Format.Format
, keyOptions :: Maybe KeyOptions
, batchOption :: BatchMode , batchOption :: BatchMode
} }
@ -35,6 +38,7 @@ optParser :: CmdParamsDesc -> Parser FindOptions
optParser desc = FindOptions optParser desc = FindOptions
<$> cmdParams desc <$> cmdParams desc
<*> optional parseFormatOption <*> optional parseFormatOption
<*> optional parseBranchKeysOption
<*> parseBatchOption <*> parseBatchOption
parseFormatOption :: Parser Utility.Format.Format parseFormatOption :: Parser Utility.Format.Format
@ -50,7 +54,9 @@ parseFormatOption =
seek :: FindOptions -> CommandSeek seek :: FindOptions -> CommandSeek
seek o = case batchOption o of seek o = case batchOption o of
NoBatch -> withFilesInGit (commandAction . go) NoBatch -> withKeyOptions (keyOptions o) False
(commandAction . startKeys o)
(withFilesInGit (commandAction . go))
=<< workTreeItems (findThese o) =<< workTreeItems (findThese o)
Batch fmt -> batchFilesMatching fmt go Batch fmt -> batchFilesMatching fmt go
where where
@ -66,6 +72,11 @@ start o file key = ifM (limited <||> inAnnex key)
, stop , stop
) )
startKeys :: FindOptions -> (Key, ActionItem) -> CommandStart
startKeys o (key, ActionItemBranchFilePath (BranchFilePath _ topf)) =
start o (getTopFilePath topf) key
startKeys _ _ = stop
showFormatted :: Maybe Utility.Format.Format -> String -> [(String, String)] -> Annex () showFormatted :: Maybe Utility.Format.Format -> String -> [(String, String)] -> Annex ()
showFormatted format unformatted vars = showFormatted format unformatted vars =
unlessM (showFullJSON $ JSONChunk vars) $ unlessM (showFullJSON $ JSONChunk vars) $

View file

@ -1,6 +1,6 @@
{- git-annex command {- git-annex command
- -
- Copyright 2014 Joey Hess <id@joeyh.name> - Copyright 2014-2018 Joey Hess <id@joeyh.name>
- -
- Licensed under the GNU GPL version 3 or higher. - Licensed under the GNU GPL version 3 or higher.
-} -}
@ -14,9 +14,14 @@ import qualified Git
cmd :: Command cmd :: Command
cmd = withGlobalOptions [annexedMatchingOptions] $ Find.mkCommand $ cmd = withGlobalOptions [annexedMatchingOptions] $ Find.mkCommand $
command "findref" SectionPlumbing command "findref" SectionPlumbing
"lists files in a git ref" "lists files in a git ref (deprecated)"
paramRef (seek <$$> Find.optParser) paramRef (seek <$$> Find.optParser)
seek :: Find.FindOptions -> CommandSeek seek :: Find.FindOptions -> CommandSeek
seek o = (commandAction . uncurry (Find.start o)) seek o = Find.seek o'
`withFilesInRefs` (map Git.Ref $ Find.findThese o) where
o' = o
{ Find.keyOptions = Just $ WantBranchKeys $
map Git.Ref (Find.findThese o)
, Find.findThese = []
}

View file

@ -26,6 +26,10 @@ finds files in the current directory and its subdirectories.
To list annexed files whose content is not present, specify `--not --in=here` To list annexed files whose content is not present, specify `--not --in=here`
* `--branch=ref`
List files in the specified branch or treeish.
* `--print0` * `--print0`
Output filenames terminated with nulls, for use with `xargs -0` Output filenames terminated with nulls, for use with `xargs -0`

View file

@ -1,6 +1,6 @@
# NAME # NAME
git-annex findref - lists files in a git ref git-annex findref - lists files in a git ref (deprecated)
# SYNOPSIS # SYNOPSIS
@ -8,9 +8,9 @@ git annex findref `[ref]`
# DESCRIPTION # DESCRIPTION
This is very similar to the `git-annex find` command, but instead of This is the same as `git annex find` with the --branch option, and you're
finding files in the current work tree, it finds files in the encouraged to use that instead unless you need to support older versions of
specified git ref. git-annex.
# OPTIONS # OPTIONS

View file

@ -660,7 +660,7 @@ subdirectories).
* `findref [ref]` * `findref [ref]`
Lists files in a git ref. Lists files in a git ref. (deprecated)
See [[git-annex-findref]](1) for details. See [[git-annex-findref]](1) for details.