-
Notifications
You must be signed in to change notification settings - Fork 75
CFE-4529: Added docs for policy function getacls() #3454
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Ticket: CFE-4529 Signed-off-by: Lars Erik Wik <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great!
- `path` : Absolute path to file or directory | ||
- `type` : In the range `(access|default)` | ||
|
||
**Example:** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe you could use the docs macro to include the example you have created in the other PR like it has been done for other functions
For example:
Example:
[%CFEngine_include_snippet(isreadable.cf, #+begin_src cfengine3, .*end_src)%]
Output:
[%CFEngine_include_snippet(isreadable.cf, #+begin_src\s+example_output\s*, .*end_src)%]
"access_acls" | ||
string => getacls("/tmp/bar", "access"); | ||
} | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice to show the expected output (you can add it to getacls.cf, cf. my previous comment)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed that it would be nice to show the expected output.
But, then you need to be able to make sure you know what the result will be for whatever system doc build happens on.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably won't be so easy given that ACLs are not supported on all platforms and file systems
@cf-bottom jenkins |
Alright, I triggered a build: Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/135/ Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-135/output/_site/ |
No description provided.