[memstomp/f19] Improve man page (#961518)

Jeffrey Law law at fedoraproject.org
Thu May 30 12:10:46 UTC 2013


commit adcfaf979267ba032c07319efa142e21959c83d0
Author: Jeff Law <law at redhat.com>
Date:   Fri May 10 17:55:35 2013 -0600

     Improve man page (#961518)

 memstomp-man.patch |   81 ++++++++++++++++++++++++++++++++++++++++++---------
 memstomp.spec      |    5 ++-
 2 files changed, 70 insertions(+), 16 deletions(-)
---
diff --git a/memstomp-man.patch b/memstomp-man.patch
index d06462f..b6839f6 100644
--- a/memstomp-man.patch
+++ b/memstomp-man.patch
@@ -9,25 +9,76 @@
  CLEANFILES = \
  	memstomp
  
---- /dev/null	2013-02-26 15:11:24.372721019 -0700
-+++ b/memstomp.man	2013-03-11 21:54:06.847082615 -0600
-@@ -0,0 +1,19 @@
+diff -Nrup a/memstomp.man b/memstomp.man
+--- a/memstomp.man	1969-12-31 17:00:00.000000000 -0700
++++ b/memstomp.man	2013-05-10 17:53:37.767722170 -0600
+@@ -0,0 +1,69 @@
 +.\" This is a comment
 +.\" Contact Owen at thelinuxblog.com
-+.TH memstomp 1 "05 February 2013" ".1" "memstomp"
++.TH MEMSTOMP 1 "09 April 2013" "0.1.4"
 +.SH NAME
-+memstomp
++memstomp \- detect function calls with overlapping memory regions
 +.SH SYNOPSIS
-+memstomp [OPTIONS...] APPLICATION [ARGUMENTS...] 
++.B  memstomp
++.RB [ \-dk ]
++.I  application
++.RI [ argument ...]
++.PP
++.B  memstomp
++.B  \-h
 +.SH DESCRIPTION
-+memstomp can help detect memory argument overlaps to various mem* and str* functions.
++The
++.B memstomp
++utility identifies function calls that use overlapping memory regions in situations when such an overlap is not allowed by various standards. When a problem is detected, memstomp displays a backtrace to help you debug the problem, and if executed with the
++.B \-\-debug\-info
++command line option, it even uses the available debugging information. Since the backtrace code is not thread safe, memstomp also allows you to use the
++.B \-\-kill
++option to immediately terminate the analyzed program when an invalid function call is detected.
++.PP
++This version of memstomp inspects the following function calls:
++.BR memcpy (),
++.BR memccpy (),
++.BR mempcpy (),
++.BR strcpy (),
++.BR stpcpy (),
++.BR strncpy (),
++.BR stpncpy (),
++.BR strcat (),
++.BR strncat (),
++.BR wmemcpy (),
++.BR wmempcpy (),
++.BR wcscpy (),
++.BR wcsncpy (),
++.BR wcscat (),
++and
++.BR wcsncat ().
 +.SH OPTIONS
-+-h, --help  Show help
-+
-+-d, --debug-info  Make use of debug information in stack traces
-+
-+-k, --kill Kill application when problem is detected
-+
++.TP
++.BR \-d ", " \-\-debug\-info
++Make use of debugging information to produce more detailed stack traces.
++.TP
++.BR \-k ", " \-\-kill
++Kill the analyzed application when a problem is detected.
++.TP
++.BR \-h ", " \-\-help
++Display usage information and exit.
 +.SH SEE ALSO
-+.SH BUGS
-+
++.BR memcpy (3),
++.BR memccpy (3),
++.BR mempcpy (3),
++.BR strcpy (3),
++.BR stpcpy (3),
++.BR strncpy (3),
++.BR stpncpy (3),
++.BR strcat (3),
++.BR strncat (3),
++.BR wmemcpy (3),
++.BR wmempcpy (3),
++.BR wcscpy (3),
++.BR wcsncpy (3),
++.BR wcscat (3),
++.BR wcsncat (3)
++.SH AUTHORS
++Lennart Poettering <lennart at poettering.net>
++.br
++William Cohen <wcohen at redhat.com>
diff --git a/memstomp.spec b/memstomp.spec
index 97e0b9c..3f00fcc 100644
--- a/memstomp.spec
+++ b/memstomp.spec
@@ -1,7 +1,7 @@
 %global	githash 38573e7d
 Name:		memstomp
 Version:	0.1.4
-Release:	6%{?dist}
+Release:	7%{?dist}
 Summary:	Warns of memory argument overlaps to various functions
 Group:		Development/Debuggers
 # The entire source code is LGPLV3+ with the exception of backtrace-symbols.c which
@@ -55,6 +55,9 @@ make install DESTDIR=$RPM_BUILD_ROOT
 %{_mandir}/man1/memstomp.1.gz
 
 %changelog
+* Fri May 10 2013 Jeff Law <law at redhat.com> 0.1.4-7
+- Improve man page (#961518)
+
 * Thu May 09 2013 Jeff Law <law at redhat.com> 0.1.4-5
 - Fix typo in initialization message (#961495)
 


More information about the scm-commits mailing list