From: Noah Hilverling <noah.hilverling@icinga.com>
Date: Thu, 18 Jan 2018 14:20:23 +0000 (+0100)
Subject: Update documentation for MaxConcurrentChecks and concurrent_checks
X-Git-Tag: v2.9.0~173^2~2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d8c31353e4782300fdbe519d1c8793a2462d58ea;p=icinga2

Update documentation for MaxConcurrentChecks and concurrent_checks

refs #4841
---

diff --git a/doc/09-object-types.md b/doc/09-object-types.md
index 95e9dccbb..cb8f35ccf 100644
--- a/doc/09-object-types.md
+++ b/doc/09-object-types.md
@@ -247,16 +247,16 @@ This configuration object is available as [checker feature](11-cli-commands.md#c
 Example:
 
 ```
-object CheckerComponent "checker" {
-  concurrent_checks = 512
-}
+library "checker"
+
+object CheckerComponent "checker" { }
 ```
 
 Configuration Attributes:
 
   Name                      | Type                  | Description
   --------------------------|-----------------------|----------------------------------
-  concurrent\_checks        | Number                | **Optional.** The maximum number of concurrent checks. Defaults to 512.
+  concurrent\_checks        | Number                | **Optional and Deprecated.** The maximum number of concurrent checks. Was replaced by global constant `MaxConcurrentChecks` which will be set if you still use `concurrent_checks`.
 
 ## CheckResultReader <a id="objecttype-checkresultreader"></a>
 
diff --git a/doc/17-language-reference.md b/doc/17-language-reference.md
index cf3934176..93991a7a2 100644
--- a/doc/17-language-reference.md
+++ b/doc/17-language-reference.md
@@ -398,6 +398,7 @@ PlatformKernelVersion|**Read-only.** The version of the operating system kernel,
 BuildCompilerName   |**Read-only.** The name of the compiler Icinga was built with, e.g. "Clang".
 BuildCompilerVersion|**Read-only.** The version of the compiler Icinga was built with, e.g. "7.3.0.7030031".
 BuildHostName       |**Read-only.** The name of the host Icinga was built on, e.g. "acheron".
+MaxConcurrentChecks |**Read-write**. The number of max checks run simultaneously. Defaults to 512.
 
 
 Advanced runtime constants. Please only use them if advised by support or developers.