Skip to content

Commit 4a24848

Browse files
author
jamescott
committed
include registry dsl methods in registry key resource topics
1 parent 6f5a2c2 commit 4a24848

File tree

2 files changed

+57
-22
lines changed

2 files changed

+57
-22
lines changed

chef_master/source/resource_registry_key.rst

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,33 @@ Registry Key Path Separators
1414

1515
Recipe DSL Methods
1616
-----------------------------------------------------
17-
The following methods can be used to interact with |windows| registry keys.
18-
19-
.. list-table::
20-
:widths: 150 450
21-
:header-rows: 1
22-
23-
* - Methods
24-
- Description
25-
* - `registry_data_exists? <http://docs.chef.io/release/12-0/dsl_recipe.html#registry-data-exists>`__
26-
- Find out if a registry key contains data.
27-
* - `registry_get_subkeys <http://docs.chef.io/release/12-0/dsl_recipe.html#registry-get-subkeys>`__
28-
- Get a list of sub-keys for a registry setting.
29-
* - `registry_get_values <http://docs.chef.io/release/12-0/dsl_recipe.html#registry-get-values>`__
30-
- Get values (name, type, and data) for a given registry key.
31-
* - `registry_has_subkeys? <http://docs.chef.io/release/12-0/dsl_recipe.html#registry-has-subkeys>`__
32-
- Find out if a registry key has one (or more) sub-keys.
33-
* - `registry_key_exists? <http://docs.chef.io/release/12-0/dsl_recipe.html#registry-key-exists>`__
34-
- Find out if a registry key exists.
35-
* - `registry_value_exists? <http://docs.chef.io/release/12-0/dsl_recipe.html#registry-value-exists>`__
36-
- Find out if a registry key has values set (name, type, and data).
37-
38-
.. note:: The recommended order in which registry key-specific methods should be used within a recipe is: ``key_exists?``, ``value_exists?``, ``data_exists?``, ``get_values``, ``has_subkeys?``, and then ``get_subkeys``.
17+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
18+
19+
.. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
20+
21+
registry_data_exists?
22+
+++++++++++++++++++++++++++++++++++++++++++++++++++++
23+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_registry_data_exists.rst
24+
25+
registry_get_subkeys
26+
+++++++++++++++++++++++++++++++++++++++++++++++++++++
27+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_registry_get_subkeys.rst
28+
29+
registry_get_values
30+
+++++++++++++++++++++++++++++++++++++++++++++++++++++
31+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_registry_get_values.rst
32+
33+
registry_has_subkeys?
34+
+++++++++++++++++++++++++++++++++++++++++++++++++++++
35+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_registry_has_subkeys.rst
36+
37+
registry_key_exists?
38+
+++++++++++++++++++++++++++++++++++++++++++++++++++++
39+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_registry_key_exists.rst
40+
41+
registry_value_exists?
42+
+++++++++++++++++++++++++++++++++++++++++++++++++++++
43+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_registry_value_exists.rst
3944

4045
Actions
4146
=====================================================

chef_master/source/windows.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -680,6 +680,36 @@ Path Separators
680680
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
681681
.. include:: ../../includes_windows/includes_windows_registry_key_backslashes.rst
682682

683+
Recipe DSL Methods
684+
+++++++++++++++++++++++++++++++++++++++++++++++++++++
685+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_windows_methods.rst
686+
687+
.. include:: ../../includes_notes/includes_notes_dsl_recipe_order_for_windows_methods.rst
688+
689+
registry_data_exists?
690+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
691+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_registry_data_exists.rst
692+
693+
registry_get_subkeys
694+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
695+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_registry_get_subkeys.rst
696+
697+
registry_get_values
698+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
699+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_registry_get_values.rst
700+
701+
registry_has_subkeys?
702+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
703+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_registry_has_subkeys.rst
704+
705+
registry_key_exists?
706+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
707+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_registry_key_exists.rst
708+
709+
registry_value_exists?
710+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
711+
.. include:: ../../includes_dsl_recipe/includes_dsl_recipe_method_registry_value_exists.rst
712+
683713
Actions
684714
+++++++++++++++++++++++++++++++++++++++++++++++++++++
685715
.. include:: ../../includes_resources/includes_resource_registry_key_actions.rst

0 commit comments

Comments
 (0)