From 1b645e1acebd3f3594df101f88cc5df7e8baea80 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 5 Apr 2021 15:21:20 -0400 Subject: [PATCH] added --debugfilter (and annex.debugfilter) --- Assistant/WebApp/Configurators/Preferences.hs | 4 +-- CHANGELOG | 1 + CmdLine.hs | 2 +- CmdLine/Option.hs | 12 +++++++-- Command/ImportFeed.hs | 2 +- Messages.hs | 14 ++++++---- Types/GitConfig.hs | 5 +++- doc/git-annex.mdwn | 26 +++++++++++++++++-- ..._d9014e7e964f47a4fdc680ffc53e17b8._comment | 13 ++++++++++ 9 files changed, 65 insertions(+), 14 deletions(-) create mode 100644 doc/todo/--debug-level___40__and__47__or_-c_annex.debug-level__41___+_more_debug_information_from_git-annex/comment_6_d9014e7e964f47a4fdc680ffc53e17b8._comment diff --git a/Assistant/WebApp/Configurators/Preferences.hs b/Assistant/WebApp/Configurators/Preferences.hs index d92362575e..9de24b1b39 100644 --- a/Assistant/WebApp/Configurators/Preferences.hs +++ b/Assistant/WebApp/Configurators/Preferences.hs @@ -100,8 +100,8 @@ storePrefs p = do then addAutoStartFile here else removeAutoStartFile here setConfig (annexConfig "debug") (boolConfig $ enableDebug p) - liftIO $ if enableDebug p - then enableDebugOutput + if enableDebug p + then enableDebugOutput else disableDebugOutput getPreferencesR :: Handler Html diff --git a/CHANGELOG b/CHANGELOG index 3dd060bcea..fe00907ccf 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -3,6 +3,7 @@ git-annex (8.20210331) UNRELEASED; urgency=medium * Fix build with persistent-2.12.0.1 * Avoid excess commits to the git-annex branch when stall detection is enabled. + * Added --debugfilter (and annex.debugfilter) -- Joey Hess Thu, 01 Apr 2021 12:17:26 -0400 diff --git a/CmdLine.hs b/CmdLine.hs index 23dc35aa91..49abba69d0 100644 --- a/CmdLine.hs +++ b/CmdLine.hs @@ -146,7 +146,7 @@ prepRunCommand cmd globalconfig = do Annex.setOutput QuietOutput getParsed globalconfig whenM (annexDebug <$> Annex.getGitConfig) $ - liftIO enableDebugOutput + enableDebugOutput findAddonCommand :: Maybe String -> IO (Maybe Command) findAddonCommand Nothing = return Nothing diff --git a/CmdLine/Option.hs b/CmdLine/Option.hs index da96310413..e7597db6c5 100644 --- a/CmdLine/Option.hs +++ b/CmdLine/Option.hs @@ -54,6 +54,11 @@ commonGlobalOptions = <> help "don't show debug messages" <> hidden ) + , globalSetter setdebugfilter $ strOption + ( long "debugfilter" <> metavar "NAME[,NAME..]" + <> help "show debug messages coming from a module" + <> hidden + ) , globalSetter setforcebackend $ strOption ( long "backend" <> short 'b' <> metavar paramName <> help "specify key-value backend to use" @@ -66,6 +71,9 @@ commonGlobalOptions = setforcebackend v = Annex.changeState $ \s -> s { Annex.forcebackend = Just v } -- Overriding this way, rather than just setting annexDebug -- makes the config be passed on to any git-annex child processes. - setdebug b = Annex.addGitConfigOverride $ decodeBS' $ - debugconfig <> "=" <> boolConfig' b + setdebug v = Annex.addGitConfigOverride $ + decodeBS' $ debugconfig <> "=" <> boolConfig' v + setdebugfilter v = Annex.addGitConfigOverride $ + decodeBS' (debugfilterconfig <> "=") ++ v (ConfigKey debugconfig) = annexConfig "debug" + (ConfigKey debugfilterconfig) = annexConfig "debugfilter" diff --git a/Command/ImportFeed.hs b/Command/ImportFeed.hs index cc8ca5d7af..fe87925298 100644 --- a/Command/ImportFeed.hs +++ b/Command/ImportFeed.hs @@ -102,7 +102,7 @@ getFeed addunlockedmatcher opts cache url = do , "end of feed content" ] showEndResult =<< feedProblem url - (msg ++ " (use --debug to see the feed content that was downloaded)") + (msg ++ " (use --debug --debugfilter=ImportFeed to see the feed content that was downloaded)") data ToDownload = ToDownload { feed :: Feed diff --git a/Messages.hs b/Messages.hs index 4a50531e85..02d8afc20f 100644 --- a/Messages.hs +++ b/Messages.hs @@ -258,13 +258,17 @@ setupConsole = do hSetBuffering stdout LineBuffering hSetBuffering stderr LineBuffering -enableDebugOutput :: IO () +enableDebugOutput :: Annex () enableDebugOutput = do - dd <- debugDisplayer - configureDebug dd (DebugSelector (\_ -> True)) + names <- map encodeBS . annexDebugFilter <$> Annex.getGitConfig + let selector + | null names = const True + | otherwise = \(DebugSource s) -> any (`S.isInfixOf` s) names + dd <- liftIO debugDisplayer + liftIO $ configureDebug dd (DebugSelector selector) -disableDebugOutput :: IO () -disableDebugOutput = do +disableDebugOutput :: Annex () +disableDebugOutput = liftIO $ do dd <- debugDisplayer configureDebug dd (DebugSelector (\_ -> False)) diff --git a/Types/GitConfig.hs b/Types/GitConfig.hs index aa5e6c65b5..32717d23ce 100644 --- a/Types/GitConfig.hs +++ b/Types/GitConfig.hs @@ -1,6 +1,6 @@ {- git-annex configuration - - - Copyright 2012-2020 Joey Hess + - Copyright 2012-2021 Joey Hess - - Licensed under the GNU AGPL version 3 or higher. -} @@ -90,6 +90,7 @@ data GitConfig = GitConfig , annexSyncContent :: GlobalConfigurable Bool , annexSyncOnlyAnnex :: GlobalConfigurable Bool , annexDebug :: Bool + , annexDebugFilter :: [String] , annexWebOptions :: [String] , annexYoutubeDlOptions :: [String] , annexAriaTorrentOptions :: [String] @@ -170,6 +171,8 @@ extractGitConfig configsource r = GitConfig , annexSyncOnlyAnnex = configurable False $ getmaybebool (annexConfig "synconlyannex") , annexDebug = getbool (annexConfig "debug") False + , annexDebugFilter = maybe [] (splitc ',') $ + getmaybe (annexConfig "debugfilter") , annexWebOptions = getwords (annexConfig "web-options") , annexYoutubeDlOptions = getwords (annexConfig "youtube-dl-options") , annexAriaTorrentOptions = getwords (annexConfig "aria-torrent-options") diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index be9fd7e257..2e4df4b922 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -780,11 +780,27 @@ may not be explicitly listed on their individual man pages. * `--debug` - Show debug messages. + Display debug messages. * `--no-debug` - Disable debug messages. + Disable display of debug messages. + +* `--debugfilter=name[,name..]` + + When debug message display has been enabled by `--debug`, this filters + the debug messages that are displayed to ones coming from modules with + the specified names. + + To find the names of modules, see the full debug output, which includes + the module name, eg "(Utility.Process)" + + The full module name does not need to be + specified when using this, a substring of the name will do. + + For example, `--debugfilter=Process,External` will display debugging + output when git-annex runs processes, and when it communicates with + external special remotes. * `--numcopies=n` @@ -1214,6 +1230,12 @@ repository, using [[git-annex-config]]. See its man page for a list.) Set to true to enable debug logging by default. +* `annex.debugfilter` + + Set to configure which debug messages to display (when debug message + display has been enabled by annex.debug or --debug). The value is one + or more module names, separated by commas. + * `annex.version` The current version of the git-annex repository. This is diff --git a/doc/todo/--debug-level___40__and__47__or_-c_annex.debug-level__41___+_more_debug_information_from_git-annex/comment_6_d9014e7e964f47a4fdc680ffc53e17b8._comment b/doc/todo/--debug-level___40__and__47__or_-c_annex.debug-level__41___+_more_debug_information_from_git-annex/comment_6_d9014e7e964f47a4fdc680ffc53e17b8._comment new file mode 100644 index 0000000000..eed0947a1c --- /dev/null +++ b/doc/todo/--debug-level___40__and__47__or_-c_annex.debug-level__41___+_more_debug_information_from_git-annex/comment_6_d9014e7e964f47a4fdc680ffc53e17b8._comment @@ -0,0 +1,13 @@ +[[!comment format=mdwn + username="joey" + subject="""comment 6""" + date="2021-04-05T19:28:36Z" + content=""" +I've implemented --debugfilter which can select the debug output you want +to see. + +Also started splitting out the immutable parts of AnnexState, but that does +not yet include debug options, due to the way option parsing currently +works. Once that gets done, there's a new fastDebug that can be used inside +tight loop code paths. +"""]]