Skip to content

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

Merged
merged 1 commit into from
Jul 2, 2025

Conversation

larsewi
Copy link
Contributor

@larsewi larsewi commented Jul 2, 2025

No description provided.

Ticket: CFE-4529
Signed-off-by: Lars Erik Wik <[email protected]>
Copy link
Contributor

@victormlg victormlg left a 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:**
Copy link
Contributor

@victormlg victormlg Jul 2, 2025

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");
}
```
Copy link
Contributor

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)

Copy link
Member

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.

Copy link
Contributor Author

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

@larsewi larsewi requested a review from olehermanse July 2, 2025 09:28
@olehermanse
Copy link
Member

@cf-bottom jenkins

@cf-bottom
Copy link

@olehermanse olehermanse merged commit bad52d2 into cfengine:master Jul 2, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

5 participants