git-annex/Command/Describe.hs

{- git-annex command
 -
 - Copyright 2011 Joey Hess <id@joeyh.name>
 -
 - Licensed under the GNU AGPL version 3 or higher.
 -}

module Command.Describe where

import Command
import qualified Remote
import Logs.UUID

cmd :: Command
cmd = command "describe" SectionSetup
	"change description of a repository"
	(paramPair paramRemote paramDesc)
	(withParams seek)

seek :: CmdParams -> CommandSeek
seek = withWords (commandAction . start)

start :: [String] -> CommandStart
start (name:description) = do
	showStart' "describe" (Just name)
	u <- Remote.nameToUUID name
	next $ perform u $ unwords description
start _ = giveup "Specify a repository and a description."	

perform :: UUID -> String -> CommandPerform
perform u description = do
	describeUUID u (toUUIDDesc description)
	next $ return True
add describe subcommand 2011-03-03 21:21:00 +00:00			`{- git-annex command`
			`-`
update my email address and homepage url 2015-01-21 16:50:09 +00:00			`- Copyright 2011 Joey Hess <id@joeyh.name>`
add describe subcommand 2011-03-03 21:21:00 +00:00			`-`
update licenses from GPL to AGPL This does not change the overall license of the git-annex program, which was already AGPL due to a number of sources files being AGPL already. Legally speaking, I'm adding a new license under which these files are now available; I already released their current contents under the GPL license. Now they're dual licensed GPL and AGPL. However, I intend for all my future changes to these files to only be released under the AGPL license, and I won't be tracking the dual licensing status, so I'm simply changing the license statement to say it's AGPL. (In some cases, others wrote parts of the code of a file and released it under the GPL; but in all cases I have contributed a significant portion of the code in each file and it's that code that is getting the AGPL license; the GPL license of other contributors allows combining with AGPL code.) 2019-03-13 19:48:14 +00:00			`- Licensed under the GNU AGPL version 3 or higher.`
add describe subcommand 2011-03-03 21:21:00 +00:00			`-}`

			`module Command.Describe where`

			`import Command`
converted several commands to use Remote only move and map still to convert 2011-03-27 20:55:43 +00:00			`import qualified Remote`
reorganize log modules no code changes 2011-10-15 20:21:08 +00:00			`import Logs.UUID`
add describe subcommand 2011-03-03 21:21:00 +00:00
started converting to use optparse-applicative This is a work in progress. It compiles and is able to do basic command dispatch, including git autocorrection, while using optparse-applicative for the core commandline parsing. * Many commands are temporarily disabled before conversion. * Options are not wired in yet. * cmdnorepo actions don't work yet. Also, removed the [Command] list, which was only used in one place. 2015-07-08 16:33:27 +00:00			`cmd :: Command`
convert all commands to work with optparse-applicative Still no options though. 2015-07-08 19:08:02 +00:00			`cmd = command "describe" SectionSetup`
			`"change description of a repository"`
			`(paramPair paramRemote paramDesc)`
			`(withParams seek)`
add describe subcommand 2011-03-03 21:21:00 +00:00
convert all commands to work with optparse-applicative Still no options though. 2015-07-08 19:08:02 +00:00			`seek :: CmdParams -> CommandSeek`
move commandAction out of CmdLine.Seek This is groundwork for nested seek loops, eg seeking over all files and then performing commandActions on a list of remotes, which can be done concurrently. This commit was sponsored by Boyd Stephen Smith Jr. on Patreon. 2018-10-01 18:12:06 +00:00			`seek = withWords (commandAction . start)`
add describe subcommand 2011-03-03 21:21:00 +00:00
remove command type definitions These were a mistake, they make the type signatures harder to read and less flexible. The CommandSeek, CommandStart, CommandPerform, and CommandCleanup types were a good idea, but composing them with the parameters expected is going too far. 2011-09-15 20:50:49 +00:00			`start :: [String] -> CommandStart`
cleanup 2011-10-31 20:46:51 +00:00			`start (name:description) = do`
showStart variant for when there's no worktree file Clean up some uses of showStart with "" for the file, or in some cases, a non-filename description string. That would generate bad json, although none of the commands doing that supported --json. Using "" for the file resulted in output like "foo rest"; now the extra space is eliminated. This commit was sponsored by Fernando Jimenez on Patreon. 2017-11-28 18:40:26 +00:00			`showStart' "describe" (Just name)`
converted several commands to use Remote only move and map still to convert 2011-03-27 20:55:43 +00:00			`u <- Remote.nameToUUID name`
cleanup 2011-10-31 20:46:51 +00:00			`next $ perform u $ unwords description`
Avoid backtraces on expected failures when built with ghc 8; only use backtraces for unexpected errors. ghc 8 added backtraces on uncaught errors. This is great, but git-annex was using error in many places for a error message targeted at the user, in some known problem case. A backtrace only confuses such a message, so omit it. Notably, commands like git annex drop that failed due to eg, numcopies, used to use error, so had a backtrace. This commit was sponsored by Ethan Aubin. 2016-11-16 01:29:54 +00:00			`start _ = giveup "Specify a repository and a description."`
add describe subcommand 2011-03-03 21:21:00 +00:00
converted several commands to use Remote only move and map still to convert 2011-03-27 20:55:43 +00:00			`perform :: UUID -> String -> CommandPerform`
			`perform u description = do`
add a UUIDDesc type containing a ByteString Groundwork for handling uuid.log using ByteString 2019-01-01 19:39:45 +00:00			`describeUUID u (toUUIDDesc description)`
update for git-annex branch stop changing gitattributes on init create git-annex branch on init ugly special case for init in a bare repository goes away, yay! git annex init is also faster, at least in a large existing repo, as it does not need to run the slow 'git add' 2011-06-22 20:03:26 +00:00			`next $ return True`