Skip to content

Commit ce3543a

Browse files
committed
fixes #10 - improve documentation for macos
1 parent 8a2798d commit ce3543a

2 files changed

Lines changed: 11 additions & 6 deletions

File tree

src/stackusage

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ showusage()
2828
echo " --version output version information and exit"
2929
echo ""
3030
echo "Examples:"
31-
echo "stackusage ls"
31+
echo "stackusage ./ex001"
3232
echo ""
33-
echo "executes the program 'ls' and measures its stack usage."
33+
echo "executes the program 'ex001' and measures its stack usage."
3434
echo "Result is output to stderr on the following format:"
3535
echo ""
3636
echo "stackusage log at 2018-10-28 22:33:18 ----------------------------------------"
@@ -43,7 +43,7 @@ showusage()
4343

4444
showversion()
4545
{
46-
echo "stackusage v1.12"
46+
echo "stackusage v1.14"
4747
echo ""
4848
echo "Copyright (C) 2015-2020 Kristofer Berggren"
4949
echo ""
@@ -193,6 +193,11 @@ if [ "${OUTFILE}" == "" ]; then
193193
cat "${TMPLOG}" >&2
194194
else
195195
echo "error: unable to preload ${LIBNAME}"
196+
if [ "$(uname)" == "Darwin" ]; then
197+
echo "note that stackusage on macOS cannot measure stack usage on"
198+
echo "programs protected by System Integrity Protection, it should"
199+
echo "however work on locally compiled programs."
200+
fi
196201
fi
197202
fi
198203

src/stackusage.1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2-
.TH STACKUSAGE "1" "December 2020" "stackusage v1.12" "User Commands"
2+
.TH STACKUSAGE "1" "August 2021" "stackusage v1.14" "User Commands"
33
.SH NAME
44
stackusage \- measure stack usage in applications
55
.SH SYNOPSIS
@@ -41,9 +41,9 @@ display this help and exit
4141
\fB\-\-version\fR
4242
output version information and exit
4343
.SH EXAMPLES
44-
stackusage ls
44+
stackusage ./ex001
4545
.PP
46-
executes the program 'ls' and measures its stack usage.
46+
executes the program 'ex001' and measures its stack usage.
4747
Result is output to stderr on the following format:
4848
.PP
4949
stackusage log at 2018\-10\-28 22:33:18 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-

0 commit comments

Comments
 (0)