[pbs-devel] [RFC proxmox-backup 1/3] acl: add docs and adapt visibility

Thomas Lamprecht t.lamprecht at proxmox.com
Thu Dec 17 17:12:22 CET 2020


On 17/12/2020 15:27, Fabian Grünbichler wrote:
> document all public things, add some doc links and make some
> previously-public things only available for test cases or within the
> crate:
> 
> previously public, now private:
> - AclTreeNode::extract_user_roles (we have extract_roles())
> - AclTreeNode::extract_group_roles (same)
> - AclTreeNode::delete_group_role (exists on AclTree)
> - AclTreeNode::delete_user_role (same)
> - AclTreeNode::insert_group_role (same)
> - AclTreeNode::insert_user_role (same)
> - AclTree::write_config (we have save_config())
> - AclTree::load (we have config()/cached_config())
> 
> previously public, now crate-internal:
> - AclTree::from_raw (only used by tests)
> - split_acl_path (used by some test binaries)
> 

thanks, thats makes it cleaner

> Signed-off-by: Fabian Grünbichler <f.gruenbichler at proxmox.com>
> ---
> RFC to get some feedback on which rustdoc features we actually want to
> use here, and which we want to leave out for now.
> 

Anything specific you want comments for, I mean I only skimmed through it quickly 
so may have overlooked stuff, but it seems like its mostly links which are new
in usage?

As long its a stable supported rustdoc feature available by the rust version
we use I'm all for being able to use it.





More information about the pbs-devel mailing list