Skip to content

CFE-4529: Added docs for policy function getacls()#3454

Merged
olehermanse merged 1 commit into
cfengine:masterfrom
larsewi:getacls
Jul 2, 2025
Merged

CFE-4529: Added docs for policy function getacls()#3454
olehermanse merged 1 commit into
cfengine:masterfrom
larsewi:getacls

Conversation

@larsewi

@larsewi larsewi commented Jul 2, 2025

Copy link
Copy Markdown
Contributor

No description provided.

Ticket: CFE-4529
Signed-off-by: Lars Erik Wik <lars.erik.wik@northern.tech>

@victormlg victormlg left a comment

Copy link
Copy Markdown
Contributor

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:**

@victormlg victormlg Jul 2, 2025

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
Member

@cf-bottom jenkins

@cf-bottom

Copy link
Copy Markdown

@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