2.8 How to Report speechd-el or Speech Dispatcher Bugs
When you encounter a speechd-el bug, you can report it to us using the
following command. Before doing it, please read the whole text of
this section to allow handling your bug report in a more efficient way.
- M-x speechd-bug
-
Report a speechd-el or Speech Dispatcher bug. The command asks you
for some information and then asks you whether you can reproduce the
bug. If you can, answer y and start reproducing the bug
immediately. As soon as the bug is reproduced, type C-e C-f.
Then you can (and should) further edit the generated mail and send it
in the usual way.
- M-x speechd-bug-reproduce
-
Start reproducing a speechd-el or Speech Dispatcher bug. All user and
Speech Dispatcher actions are watched from this moment.
Bug reproduction is finished by pressing the C-e C-f keys.
After the bug reproduction is finished, information about it is
inserted into the buffer where the speechd-bug-reproduce
command was invoked.
This command is useful when you want to provide information about a
bug without generating new bug report.
When reporting the bugs, please always remember the following
instructions:
- Write as much information about the problem as possible. Describe
what doesn’t work, what’s the expected behavior, what actions have
triggered the bug, what’s special about your Emacs environment or
Speech Dispatcher configuration, etc. Don’t try to analyze too much
which information is important and which is not — everything may be
important to the developers, so try not to forget to mention anything
that might be important, better more than less. Missing information
may cause the developers won’t be able to handle the bug at all.
- Be as much precise as possible. Don’t expect the developers to know
the context or to know the way you typically use Emacs and speechd-el.
Write in exact terms — instead of just writing “when I invoke foo”
write better “when I press the keys ‘M-x foo RET’, thus invoking the
‘foo’ command”; or instead of writing “doesn’t speak what I expect”
write like “speaks ‘blah blah’ instead of ‘bleh bleh bleh’ what is I
expect, since ‘bleh bleh bleh’ is the text of the whole line”.
- When reproducing the bug, try to have the Speech Dispatcher logging
enabled to the highest level — set the
LogLevel
option to
5
in your speechd.conf configuration file.
- When reproducing the bug, don’t do any extra actions and invoke
C-e C-f as soon as the bug is reproduce. Thus you avoid losing
the relevant information of the automatically extracted log files in
an unnecessary garbage.
- You can also look at the Speech Dispatcher bug reporting instructions,
see Reporting Bugs in Speech Dispatcher.