Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools
changeset 640:b8b07ff189f6
common.subr: Enhance docs
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Fri, 27 Sep 2024 14:36:37 +0200 |
| parents | 4dded1830266 |
| children | c21c35a399d9 |
| files | share/local-bsdtools/common.subr |
| diffstat | 1 files changed, 5 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/share/local-bsdtools/common.subr Fri Sep 27 13:22:11 2024 +0200 +++ b/share/local-bsdtools/common.subr Fri Sep 27 14:36:37 2024 +0200 @@ -426,7 +426,11 @@ #: The output is sorted by the mountpoint. #: #: Args: -#: $1: the directory where to start for mounts and sub-mounts +#: $1 (str, optional): The directory where to start for mounts and sub-mounts. +#: It must be an absolute path and may not have a trailing slash ``/``. +#: The root directory :file:`/` is allowed. +#: A `null` value is treated as if the root directory :file:`/` +#: is given as argument. #: #: Other Parameters: #: -r (optional): If given the the output is sorted in reverse order.