doc/user/bugs.rst

   1 .. index:: Bug Reports
   2 .. index:: Reporting bugs
   3
   4 .. _bug-reports:
   5
   6 **************
   7 Reporting Bugs
   8 **************
   9
  10 This file describes the procedure for reporting FRRouting bugs.  You are asked
  11 to follow this format when submitting bug reports.
  12
  13 Bugs submitted with woefully incomplete information will receive little
  14 attention and are likely to be closed. If you hit a suspected bug in an older
  15 version, you may be asked to test with a later version in your environment.
  16
  17 Often you may be asked for additional information to help solve the bug. Bugs
  18 may be closed after 30 days of non-response to requests to reconfirm or supply
  19 additional information.
  20
  21 Please report bugs on the project GitHub issue tracker at
  22 https://github.com/frrouting/frr/issues
  23
  24 Report Format & Requested Information
  25 =====================================
  26
  27 When reporting a bug, please provide the following information.
  28
  29 #. Your FRR version if it is a release build, or the commit hash if you built
  30    from source.
  31
  32 #. If you compiled from source, please provide your ``./configure`` line,
  33    including all option flags.
  34
  35 #. A full list of the FRR daemons you run.
  36
  37 #. Your platform name and version, e.g. ``Ubuntu 18.04``.
  38
  39 #. Problem description.
  40
  41    - Provide as much information as possible.
  42    - Copy and paste relevant commands and their output to describe your network
  43      setup.
  44    - Topology diagrams are helpful when reporting bugs involving more than one
  45      box.
  46    - Platform routing tables and interface configurations are useful if you are
  47      reporting a routing issue.
  48
  49    *Please be sure to review the provided information and censor any sensitive
  50    material.*
  51
  52 #. All FRR configuration files you use. Again, please be sure to censor any
  53    sensitive information. For sensitive v4 / v6 addresses, we ask that you
  54    censor the inner octets; e.g., ``192.XXX.XXX.32/24``.
  55
  56 #. If you are reporting a crash and have a core file, please supply a stack
  57    trace using GDB:
  58
  59    ::
  60
  61       $ gdb exec_file core_file
  62         (gdb) bt .
  63
  64 #. Run all FRR daemons with full debugging on and send *only* the portion of
  65    logs which are relevant to your problem.
  66
  67 #. Patches, workarounds, and fixes are always welcome.
  68
  69 .. seealso:: :ref:`basic-config-commands`
  70