mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

improve comments

Browse source
This commit is contained in:
Joey Hess 2023-04-04 15:21:50 -04:00
parent d0e94b4302
commit ac0345aa42
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
Annex/Environment.hs
View file

@ -1,6 +1,6 @@
{- git-annex environment {- git-annex environment
- -
- Copyright 2012, 2013 Joey Hess <id@joeyh.name> - Copyright 2012-2023 Joey Hess <id@joeyh.name>
- -
- Licensed under the GNU AGPL version 3 or higher. - Licensed under the GNU AGPL version 3 or higher.
-} -}
@ -23,13 +23,15 @@ import Control.Exception
{- Checks that the system's environment allows git to function. {- Checks that the system's environment allows git to function.
- Git requires a GECOS username, or suitable git configuration, or - Git requires a GECOS username, or suitable git configuration, or
- environment variables. When none of those are set, this will set the
- environment variables. - environment variables.
- -
- Git also requires the system have a hostname containing a dot. - Git also requires the system have a hostname containing a dot.
- Otherwise, it tries various methods to find a FQDN, and will fail if it - Otherwise, it tries various methods to find a FQDN, and will fail if it
- does not. To avoid replicating that code here, which would break if its - does not. To avoid replicating that code here, which would break if its
- methods change, this function does not check the hostname is valid. - methods change, this function does not check the hostname is valid.
- Instead, code that commits can use ensureCommit. - Instead, git-annex init calls ensureCommit, which makes sure that git
- gets set up to allow committing.
-} -}
checkEnvironment :: Annex () checkEnvironment :: Annex ()
checkEnvironment = do checkEnvironment = do