From: Frank Wunderlich <[email protected]> Add documentation for memsize command.
Signed-off-by: Frank Wunderlich <[email protected]> --- doc/usage/cmd/memsize.rst | 43 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 doc/usage/cmd/memsize.rst diff --git a/doc/usage/cmd/memsize.rst b/doc/usage/cmd/memsize.rst new file mode 100644 index 000000000000..4571795c7b41 --- /dev/null +++ b/doc/usage/cmd/memsize.rst @@ -0,0 +1,43 @@ +.. SPDX-License-Identifier: GPL-2.0+: + +.. index:: + single: memsize (command) + +memsize command +=============== + +Synopsis +-------- + +:: + + memsize [name] + +Description +----------- + +The memsize command shows the amount of memory in MiB. +Optionally value can be assigned to an environment variable. + +Examples +-------- + +This first example shows printing of ram size: + +:: + + => memsize + 8192 MiB + +This second example shows assign ram size to environment variable: + +:: + + => memsize memsz + => printenv memsz + memsz=8192 + +Return value +------------ + +The return value is always 0 except error happens on setting environment variable. -- 2.43.0
