Bug 220808

Summary:	[Handbook] Section 5.4 Duplicate Instruction for "User Group for Accelerated Video"
Product:	Documentation	Reporter:	Guangyuan Yang <ygy>
Component:	Books & Articles	Assignee:	freebsd-doc (Nobody) <doc>
Status:	Closed Works As Intended
Severity:	Affects Some People	CC:	wblock, ygy
Priority:	---
Version:	Latest
Hardware:	Any
OS:	Any

Description Guangyuan Yang freebsd_committer

2017-07-17 19:40:13 UTC

In Section 5.4.1 and Section 5.4.2, the instructions for "Adding user to user group for accelerated video" appeared twice. Which one should I delete?

5.4.1. Quick Start
...
Add the user who will run Xorg to the video or wheel group to enable 3D acceleration when available. To add user jru to whichever group is available:

# pw groupmod video -m jru || pw groupmod wheel -m jru
...

5.4.2. User Group for Accelerated Video
Access to /dev/dri is needed to allow 3D acceleration on video cards. It is usually simplest to add the user who will be running X to either the video or wheel group. Here, pw(8) is used to add user slurms to the video group, or to the wheel group if there is no video group:

# pw groupmod video -m slurms || pw groupmod wheel -m slurms

Comment 1 Guangyuan Yang freebsd_committer

2017-07-18 20:14:18 UTC

Notice that "5.4.1 Quick Start" has the contents from 5.4.2, 5.4.3 and part of 5.4.4. This is a bit confusing. How should we differentiate "Quick Start" from the rest of the detailed instructions to achieve a balance?

Comment 2 Warren Block freebsd_committer

2017-07-20 14:43:17 UTC

The Quick Start is a short summary of what is required to get X configured for those who want to use it without reading a lot of explanatory text.  These quick start sections are kept as short as possible.

Later sections might repeat some of the same information, but with more details, like why a certain action or option is needed.

So the answer to which should be deleted is "neither".

Comment 3 Guangyuan Yang freebsd_committer

2017-07-20 15:08:04 UTC

Thanks for the reply, now I get the idea. I would still say it was a bit confusing for myself at first because as a beginner, it takes time to realize that what are the similar contents or same steps, and what is essential for X to run.