Fixes #17464: Improve Augeas generic methods documentation #1200
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
amousset
requested changes
May 20, 2020
| # This method gives the possibilty to enter a list of augtool commands and options as a parameter. The method has in total 4 parameters: variable_prefix, variable_name, commands and autoload. | ||
| # Augtool provides bunch of other commands and options that you can use in this generic method such as 'match' to print the matches for a specific | ||
| # path expression, 'span' to print position in input file corresponding to tree, 'retrieve' to transform tree into text and 'save' to save all pending changes. | ||
| # If the Augeas isn't installed on the agent, it will produces an error. |
There was a problem hiding this comment.
Suggested change
| # If the Augeas isn't installed on the agent, it will produces an error. | |
| # If Augeas isn't installed on the agent, it will produces an error. |
| # accordingly charge all files and lenses before executing the commands you have specified. Below is an example that will shows as a result the configuration | ||
| # files that are parsed by default in '/files/etc' directory and then also print the content of the 'sshd_config' file, you can either leave the 'autoload' | ||
| # parameter empty or fill it by putting 'true' as a value. | ||
| # file_augeas_commands("label","value","ls /files/etc \n print /files/etc/ssh/sshd_config","") |
There was a problem hiding this comment.
This is formatted as markdown so it should be something like:
#
# ```
# file_augeas_commands("label","value","ls /files/etc \n print /files/etc/ssh/sshd_config","")
# file_augeas_commands("label","value","ls /files/etc \n print /files/etc/ssh/sshd_config","true")
# ```
To have proper code formatting
| # # Use case 2: | ||
| # The second case is when you deactivate that option which means that you are specifying ‘false’ as parameter and in this case you have to | ||
| # charge manually your files and lenses in the commands parameter by using the set commands. Below is the second example where you can for example set | ||
| # the lens and the file then verifying by checking the '/augeas/load' path. |
There was a problem hiding this comment.
Suggested change
| # the lens and the file then verifying by checking the '/augeas/load' path. | |
| # the lens and the file then verifying by checking the `/augeas/load` path. |
for markdown formatting
| # The particular thing you may want to do with this method is using it depending on you needs and in actually two cases. | ||
| # | ||
| # # Use case 1: | ||
| # The first case includes activating the ‘autoload’ option, it is ‘true’ by default, means you can leave the ‘autoload’ parameter's field empty and Augeas will |
There was a problem hiding this comment.
Suggested change
| # The first case includes activating the ‘autoload’ option, it is ‘true’ by default, means you can leave the ‘autoload’ parameter's field empty and Augeas will | |
| # The first case includes activating the `autoload` option, it is `true` by default, means you can leave the `autoload` parameter's field empty and Augeas will |
for markdown formatting, these are backticks and not normal quotes
amousset
approved these changes
May 20, 2020
|
OK, merging this PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://issues.rudder.io/issues/17464