class Git::Commands::Am::Apply

Implements ‘git am` to apply a series of patches from a mailbox

Splits mail messages in a mailbox into commit log messages, authorship information, and patches, and applies them to the current branch.

@example Apply patches from a mailbox file

am = Git::Commands::Am::Apply.new(execution_context)
am.call('patches.mbox', chdir: repo.workdir)

@example Apply patches with sign-off

am.call('patches.mbox', signoff: true, chdir: repo.workdir)

@example Apply with 3-way merge fallback

am.call('patches.mbox', three_way: true, chdir: repo.workdir)

@note ‘arguments` block audited against git-scm.com/docs/git-am/2.53.0

@see git-scm.com/docs/git-am git-am

@api private

Public Instance Methods

call (*, **)

Source

# File lib/git/commands/am/apply.rb, line 257
def call(*, **)
  super
end

@overload call(*mbox, **options)

Apply patches from one or more mailbox files to the current branch

@param mbox [Array<String>] zero or more mailbox file paths or Maildir
  directories

  If omitted, reads from standard input.

@param options [Hash] command options

@option options [Boolean, nil] :signoff (nil) add Signed-off-by trailer

  Alias: `:s`

@option options [Boolean, nil] :keep (nil) preserve the Subject line
  in commit messages (`--keep`)

  Alias: `:k`

@option options [Boolean, nil] :keep_non_patch (nil) retain non-patch
  parts of the message body (`--keep-non-patch`)

@option options [Boolean, nil] :keep_cr (nil) retain CR at end of
  lines (`--keep-cr`)

@option options [Boolean, nil] :no_keep_cr (nil) strip CR at end of
  lines (`--no-keep-cr`)

@option options [Boolean, nil] :scissors (nil) remove everything in the
  body before a scissors line (`--scissors`)

  Alias: `:c`

@option options [Boolean, nil] :no_scissors (nil) disable scissors
  mode (`--no-scissors`)

@option options [String] :quoted_cr (nil) how to handle CR in quoted
  text passed to git-mailinfo

  Valid actions: `'nowarn'`, `'warn'`, `'error'`.

@option options [String] :empty (nil) how to handle an e-mail message
  lacking a patch

  Valid values: `'stop'` (fail, default), `'drop'` (skip the message),
  `'keep'` (create an empty commit).

@option options [Boolean, nil] :message_id (nil) add the Message-ID
  header to commit messages (`--message-id`)

  Alias: `:m`

@option options [Boolean, nil] :no_message_id (nil) do not add the
  Message-ID header (`--no-message-id`)

@option options [Boolean, nil] :quiet (nil) be quiet; only print error
  messages

  Alias: `:q`

@option options [Boolean, nil] :utf8 (nil) re-code the commit log message
  in UTF-8 (`--utf8`)

  Alias: `:u`

@option options [Boolean, nil] :no_utf8 (nil) do not re-code the
  commit log message (`--no-utf8`)

@option options [Boolean, nil] :three_way (nil) attempt 3-way merge when
  context does not match (`--3way`)

@option options [Boolean, nil] :no_three_way (nil) disable 3-way
  merge fallback (`--no-3way`)

@option options [Boolean, nil] :rerere_autoupdate (nil) allow rerere to
  update the index with auto-resolved conflicts (`--rerere-autoupdate`)

@option options [Boolean, nil] :no_rerere_autoupdate (nil) prevent rerere from
  auto-updating the index (`--no-rerere-autoupdate`)

@option options [Boolean, nil] :ignore_space_change (nil) ignore whitespace
  changes when applying (passed to git-apply)

@option options [Boolean, nil] :ignore_whitespace (nil) ignore whitespace
  when applying (passed to git-apply)

@option options [String] :whitespace (nil) whitespace error handling
  (e.g., `'nowarn'`, `'warn'`, `'fix'`, `'error'`)

  Passed to git-apply.

@option options [Integer, String] :C (nil) ensure at least `<n>` lines of
  surrounding context match when applying (`-C<n>`)

  Passed to git-apply.

@option options [Integer, String] :p (nil) strip `<n>` leading path
  components
  from file names (`-p<n>`)

  Passed to git-apply.

@option options [String] :directory (nil) prepend `<dir>` to all
  filenames

  Passed to git-apply.

@option options [String, Array<String>] :exclude (nil) skip files
  matching the given path pattern

  May be repeated. Passed to git-apply.

@option options [String, Array<String>] :include (nil) apply only to
  files matching the given path pattern

  May be repeated. Passed to git-apply.

@option options [Boolean, nil] :reject (nil) leave rejected hunks in
  `*.rej` files instead of aborting

  Passed to git-apply.

@option options [String] :patch_format (nil) override patch format
  detection

  Valid formats: `'mbox'`, `'mboxrd'`, `'stgit'`, `'stgit-series'`,
  `'hg'`.

@option options [Boolean, nil] :interactive (nil) run interactively,
  prompting before each patch is applied

  Alias: `:i`

@option options [Boolean, nil] :verify (nil) run pre-applypatch and
  applypatch-msg hooks (`--verify`)

  Hooks are run by default when this option is omitted.

@option options [Boolean, nil] :no_verify (nil) bypass pre-applypatch and
  applypatch-msg hooks (`--no-verify`)

@option options [Boolean, nil] :committer_date_is_author_date (nil) use the
  author date as the committer date

@option options [Boolean, nil] :ignore_date (nil) use the committer date as
  the author date

@option options [Boolean, String, nil] :gpg_sign (nil) sign commits using
  GPG (`--gpg-sign`)

  Pass a key-ID string to select the signing key; pass `true` to use
  the committer identity. Alias: `:S`

@option options [Boolean, nil] :no_gpg_sign (nil) countermand commit.gpgSign
  configuration (`--no-gpg-sign`)

@option options [String] :chdir (nil) change to this directory before
  running git

  Not passed to the git CLI.

@return [Git::CommandLine::Result] the result of calling `git am`

@raise [ArgumentError] if unsupported options are provided

@raise [Git::FailedError] if git exits with a non-zero exit status

@api public

Calls superclass method Git::Commands::Base::call