Class: Ansible::Ruby::Modules::Git_config

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/source_control/git_config.rb

Overview

The C(git_config) module changes git configuration by invoking ‘git config’. This is needed if you don’t want to use M(template) for the entire git config file (e.g. because you need to change just C(user.email) in /etc/.git/config). Solutions involving M(command) are cumbersome or don’t work correctly in check mode.

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

#list_all ⇒ :yes, ...

Returns List all settings (optionally limited to a given I(scope)).

Returns:

  • (:yes, :no, nil) —

    List all settings (optionally limited to a given I(scope))



12
 
# File 'lib/ansible/ruby/modules/generated/source_control/git_config.rb', line 12

attribute :list_all

#name ⇒ String?

Returns The name of the setting. If no value is supplied, the value will be read from the config if it has been set.

Returns:

  • (String, nil) —

    The name of the setting. If no value is supplied, the value will be read from the config if it has been set.



16
 
# File 'lib/ansible/ruby/modules/generated/source_control/git_config.rb', line 16

attribute :name

#repo ⇒ String?

Returns Path to a git repository for reading and writing values from a specific repo.

Returns:

  • (String, nil) —

    Path to a git repository for reading and writing values from a specific repo.



20
 
# File 'lib/ansible/ruby/modules/generated/source_control/git_config.rb', line 20

attribute :repo

#scope ⇒ :local, ...

Returns Specify which scope to read/set values from. This is required when setting config values. If this is set to local, you must also specify the repo parameter. It defaults to system only when not using I(list_all)=yes.

Returns:

  • (:local, :global, :system, nil) —

    Specify which scope to read/set values from. This is required when setting config values. If this is set to local, you must also specify the repo parameter. It defaults to system only when not using I(list_all)=yes.



24
 
# File 'lib/ansible/ruby/modules/generated/source_control/git_config.rb', line 24

attribute :scope

#value ⇒ String?

Returns When specifying the name of a single setting, supply a value to set that setting to the given value.

Returns:

  • (String, nil) —

    When specifying the name of a single setting, supply a value to set that setting to the given value.



28
 
# File 'lib/ansible/ruby/modules/generated/source_control/git_config.rb', line 28

attribute :value