cli-utils-4.1.0
LicenseBSD3
Maintainertbidne@gmail.com
Safe HaskellNone
LanguageHaskell2010

Git.FastForward.Parsing

Description

Handles parsing of String args into Env.

Synopsis

Documentation

parseArgs :: [String] -> Either ParseErr Env Source #

Maps parsed [String] args into Right Env, returning any errors as Left ParseErr. All arguments are optional (i.e. an empty list is valid), but if any are provided then they must be valid or an error will be returned. Valid arguments are:

  --path=<string>
      Path to the git directory. Any String is fine, defaults
      to the empty string (current directory).

  -u, --merge=upstream
      Merges upstream via {u} into each local branch. This is the default.

  -m, --branch-type=master
      Merges origin/master into each local branch.

  --branch-type=<other>
      Merges <other> into each local branch.

  --push=<list>
      List of branches to push to after we're done updating.
      Each branch is formatted "remote_name branch_name",
      and each "remote_name branch_name" is separated by a comma.
      For instance, --push="origin dev, other temp".

  --no-fetch
      Skips git fetch@ step.

  -h, --help
      Returns instructions as Left String.