chef / chef/chef-web-docs

Contradiction in script resource doc

Open
#1,850 0 comments 0 reactions 1 assignee View on GitHub

@mjingle is already working on this.

Since Jul 5, 2019.

Aspect: Documentation Component: Chef Infra Client Topic: Resources
Dominant language
HTML
Stars
143
Forks
438
Avg merge
1d 10h
Merged PRs (30d)
16

Description

Description

The script resource doc contains the following text:


Inheritance

The guard_interpreter property is set to :default by default for the bash, csh, perl, python, and ruby resources. When the guard_interpreter property is set to :default, not_if or only_if guard statements do not inherit properties that are defined by the script-based resource.

Warning

The batch and powershell_script resources inherit properties by default. The guard_interpreter property is set to :batch or :powershell_script automatically when using a not_if or only_if guard statement within a batch or powershell_script resource, respectively.


My understanding is that both paragraphs are in contradiction: the first one states that guard_interpreter default value for bash resources is :default (meaning properties are not inherited) while the second one states that guard interpreter default value for bash resources is :bash (meaning properties are inherited)

I don't know which one is the right one, but I had to write guard_interpreter :bash in my bash resource to make the not_if guard work.

Chef Version

The last one I guess? I linked the most recent doc above

Definition of Done

When the contradiction has been resolved.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.