summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrank Wunderlich <[email protected]>2026-02-04 19:40:44 +0100
committerTom Rini <[email protected]>2026-02-07 11:51:34 -0600
commitb4842032d542cfde271aab61b80ab870b27b07b2 (patch)
tree747254b665acf986135944e66e9c72429c6041a0
parent8acc8a654643ca26b0bdd4af37010da7cc796753 (diff)
doc: cmd: add usage doc for memsize
Add documentation for memsize command. Signed-off-by: Frank Wunderlich <[email protected]>
-rw-r--r--doc/usage/cmd/memsize.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/usage/cmd/memsize.rst b/doc/usage/cmd/memsize.rst
new file mode 100644
index 00000000000..6e99d7c1d33
--- /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 RAM in MiB in decimal notation.
+Optionally same 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.