Template:Bug/doc

From Gentoo Wiki
Jump to:navigation Jump to:search
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.

Link to bugs at several bugtrackers (default is https://bugs.gentoo.org).

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Bug number/term1

Specify a bug number (''search'' default). If you search by package, specify a package string. If you search by product, specify the product

Example
12345
Stringrequired
Sitesite

Specify a different bugtracker than Gentoo's. Supported are "kde", "freedesktop"/"fdo" and "launchpad".

Stringoptional
Searchsearch

Specify a search method: by ''id'' (default), by ''package'' name or by ''product'' (Bugzilla only).

Stringoptional
Componentcomponent

Specify a component (only valid for ''product'' search).

Stringoptional
Link texttext

Specify a custom text to override the automatic link text.

Contentoptional

Usage

See the template's testcases:


Correct

One anonymous parameter: bug number
Wiki code
{{Bug|100}}
Main version
Make sure to see bug #100 about...
Sandbox version
Make sure to see bug #100 about...


Parameter site
Wiki code
{{Bug|100|site=fdo}}
Main version
Sandbox version


Using search=package to search by package name
Wiki code
{{Bug|sys-apps/portage|search=package}}
Main version
Sandbox version


Using search=product to search by product name
Wiki code
{{Bug|PulseAudio|search=product|site=fdo}}
Main version
Sandbox version


Using search=product and component
Wiki code
{{Bug|Gentoo%20Linux|component=KDE|search=product}}
Main version
Sandbox version


Parameter text
Wiki code
{{Bug|100|text=Some text}}
Main version
Sandbox version


Using search=email to search by assigned to email
Wiki code
{{Bug|wiki@gentoo.org|search=email}}
Main version
Sandbox version


Incorrect

No parameter (error message)
Wiki code
{{Bug}}
Main version
{{Bug template error}}
Parameter 1 not defined. For correct usage see Bug template's documentation on the 1 parameter.
Sandbox version
{{Bug template error}}
Parameter 1 not defined. For correct usage see Bug template's documentation on the 1 parameter.


Development

This template relies on functionality inherited via the following sub-templates: