Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools
changeset 734:4cd2fd7ccf76
farray.sh: docs: add a general note about resource management
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Mon, 07 Oct 2024 14:25:43 +0200 |
| parents | 772e4999562b |
| children | 5379b253e8f2 |
| files | share/local-bsdtools/farray.sh |
| diffstat | 1 files changed, 6 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/share/local-bsdtools/farray.sh Mon Oct 07 14:08:29 2024 +0200 +++ b/share/local-bsdtools/farray.sh Mon Oct 07 14:25:43 2024 +0200 @@ -83,6 +83,12 @@ #: `null` (aka empty) and/or missing indexes are handled differently in #: the function context. #: +#: Resource management: +#: +#: Done by reference counting of arrays and alists. No borrowed references +#: are ever returned. Every array and alist must be released using +#: `farray_release` or `falist_release`. +#: #: Important: #: All names that start with ``_farr_`` or ``__farr_`` are reserved #: for private use in this module.