From: Martin Hunt <hunt@redhat.com>
To: Robb Romans <robb@linux.vnet.ibm.com>
Cc: SystemTap <systemtap@sources.redhat.com>
Subject: Re: Language Reference, updated
Date: Wed, 29 Nov 2006 01:07:00 -0000 [thread overview]
Message-ID: <1164736330.3660.31.camel@dragon> (raw)
In-Reply-To: <200611221532.39260.robb@linux.vnet.ibm.com>
Some comments. I'm copying the list because some of these apply equally
to man pages.
1.4.2 Primes
Example is from man page. Perhaps both should change from
if (isprime (i)) log (sprint(i))
to
if (isprime (i)) printf("%d\n", i)
Reason: Our users are C programmers. log() in C is a math function.
printf is more powerful and more familiar. log() should be deprecated,
but we will probably keep it around forever for compatibility.
1.4.3
Same issue. Change
log ("11th fibonacci number: " . sprint (fibonacci (11)))
to
printf("11th fibonacci number: %d\n", fibonacci (11))
3.2.3
printf statement has a syntax problem. Should read
printf("reading fd=%d\n", fildes)
3.2.4
Again, I think more C-like examples are better. Instead of
function thatfn:string(arg1:long, arg2) {
return sprint(arg1) . arg2
}
Use
function thatfn:string(arg1:long, arg2) {
return sprintf("%d%s",arg1, arg2)
}
3.5 You start off mentioning "guru mode" without an explanation of what
it is or how you use it. Also I don't understand why the phrase "in some
sequence" is used here.
6.0.11 foreach
Don't forget to document "limit" keyword.
7.2 It may be best to explain that
if ([4,"hello"] in foo) {}
is the same as
if (foo[4,"hello"] == 0) {}
And therefore one cannot test for membership of an element with value
0 or ""
8.4.3 instead of
print(@hist_log(v))
should be
print(@hist_log(x))
9.1.1
"stpd prepends the string "ERROR:""
We shouldn't mention "stpd" because the user doesn't really care about
the name of that program and the name is actually now "staprun". Also,
the prepending is done in the kernel. "staprun" just writes the output
to stderr,
9.1.4 SHould mention that normal printf field formatting is available
(%-20, %o, %x, etc). Also mention %p and binary formats here.
9.1.8 There is no such thing as a "warning stream" Output goes to
stderr. Same comment as 9.1.1 re stpd
next prev parent reply other threads:[~2006-11-28 17:52 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2006-11-24 21:52 Robb Romans
2006-11-29 1:07 ` Martin Hunt [this message]
2006-11-29 7:44 ` Robb Romans
2006-12-06 17:14 ` Robb Romans
2006-12-06 18:41 ` Martin Hunt
2006-12-06 19:51 ` Robb Romans
2006-12-12 20:45 ` Mike Mason
2007-01-31 0:02 ` Robb Romans
2007-02-12 19:22 ` Robb Romans
2007-02-13 19:54 ` Frank Ch. Eigler
2007-02-16 23:59 ` Mike Mason
2007-02-17 0:39 ` Stone, Joshua I
2007-02-22 20:59 ` Robb Romans
2007-02-27 17:58 ` Mike Mason
2007-02-27 18:08 ` Robb Romans
2007-02-27 19:03 ` Robb Romans
2006-12-12 21:24 Stone, Joshua I
2006-12-12 22:19 ` Frank Ch. Eigler
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=1164736330.3660.31.camel@dragon \
--to=hunt@redhat.com \
--cc=robb@linux.vnet.ibm.com \
--cc=systemtap@sources.redhat.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).