Skip to content
Snippets Groups Projects
Commit c0fa22c8 authored by Augustin Lemesle's avatar Augustin Lemesle
Browse files

Merge branch 'content/blanchard/bug-reporting' into 'master'

Updates bug reporting page

See merge request !28
parents a124248a 9b1ecc74
No related branches found
No related tags found
1 merge request!28Updates bug reporting page
Pipeline #26061 passed
--- ---
layout: clean_page layout: clean_page
title: Bug reporting
--- ---
# Using the Bug Tracking System # Report an issue with Frama-C
- You must have an account to report an issue on the [Bug Tracking To report an issue, You must either create an account on the
System (BTS)](http://bts.frama-c.com/view_all_bug_page.php). If you [GitLab of Frama-C](https://git.frama-c.com/), or use your Github
are creating your account for your first bug report, consider this account. The reporting is done through the
trade-off carefully: we will never use your e-mail address to [issue tracking system](https://git.frama-c.com/pub/frama-c/issues).
contact you for something other than the bug you reported. But if
you provide an invalid e-mail address, your bug may linger for If you are creating your account for your first bug report, consider
months because the assignee is waiting for more feedback and you this trade-off carefully: we will never use your e-mail address to
didn't receive the notice. contact you for something other than the bug you reported. But if you
provide an invalid e-mail address, your bug may linger for months
<!-- end list --> because the assignee is waiting for more feedback and you didn't
receive the notice.
- Use English to report an issue on the BTS. Using French is also
acceptable to report a **private** issue. The menu "Choose a template" provides a template "bug_report" that
you just have to fill in.
<!-- end list -->
Some advices to post your issue:
- Whenever possible, include **HOW TO REPRODUCE** the issue. Provide
everything necessary for a smart, but not mind-reading, human to - Use English to report an issue. Using French is also acceptable to
reproduce the bug: input files, command line used, sequence of report a **private** issue.
actions. If your analysis project depends on system headers, please - If the bug report is not for a crash, include the **EXPECTED
use one of the two options from [this BEHAVIOR** that you would have liked to see.
message](http://lists.gforge.inria.fr/pipermail/frama-c-discuss/2008-December/000831.html). - Include the **OBTAINED BEHAVIOR** in enough detail that someone else
(smart, but not mind-reading) can decide if they have reproduced
<!-- end list --> your bug.
- Include **HOW TO REPRODUCE** the issue. Provide everything necessary
- If possible, attach the automatically-generated journal (by default for a smart, but not mind-reading, human to reproduce the bug: input
called `frama_c_journal.ml`). Journals are enabled automatically files, command line used, sequence of actions. If your analysis
when you use the GUI, or when using option `-journal-enable`. project depends on system headers, please use one of the two following
Including a journal or a backtrace when available does not exempt options to be sure that:
you from providing the input files: a backtrace or a journal alone - (Preferred) Use the option `-print` of Frama-C
do not contain enough information to reproduce the behavior. ```
$ frama-c ./your_files*.c -ocode result.c
<!-- end list --> ```
- Use the preprocessor (Note however that this second option will
- Include the **OBTAINED BEHAVIOR** in enough detail that someone else drop ACSL annotations, using `-CC` keeps all comments):
(smart, but not mind-reading) can decide if they have reproduced ```
your bug. $ gcc -C -E -I . original.c > result.i
```
<!-- end list -->
The status of an issue may be one of the following:
- Include the **CATEGORY**, that is which part of Frama-C is concerned
by your bug report or feature request. Note that issues related to - new: the issue has not been yet considered by any Frama-C developer.
Why, including issues with Why's Graphical User Interface, must be - assigned: the issue has been assigned to a Frama-C developer. However the
classified in the category "Plug-in \> Jessie" (and not in the assignee has not yet considered this issue.
category "Graphical User Interface" which is only relevant for - confirmed: the issue has been confirmed by the assignee (or by any Frama-C
issues specific to Frama-c's GUI). developer if there is no assignee). It is really a bug or a wished feature.
- resolved: the issue has been fixed by the assignee. The Frama-C development
<!-- end list --> version contains the patch which will be part of a future release.
- closed: the issue is no more relevant. Either it is not really a bug or a
- If the bug report is not for a crash, include the **EXPECTED wished feature, or it is fixed in a public release available from the
BEHAVIOR** that you would have liked to see. [download page of Frama-C](/html/get-frama-c.html).
<!-- end list -->
- The status of an issue may be one of the following:
- **new** (lightred): the issue has not been yet considered by any
Frama-C developer.
- **assigned** (mauve): the issue has been assigned to a Frama-C
developer (automatically or manually by another Frama-C
developer). However the assignee has not yet considered this
issue.
- **acknowledged** (orange): the issue has been considered by the
assignee (or by any Frama-C developer if there is no assignee)
but not yet deeply investigated.
- **confirmed** (yellow): the issue has been confirmed by the
assignee (or by any Frama-C developer if there is no assignee).
It is really a bug or a wished feature.
- **resolved** (lightgreen): the issue has been fixed by the
assignee. The Frama-C development version contains the patch
which will be part of a future release.
- **closed** (lightgray): the issue is no more relevant. Either it
is not really a bug or a wished feature, or it is fixed in a
public release available from [the download
page](http://frama-c.cea.fr/download.html) of Frama-C.
- **feedback** (magenta): the issue was previously considered
resolved or closed but has been reopened.
<!-- end list -->
- Remark: the **feedback** status is also used when the assignee
requires additional information from the reporter.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment