memory: Document the memory/show unixctl command.

Suggested-by: Justin Pettit <jpettit@nicira.com>
Signed-off-by: Ben Pfaff <blp@nicira.com>

diff --git a/lib/automake.mk b/lib/automake.mk
index de4ec031dfeba1f6caf6471fd9938473ffbc04c1..9bc6268f2d5dbc8fbc3c4e5bc760fd69ea85609a 100644 (file)
--- 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 (file)
index 0000000..5b70297
--- /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 f391fdf9d2107d208788f63a5e6b1a0f06210772..01700c32343fb64a657f84798ca86a73c489bcb8 100644 (file)
--- 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 dfe9208d0a7cbee1266347a57e6a256a00d43ad5..4236f8ff279ec9ca15d06488ae9e22e5ccc51467 100644 (file)
--- 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 bfd70fbd23076f1e06721d5f38947c1c5703c831..5a959ddf59e5aef636c4911e92b32ac47884da38 100644 (file)
--- 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"