From: Mark Geisert <mark@maxrnd.com>
To: cygwin-patches@cygwin.com
Subject: [PATCH] Cygwin: Make gmondump conform to its doc + adjust doc
Date: Mon, 2 Aug 2021 02:25:53 -0700 [thread overview]
Message-ID: <20210802092553.1268-1-mark@maxrnd.com> (raw)
The doc for gmondump says 1 or more FILENAME are expected, but 0 is
handled. That's an oversight. Make invocation with 0 FILENAMEs print a
one-line help message.
Reword the beginning of profiler's description doc to clarify target's
child processes are run but only optionally profiled.
---
winsup/doc/utils.xml | 7 ++++---
winsup/utils/gmondump.c | 12 ++++++++++++
2 files changed, 16 insertions(+), 3 deletions(-)
diff --git a/winsup/doc/utils.xml b/winsup/doc/utils.xml
index 659541f00..0b9e38549 100644
--- a/winsup/doc/utils.xml
+++ b/winsup/doc/utils.xml
@@ -2240,9 +2240,10 @@ specifying an empty password.
<refsect1 id="profiler-desc">
<title>Description</title>
- <para>The <command>profiler</command> utility executes a given program, and
- optionally the children of that program, collecting the location of the
- CPU instruction pointer (IP) many times per second. This gives a profile
+ <para>The <command>profiler</command> utility executes a given program and
+ any children of that program, collecting the location of the CPU
+ instruction pointer (IP) many times per second. (It is optional to
+ collect this info from child processes.) This info gives a profile
of the program's execution, showing where the most time is being spent.
This profiling technique is called "IP sampling".</para>
diff --git a/winsup/utils/gmondump.c b/winsup/utils/gmondump.c
index e469f01f1..ec9db0598 100644
--- a/winsup/utils/gmondump.c
+++ b/winsup/utils/gmondump.c
@@ -46,6 +46,14 @@ OPTIONS are:\n\
exit (where == stderr ? 1 : 0 );
}
+void __attribute__ ((__noreturn__))
+usage1 (FILE *where)
+{
+ fprintf (where, "Usage: %s [OPTIONS] FILENAME...\n", pgm);
+
+ exit (where == stderr ? 1 : 0 );
+}
+
void
note (const char *fmt, ...)
{
@@ -248,6 +256,10 @@ main(int argc, char **argv)
;
}
+ if (optind >= argc)
+ /* Print one-line help and exit. */
+ usage1 (ofile);
+
for (int i = optind; i < argc; i++)
gmondump1 (argv[i]);
--
2.32.0
next reply other threads:[~2021-08-02 9:26 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-02 9:25 Mark Geisert [this message]
2021-08-03 8:04 ` Corinna Vinschen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210802092553.1268-1-mark@maxrnd.com \
--to=mark@maxrnd.com \
--cc=cygwin-patches@cygwin.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).