Class: Ansible::Ruby::Modules::Patch

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/files/patch.rb

Overview

Apply patch files using the GNU patch tool.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#backup ⇒ :yes, ...

Returns Passes C(–backup –version-control=numbered) to patch, producing numbered backup copies.

Returns:

  • (:yes, :no, nil) —

    Passes C(–backup –version-control=numbered) to patch, producing numbered backup copies.



36
 
# File 'lib/ansible/ruby/modules/generated/files/patch.rb', line 36

attribute :backup

#basedir ⇒ String?

Returns Path of a base directory in which the patch file will be applied. May be omitted when C(dest) option is specified, otherwise required.

Returns:

  • (String, nil) —

    Path of a base directory in which the patch file will be applied. May be omitted when C(dest) option is specified, otherwise required.



12
 
# File 'lib/ansible/ruby/modules/generated/files/patch.rb', line 12

attribute :basedir

#binary ⇒ :yes, ...

Returns Setting to C(yes) will disable patch’s heuristic for transforming CRLF line endings into LF. Line endings of src and dest must match. If set to C(no), C(patch) will replace CRLF in C(src) files on POSIX.

Returns:

  • (:yes, :no, nil) —

    Setting to C(yes) will disable patch’s heuristic for transforming CRLF line endings into LF. Line endings of src and dest must match. If set to C(no), C(patch) will replace CRLF in C(src) files on POSIX.



40
 
# File 'lib/ansible/ruby/modules/generated/files/patch.rb', line 40

attribute :binary

#dest ⇒ String?

Returns Path of the file on the remote machine to be patched.,The names of the files to be patched are usually taken from the patch file, but if there’s just one file to be patched it can specified with this option.

Returns:

  • (String, nil) —

    Path of the file on the remote machine to be patched.,The names of the files to be patched are usually taken from the patch file, but if there’s just one file to be patched it can specified with this option.



16
 
# File 'lib/ansible/ruby/modules/generated/files/patch.rb', line 16

attribute :dest

#remote_src ⇒ :yes, ...

Returns If C(no), it will search for src at originating/master machine, if C(yes) it will go to the remote/target machine for the C(src).

Returns:

  • (:yes, :no, nil) —

    If C(no), it will search for src at originating/master machine, if C(yes) it will go to the remote/target machine for the C(src).



28
 
# File 'lib/ansible/ruby/modules/generated/files/patch.rb', line 28

attribute :remote_src

#src ⇒ String

Returns Path of the patch file as accepted by the GNU patch tool. If C(remote_src) is ‘no’, the patch source file is looked up from the module’s I(files) directory.

Returns:

  • (String) —

    Path of the patch file as accepted by the GNU patch tool. If C(remote_src) is ‘no’, the patch source file is looked up from the module’s I(files) directory.



20
 
# File 'lib/ansible/ruby/modules/generated/files/patch.rb', line 20

attribute :src

#state ⇒ :absent, ...

Returns Whether the patch should be applied or reverted.

Returns:

  • (:absent, :present, nil) —

    Whether the patch should be applied or reverted.



24
 
# File 'lib/ansible/ruby/modules/generated/files/patch.rb', line 24

attribute :state

#strip ⇒ Integer?

Returns Number that indicates the smallest prefix containing leading slashes that will be stripped from each file name found in the patch file. For more information see the strip parameter of the GNU patch tool.

Returns:

  • (Integer, nil) —

    Number that indicates the smallest prefix containing leading slashes that will be stripped from each file name found in the patch file. For more information see the strip parameter of the GNU patch tool.



32
 
# File 'lib/ansible/ruby/modules/generated/files/patch.rb', line 32

attribute :strip