From 149ff68ac91fe4b398a691a92c07b7ba315f5275 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Fri, 13 Jul 2012 10:25:27 -0700 Subject: [PATCH] memory: Document the memory/show unixctl command. Suggested-by: Justin Pettit Signed-off-by: Ben Pfaff --- lib/automake.mk | 1 + lib/memory-unixctl.man | 7 +++++++ manpages.mk | 4 ++++ ovsdb/ovsdb-server.1.in | 1 + vswitchd/ovs-vswitchd.8.in | 1 + 5 files changed, 14 insertions(+) create mode 100644 lib/memory-unixctl.man diff --git a/lib/automake.mk b/lib/automake.mk index de4ec031d..9bc6268f2 100644 --- a/lib/automake.mk +++ b/lib/automake.mk @@ -272,6 +272,7 @@ MAN_FRAGMENTS += \ lib/daemon.man \ lib/daemon-syn.man \ lib/leak-checker.man \ + lib/memory-unixctl.man \ lib/ovs.tmac \ lib/ssl-bootstrap.man \ lib/ssl-bootstrap-syn.man \ diff --git a/lib/memory-unixctl.man b/lib/memory-unixctl.man new file mode 100644 index 000000000..5b7029711 --- /dev/null +++ b/lib/memory-unixctl.man @@ -0,0 +1,7 @@ +.SS "MEMORY COMMANDS" +These commands report memory usage. +. +.IP "\fBmemory/show\fR" +Displays some basic statistics about \fB\*(PN\fR's memory usage. +\fB\*(PN\fR also logs this information soon after startup and +periodically as its memory consumption grows. diff --git a/manpages.mk b/manpages.mk index f391fdf9d..01700c323 100644 --- a/manpages.mk +++ b/manpages.mk @@ -37,6 +37,7 @@ ovsdb/ovsdb-server.1: \ lib/coverage-unixctl.man \ lib/daemon-syn.man \ lib/daemon.man \ + lib/memory-unixctl.man \ lib/ssl-bootstrap-syn.man \ lib/ssl-bootstrap.man \ lib/ssl-syn.man \ @@ -55,6 +56,7 @@ lib/common.man: lib/coverage-unixctl.man: lib/daemon-syn.man: lib/daemon.man: +lib/memory-unixctl.man: lib/ssl-bootstrap-syn.man: lib/ssl-bootstrap.man: lib/ssl-syn.man: @@ -233,6 +235,7 @@ vswitchd/ovs-vswitchd.8: \ lib/common.man \ lib/daemon.man \ lib/leak-checker.man \ + lib/memory-unixctl.man \ lib/ssl-bootstrap.man \ lib/ssl.man \ lib/stress-unixctl.man \ @@ -245,6 +248,7 @@ vswitchd/ovs-vswitchd.8.in: lib/common.man: lib/daemon.man: lib/leak-checker.man: +lib/memory-unixctl.man: lib/ssl-bootstrap.man: lib/ssl.man: lib/stress-unixctl.man: diff --git a/ovsdb/ovsdb-server.1.in b/ovsdb/ovsdb-server.1.in index dfe9208d0..4236f8ff2 100644 --- a/ovsdb/ovsdb-server.1.in +++ b/ovsdb/ovsdb-server.1.in @@ -123,6 +123,7 @@ This command might be useful for debugging issues with database clients. . .so lib/vlog-unixctl.man +.so lib/memory-unixctl.man .so lib/coverage-unixctl.man .so lib/stress-unixctl.man .SH "SEE ALSO" diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in index bfd70fbd2..5a959ddf5 100644 --- a/vswitchd/ovs-vswitchd.8.in +++ b/vswitchd/ovs-vswitchd.8.in @@ -206,6 +206,7 @@ enabled. . .so ofproto/ofproto-unixctl.man .so lib/vlog-unixctl.man +.so lib/memory-unixctl.man .so lib/stress-unixctl.man . .SH "LIMITS" -- 2.20.1