sssd man-page: Fix man-page for offline_timeout*#8755
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request moves the documentation for offline_timeout, offline_timeout_max, and offline_timeout_random_offset to a different section in the sssd.conf.5.xml man page. The review feedback highlights a typo in a parameter name (offlinet_timeout_max) and suggests grammatical corrections to improve the readability of the documentation.
| With offline_timeout set to 60 (default value) there is no point | ||
| in setting offlinet_timeout_max to less than 120 as it will | ||
| saturate instantly. General rule here should be to set | ||
| offline_timeout_max to at least 4 times offline_timeout. |
There was a problem hiding this comment.
There is a typo in the parameter name: offlinet_timeout_max should be offline_timeout_max.
| With offline_timeout set to 60 (default value) there is no point | |
| in setting offlinet_timeout_max to less than 120 as it will | |
| saturate instantly. General rule here should be to set | |
| offline_timeout_max to at least 4 times offline_timeout. | |
| With offline_timeout set to 60 (default value) there is no point | |
| in setting offline_timeout_max to less than 120 as it will | |
| saturate instantly. General rule here should be to set | |
| offline_timeout_max to at least 4 times offline_timeout. |
There was a problem hiding this comment.
This has been corrected.
| Note that the maximum length of each interval | ||
| is defined by offline_timeout_max (apart of random part). |
There was a problem hiding this comment.
The phrase "apart of random part" is grammatically incorrect. It should be "apart from the random part".
| Note that the maximum length of each interval | |
| is defined by offline_timeout_max (apart of random part). | |
| Note that the maximum length of each interval | |
| is defined by offline_timeout_max (apart from the random part). |
There was a problem hiding this comment.
This has been corrected.
| The offline_timeout default value is 60. | ||
| The offline_timeout_max default value is 3600. | ||
| The offline_timeout_random_offset default value is 30. | ||
| The end result is amount of seconds before next retry. |
There was a problem hiding this comment.
The phrase "is amount of seconds before next retry" is grammatically incorrect. It should be "is the number of seconds before the next retry".
| The offline_timeout default value is 60. | |
| The offline_timeout_max default value is 3600. | |
| The offline_timeout_random_offset default value is 30. | |
| The end result is amount of seconds before next retry. | |
| The offline_timeout default value is 60. | |
| The offline_timeout_max default value is 3600. | |
| The offline_timeout_random_offset default value is 30. | |
| The end result is the number of seconds before the next retry. |
There was a problem hiding this comment.
This has been corrected as well & re-pushed.
2dad9e1 to
74ebbba
Compare
Currently, all the offline_timeout* options are in the wrong section due to which 'sssctl config-check' gives a WARNING. Ideally, they should be in DOMAIN SECTIONS. This PR will move all offline_timeout* options into DOMAIN SECTIONS and also fix a typo along with a couple of grammatical corrections. Resolves: SSSD#7289 Signed-off-by: Akshay Sakure <[email protected]> Reviewed-by: Justin Stephenson <[email protected]>
74ebbba to
9d3c99f
Compare
3 participants
Currently, all the offline_timeout* options are in the wrong section due to which 'sssctl config-check' gives a WARNING. Ideally, they should be in DOMAIN SECTIONS.
This PR will move all offline_timeout* options into DOMAIN SECTIONS.
Resolves: #7289