Document FF_ENABLE_BASH_EXIT_CODE_CHECK better
What does this MR do?
The original warning was simply wrong. The issue referenced has been closed for some time and it has nothing with multi-line scripts. It has with one-line scripts of the form aa && bb
. So removed that warning and added a new one to a better place (in my opinion) also explaining how you can make failing stricter.
Personally I think having also examples of how you set the feature flag would benefit there, but then this is not anymore a warning paragraph but probably a whole new section.
Related issues
Review checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.