Commit 29202b90 authored by Tails developers's avatar Tails developers
Browse files

doc: Rewrite the 'Report a bug' page

parent 38045567
[[!meta title="Reporting a bug"]]
[[!meta title="Report a bug"]]
<div id="intro">
Reporting bugs is a great way of helping us improving Tails.
<p>
So you think you have found a bug in The Amnesic Incognito Live
System, and are willing to tell us about it. Great. Please read-on.
</p>
Remember that **the more effectively you report a bug**, the more likely we are
to fix it.
[[!toc levels=2]]
</div>
Check if the bug is already known
=================================
Why you should read this
========================
Have a look at:
Simply put, the more effectively you report a bug, the more likely we
are to fix it.
Check if the bug is known
=========================
Have a look to the [[list of known bugs|bugs]] and to the [[list of
bugs that are fixed in our development tree, and will therefore be fixed in the
next shipped release|bugs/pending]].
- the [[list of known bugs|bugs]]
- the [[list of bugs that will fixed in the next release|bugs/pending]]
How to write a useful bug report
================================
Please read at least the _Summary_ section of the great
[How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html#summary)
Please read at least the _Summary_ section of the great [How to Report Bugs
Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html#summary), by
Simon Tatham.
Use WhisperBack
===============
**WhisperBack is an application written specifically to report bugs anonymously
from inside Tails. If you are not able to use WhisperBack, see the [[special
cases|debugging#index4h1]].**
WhisperBack will help you fill-up a bug report, including relevant technical
details and send it to us encrypted and through Tor.
Starting WhisperBack
--------------------
You will find a shortcut to start WhisperBack on the desktop:
[[!img report_a_bug.png link=no alt="Report a Bug shortcut on the desktop"]]
You can also start it from the menu *Applications* → *System Tools* →
*WhisperBack*.
Write the report
----------------
WhisperBack let you give plenty of useful information about your bug:
- **Summary** a summary of the bug, try to be short, clear and informative
- **Name of the affected software**
- **Exact steps to reproduce the problem**
- **Actual result / the problem**
- **Desired result**
[[!img whisperback.png link=no alt="WhisperBack main window"]]
You can also have a look at the technical details that will be included in the
mail. It will give us information about your hardware, your Tails version and
the startup process.
Once you are done, you can eventually [[post|bugs]] your bug report.
[[!img technical_details.png link=no alt="Technical details at the bottom of the
main window"]]
About giving us an email address
--------------------------------
If you don't mind disclosing some bits of your identity to Tails developers, you
can provide an email address to let us ask more details about the bug.
Anyone who can see this reply will probably infer you are a Tails user. Time to
wonder how much you trust your Internet and mailbox providers?
Optional OpenPGP key
--------------------
You can also indicate an OpenPGP key corresponding to this email address. You
can either give:
- a **key ID**, if the key is available on public key servers
- a **link to the key**, if the key is available on the web
- a **public key block**, if the key is not publicly available
Sending your report
-------------------
Once you are done writing your report, send it by clicking the *Send* button.
[[!img sending_email.png link=no alt="Sending email"]]
Once your email has been sent correctly you will get the following notification.
[[!img your_message_has_been_sent.png link=no alt="Your message has been sent"]]
Special cases
=============
The Live System does not boot entirely
--------------------------------------
You might not always be able to use WhisperBack. In those cases, you can also
send you bug report by [[email|support/talk]].
In the graphical boot menu, press `TAB` to add the `debug` parameter
to the boot command line, and remove the `quiet` parameter (as many
times as it appears: remove each one) from there, so that a bunch of
hopefully useful messages are displayed on boot.
Note that if you send the report yourself, it might not be anonymous unless you
take special care (e.g. using Tor with a throw-away email account).
Then try to boot again, and append the end of the boot log (or what
seems to be relevant to your problem) to your bug report.
Tails does not boot entirely
----------------------------
1. In the graphical boot menu, press `TAB`
2. Add the `debug` parameter to the boot command line
3. Remove all appearance of the `quiet` parameter
This will hopefully display a bunch of useful messages on boot that you can
later include in your bug report.
No internet access
------------------
The WhisperBack bug reporting tool (accessed from the Tails desktop)
can of course not send the bug report when there is not internet
access. The following steps can be used as a work-around (Note that
your bug report will not be anonymous unless you take further steps
yourself (e.g. using Tor with a throw-away email account)):
WhisperBack won't be able to send your bug report.
The following steps can be used as a workaround.
1. In Tails, start the bug reporting tool
1. In Tails, start WhisperBack
2. In the bug report window, expand "technical details to include"
3. Copy everything in the "debugging info" box
4. Paste it to another document (using gedit for instance)
5. Save the document on a USB strick
6. Boot into a system with working networking and send the debugging
info to us.
5. Save the document on a USB stick
6. Boot into a system with Internet connection and send your report
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment