Skip to content

Commit

Permalink
fixes #10 - improve documentation for macos
Browse files Browse the repository at this point in the history
  • Loading branch information
d99kris committed Aug 15, 2021
1 parent 8a2798d commit ce3543a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
11 changes: 8 additions & 3 deletions src/stackusage
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ showusage()
echo " --version output version information and exit"
echo ""
echo "Examples:"
echo "stackusage ls"
echo "stackusage ./ex001"
echo ""
echo "executes the program 'ls' and measures its stack usage."
echo "executes the program 'ex001' and measures its stack usage."
echo "Result is output to stderr on the following format:"
echo ""
echo "stackusage log at 2018-10-28 22:33:18 ----------------------------------------"
Expand All @@ -43,7 +43,7 @@ showusage()

showversion()
{
echo "stackusage v1.12"
echo "stackusage v1.14"
echo ""
echo "Copyright (C) 2015-2020 Kristofer Berggren"
echo ""
Expand Down Expand Up @@ -193,6 +193,11 @@ if [ "${OUTFILE}" == "" ]; then
cat "${TMPLOG}" >&2
else
echo "error: unable to preload ${LIBNAME}"
if [ "$(uname)" == "Darwin" ]; then
echo "note that stackusage on macOS cannot measure stack usage on"
echo "programs protected by System Integrity Protection, it should"
echo "however work on locally compiled programs."
fi
fi
fi

Expand Down
6 changes: 3 additions & 3 deletions src/stackusage.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
.TH STACKUSAGE "1" "December 2020" "stackusage v1.12" "User Commands"
.TH STACKUSAGE "1" "August 2021" "stackusage v1.14" "User Commands"
.SH NAME
stackusage \- measure stack usage in applications
.SH SYNOPSIS
Expand Down Expand Up @@ -41,9 +41,9 @@ display this help and exit
\fB\-\-version\fR
output version information and exit
.SH EXAMPLES
stackusage ls
stackusage ./ex001
.PP
executes the program 'ls' and measures its stack usage.
executes the program 'ex001' and measures its stack usage.
Result is output to stderr on the following format:
.PP
stackusage log at 2018\-10\-28 22:33:18 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
Expand Down

0 comments on commit ce3543a

Please sign in to comment.