grub-devel.gnu.org archive mirror
 help / color / mirror / Atom feed
From: Andrew Hamilton <adhamilt@gmail.com>
To: grub-devel@gnu.org
Cc: daniel.kiper@oracle.com, lsandova@redhat.com,
	Andrew Hamilton <adhamilt@gmail.com>
Subject: [PATCH] docs: Document lsmemregions and memtools commands.
Date: Sun, 19 Oct 2025 08:46:20 -0500	[thread overview]
Message-ID: <20251019134620.47849-1-adhamilt@gmail.com> (raw)

Add documentation of the new lsmemregions command as well as
documenting the existing memtools module commands.

Signed-off-by: Andrew Hamilton <adhamilt@gmail.com>
---
 docs/grub.texi | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/docs/grub.texi b/docs/grub.texi
index 25e602a56..9513b5ccd 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -5281,7 +5281,8 @@ enforced (@pxref{Lockdown}).
 @node memtools_module
 @section memtools
 This module provides support for GRUB development / debugging commands
-@command{lsmem}, @command{lsfreemem}, and @command{stress_big_allocs}.
+@command{lsmem}, @command{lsfreemem}, @command{lsmemregions}, and
+@command{stress_big_allocs}.
 
 @node minicmd_module
 @section minicmd
@@ -6626,7 +6627,10 @@ you forget a command, you can run the command @command{help}
 * loopback::                    Make a device from a filesystem image
 * ls::                          List devices or files
 * lsfonts::                     List loaded fonts
+* lsfreemem::                   List free memory blocks
+* lsmemregions::                List memory regions
 * lsmod::                       Show loaded modules
+* lsmem::                       List free and allocated memory blocks
 * md5sum::                      Compute or check MD5 hash
 * module::                      Load module for multiboot kernel
 * multiboot::                   Load multiboot compliant kernel
@@ -6654,6 +6658,7 @@ you forget a command, you can run the command @command{help}
 * sleep::                       Wait for a specified number of seconds
 * smbios::                      Retrieve SMBIOS information
 * source::                      Read a configuration file in same context
+* stress_big_allocs::           Stress test large memory allocations
 * test::                        Check file types and compare values
 * tpm2_key_protector_init::     Initialize the TPM2 key protector
 * tpm2_key_protector_clear::    Clear the TPM2 key protector
@@ -7738,6 +7743,31 @@ List loaded fonts.
 @end deffn
 
 
+@node lsmem
+@subsection lsmem
+
+@deffn Command lsmem
+List free and allocated memory blocks.
+@end deffn
+
+
+@node lsfreemem
+@subsection lsfreemem
+
+@deffn Command lsfreemem
+List free memory blocks.
+@end deffn
+
+
+@node lsmemregions
+@subsection lsmemregions
+
+@deffn Command lsmemregions
+Prints memory region general information including size, number of
+blocks, and total free / total allocated memory per region.
+@end deffn
+
+
 @node lsmod
 @subsection lsmod
 
@@ -8386,6 +8416,14 @@ will not be shown immediately.
 @end deffn
 
 
+@node stress_big_allocs
+@subsection stress_big_allocs
+
+@deffn Command stress_big_allocs
+Stress test large memory allocations.
+@end deffn
+
+
 @node test
 @subsection test
 
-- 
2.43.0


_______________________________________________
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel

             reply	other threads:[~2025-10-19 13:47 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-19 13:46 Andrew Hamilton [this message]
2025-10-20 14:52 ` [PATCH] docs: Document lsmemregions and memtools commands Daniel Kiper via Grub-devel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20251019134620.47849-1-adhamilt@gmail.com \
    --to=adhamilt@gmail.com \
    --cc=daniel.kiper@oracle.com \
    --cc=grub-devel@gnu.org \
    --cc=lsandova@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).