LinuxCommandLibrary

reportbug

Report software bugs to Debian's bug tracker

TLDR

Generate a bug report about a specific package, then send it by e-mail

$ reportbug [package]
copy

Report a bug that is not about a specific package (general problem, infrastructure, etc.)
$ reportbug other
copy

Write the bug report to a file instead of sending it by e-mail
$ reportbug [[-o|--output]] [filename] [package]
copy

SYNOPSIS

reportbug [OPTIONS] [package ...]
reportbug [OPTIONS] --file FILENAME
reportbug [OPTIONS] --version
reportbug [OPTIONS] --help

PARAMETERS

-f, --file FILENAME
    Reads the bug report content from the specified file instead of interactive input.

-n, --no-interact
    Runs `reportbug` in a non-interactive mode, using configuration and default values where possible.

-N, --no-action
    Prepares the bug report but does not send it. Useful for reviewing or saving the report locally.

-m, --mail
    Explicitly specifies to send the bug report via email (this is the default submission method).

-u, --usenet
    Specifies to send the bug report via Usenet (NNTP) instead of email.

-q, --query-bts
    Queries the Debian Bug Tracking System (BTS) for information about a specific bug number.

-p PACKAGE, --package PACKAGE
    Specifies the name of the package the bug applies to, bypassing the interactive prompt for package selection.

-s SEVERITY, --severity SEVERITY
    Sets the bug's severity level (e.g., 'critical', 'grave', 'serious', 'important', 'normal', 'wishlist').

--no-system-info
    Prevents `reportbug` from automatically attaching general system information to the bug report.

--no-dpkg-info
    Prevents `reportbug` from automatically attaching the output of `dpkg -l` to the bug report.

--help
    Displays a concise help message with command options and exits.

--version
    Displays the version information of `reportbug` and exits.

DESCRIPTION

The `reportbug` command is a crucial utility within Debian and its derivatives, designed to facilitate the interactive reporting of bugs to the Debian Bug Tracking System (BTS). It guides users through a series of questions to gather all necessary information for a comprehensive bug report, including the affected package, its version, the severity of the bug, and a detailed description of the problem. `reportbug` automatically adds essential headers and can attach relevant system information, such as `dpkg -l` output, to the report. Users can choose to submit the report via email (the default) or save it to a file. By standardizing the bug reporting process and ensuring reports contain vital data, `reportbug` significantly aids maintainers in understanding and resolving software issues, contributing to the stability and quality of the Debian ecosystem.

CAVEATS

`reportbug` is primarily designed for and most effective within Debian and Debian-derived operating systems. While it can be manually configured on other systems, its core functionality is tied to the Debian Bug Tracking System (BTS).

Submitting bug reports via email or Usenet requires appropriate mail client (MTA) or NNTP client configuration on the system. Incorrectly filled or formatted reports may be difficult for maintainers to process, so careful attention to the interactive prompts is advised.

INTERACTIVE WORKFLOW

`reportbug` is designed to be highly interactive. When executed without specific parameters, it prompts the user through a series of questions, guiding them to select the package, describe the bug, specify its severity, and decide whether to attach system information. This step-by-step process helps users provide well-formed and complete bug reports even if they are unfamiliar with the precise requirements of the Debian Bug Tracking System.

CONFIGURATION FILE

Many aspects of `reportbug`'s behavior, such as default email address, real name, preferred submission method, and whether to include system information, can be customized via a personal configuration file, typically located at ~/.reportbugrc. This allows advanced users to set defaults and bypass repetitive questions for a more streamlined workflow.

BUG SEVERITY LEVELS

The tool prompts for a bug's severity, which helps maintainers prioritize fixes. Common severity levels include: critical (makes the package or system as a whole unusable), grave (makes the package unusable or causes data loss), serious (violates Debian policy, causes a major functionality loss), important (a bug that affects the usability of a package without making it unusable), normal (the default, a typical bug), and wishlist (a feature request).

HISTORY

The `reportbug` utility has been an integral part of the Debian project's bug reporting infrastructure for many years, evolving to streamline and standardize the process of submitting issues to the Debian Bug Tracking System (BTS). Initially simpler, it has grown into a sophisticated interactive Python script designed to gather comprehensive information from users, ensuring that bug reports are well-structured and contain all necessary details for maintainers. Its continuous development reflects Debian's commitment to community-driven maintenance and quality assurance, making bug reporting accessible and efficient for its vast user base.

SEE ALSO

dpkg(1), apt(8), apt-get(8), mail(1), bts(1)

Copied to clipboard