[PATCH] Fix usage message

[David Robillard-3]

The Jack usage message (e.g. printed on --help) is incorrect:

--clock-source (-c) is listed as --clocksource
--no-realtime (-L) is not listed at all

Realtime mode is always on, even if -R is NOT passed, which makes little
sense to me.  The existence of -L at all may be a bug?  If you've ever
gone through hell debugging with a (supposedly) non-realtime Jack that
bails out because of the (pointless) watchdog while you're debugging,
this is why.  The watchdog should not be run with 'jackd -d dummy', but
until then -L definitely must be exposed.

There are other magic hidden options in there that aren't listed
(--temporary, --tmpdir-location) but I left them out since they look
like maybe they shouldn't be exposed.

It would be a much better idea to print the help directly from the
struct definining the options and prevent this kind of problem in the
future, but attached patch fixed it in the simplest way.

Cheers,

-dr


[jack_usage.diff]

---

Index: jackd/jackd.c
===================================================================
--- jackd/jackd.c (revision 3666)
+++ jackd/jackd.c (working copy)
@@ -365,13 +365,14 @@
 "usage: jackd [ --realtime OR -R [ --realtime-priority OR -P priority ] ]\n"
 "             [ --name OR -n server-name ]\n"
 "             [ --no-mlock OR -m ]\n"
+"             [ --no-realtime OR -L ]\n"
 "             [ --unlock OR -u ]\n"
 "             [ --timeout OR -t client-timeout-in-msecs ]\n"
 "             [ --port-max OR -p maximum-number-of-ports]\n"
 "             [ --debug-timer OR -D ]\n"
 "             [ --no-sanity-checks OR -N ]\n"
 "             [ --verbose OR -v ]\n"
-"             [ --clocksource OR -c [ c(ycle) | h(pet) | s(ystem) ]\n"
+"             [ --clock-source OR -c [ c(ycle) | h(pet) | s(ystem) ]\n"
 "             [ --replace-registry OR -r ]\n"
 "             [ --silent OR -s ]\n"
 "             [ --version OR -V ]\n"
@@ -522,7 +523,7 @@
  { "no-realtime", 0, 0, 'L' },
  { "no-mlock", 0, 0, 'm' },
  { "name", 1, 0, 'n' },
-                { "no-sanity-checks", 0, 0, 'N' },
+ { "no-sanity-checks", 0, 0, 'N' },
  { "port-max", 1, 0, 'p' },
  { "realtime-priority", 1, 0, 'P' },
  { "realtime", 0, 0, 'R' },

---

_______________________________________________
Jack-Devel mailing list
Jack-Devel@...
http://lists.jackaudio.org/listinfo.cgi/jack-devel-jackaudio.org

[Paul Davis]

just to make it clear to all readers, dave is using jack1 from svn,
not any released version of jack.

future releases of jack will use realtime by default, and require
explicit user action to run in non-RT mode. but this is not true of
any released version.

On Fri, Oct 23, 2009 at 3:05 PM, David Robillard <dave@...> wrote:

> The Jack usage message (e.g. printed on --help) is incorrect:
>
> --clock-source (-c) is listed as --clocksource
> --no-realtime (-L) is not listed at all
>
> Realtime mode is always on, even if -R is NOT passed, which makes little
> sense to me.  The existence of -L at all may be a bug?  If you've ever
> gone through hell debugging with a (supposedly) non-realtime Jack that
> bails out because of the (pointless) watchdog while you're debugging,
> this is why.  The watchdog should not be run with 'jackd -d dummy', but
> until then -L definitely must be exposed.
>
> There are other magic hidden options in there that aren't listed
> (--temporary, --tmpdir-location) but I left them out since they look
> like maybe they shouldn't be exposed.
>
> It would be a much better idea to print the help directly from the
> struct definining the options and prevent this kind of problem in the
> future, but attached patch fixed it in the simplest way.
>
> Cheers,
>
> -dr
>
>
> _______________________________________________
> Jack-Devel mailing list
> Jack-Devel@...
> http://lists.jackaudio.org/listinfo.cgi/jack-devel-jackaudio.org
>
>

_______________________________________________
Jack-Devel mailing list
Jack-Devel@...
http://lists.jackaudio.org/listinfo.cgi/jack-devel-jackaudio.org