Gentoo Wiki:Article Blueprints/Hardware/Devices/Example

From Gentoo Wiki
Jump to: navigation, search
Resources

(Introductory paragraph goes here. Describe the device. It is okay to mention the device's friendliness to open source drivers. Optionally, it is nice provide a nice summary of why or why not a user would want to buy this device for use with Linux.)

Hardware

Standard

Device Make/model Status Vendor ID / Product ID Kernel driver(s) Kernel version Notes
USB microphone Blue Yeti Pro Works 074d:0002 snd-usb-audio (when built as a module) 4.4.1 Enable kernel option SND_USB_AUDIO in the kernel.

Installation

(Write the necessary steps to get this device running in Gentoo. Try to document any special step that each user will need to reproduce on their system. Includes getting special drivers or firmware from a manufacturer's website, etc. )

Firmware

(Optional section.)

Kernel

(Show what options are necessary in the kernel in order to get all device components functional for this hardware platform.)

KERNEL Enable support for these hardware drivers
Write menuconfig instructions here.

Emerge

(Optional section. If the platform requires any user space packages or kernel patches, mention them here).

root #emerge --ask category/package

Configuration

(Explain any additional configuration or special customization for this device. Could be anything from BIOS settings to setting up a service.)

Example 1

(Example: When using Pulse Audio, be sure to select this microphone an as audio source.)

Troubleshooting

(Optional section.)

(Troubleshoot issues in this section. Separate issues by best describing the error with a new section name. Remove this section and subsections if no issues are known.)

Issue 1

(Describe the problem, then describe the solution/workaround to the problem.)

When X happens, Y is how you fix it.

See also

(Optional section.)

External resources

(Optional section.)

  • (Link to external resources (outside the Wiki) using bullet points in this section. It is common for the information in this section to full sentences that are links.)

References

(Optional section. Remove this section if references are not used. This section is used to cite factual information. This information is found outside the Gentoo Wiki and used to back up truth claims. The actual references themselves still be littered throughout the main article.)

(Remove improper categories before publishing the article.)