Page MenuHomeFreeBSD
Differential D38143

Handbook WG - X11
ClosedPublic
Actions

Authored by carlavilla on Jan 21 2023, 6:58 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Nov 21, 4:50 PM
Unknown Object (File)
Oct 29 2024, 4:50 PM
Unknown Object (File)
Oct 22 2024, 11:12 PM
Unknown Object (File)
Oct 22 2024, 11:12 PM
Unknown Object (File)
Oct 22 2024, 11:12 PM
Unknown Object (File)
Oct 22 2024, 11:12 PM
Unknown Object (File)
Oct 22 2024, 11:12 PM
Unknown Object (File)
Oct 22 2024, 11:12 PM
View All Files
Subscribers
fernape
grahamperrin
markmi_dsl-only.net

Details

Reviewers
bcr
lwhsu
0mp
arrowd
jrm
• karels
yanhaowang
bapt
zeising
manu
imp
fernape
Commits
R9:4d1de1c7246d: Upgrade X11 and desktop chapters in the Handbook
Summary

Rewrite from zero the chapter. The information is stale, and at some point give users wrong instructions, like[1]

The X11 chapter is finished.
The Desktop chapter is finished.

[1] https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=258264
[2] https://carlavilla.es/freebsd/x11.html
[3] https://carlavilla.es/freebsd/desktop.html

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
• karels added inline comments.Jan 22 2023, 5:46 PM
documentation/content/en/books/handbook/x11/_index.adoc
80

Should we say that xorg is a meta-port containing many of the xorg components? I think that is useful information for anyone that wants to drill down.

839–840

I assume there is more coming here... It can probably be much more general than the old stuff.

manu added inline comments.Jan 23 2023, 8:23 AM
documentation/content/en/books/handbook/x11/_index.adoc
59

For amdgpu/radeon it's there : https://www.x.org/wiki/RadeonFeature/
I'm sure there is some link somewhere on the wiki, we should keep the link.

80

Agreed.

435

Yes it is, you will not have graphics acceleration without being a member (I'm honestly surprised that it works for you).

fernape requested changes to this revision.Jan 23 2023, 12:12 PM
fernape added a subscriber: fernape.
fernape added inline comments.
documentation/content/en/books/handbook/x11/_index.adoc
80

Yes, please.

435

In that case this shouldn't be in a warning block but be one more "normal" step in the configuration process.

574

I would move this paragraph just above the table itself, or alternatively, move the table just following this paragraph and after that showing how to know the card for you system.

619

"The Intel(R) driver" or maybe "Intel(R) drivers..." depending on the intention.

645

This probably shouldn't be a full stop but a comma and link the next sentence to this one.

686

For consistency, I would use the same phrasing as before. This is not loading the module, but adding the module to /etc/rc.conf so it can be loaded at boot time. The NVidia section uses correctly that phrasing.

841

"if starting X server results..." --> if starting _the_ X server results...
"or observe these..." --> or these values are observed...

This revision now requires changes to proceed.Jan 23 2023, 12:12 PM
carlavilla marked 14 inline comments as done.Feb 7 2023, 7:47 PM

I'm gonna upgrade the chapter finished and all comments fixed.

documentation/content/en/books/handbook/x11/_index.adoc
839–840

Fixed, my fault hehe

carlavilla updated this revision to Diff 116735.Feb 7 2023, 7:52 PM
carlavilla marked an inline comment as done.

I fixed all the comments.

Also finished the X11 chapter. I know that we can improve the input devices and monitor section. But we can make this changes in further commits.

I also moved the GNOME, KDE Plasma and XFCE desktop instructions to a "new" chapter.
Right now GNOME, KDE Plasma, etc cannot be "associated" with X11, since they also support Wayland.

Therefore, I think the right thing to do is to move them to a "new" chapter.

(Well, not a new one, only I upgraded the title of the desktop chapter hehe)

carlavilla edited the summary of this revision. (Show Details)Feb 7 2023, 7:54 PM
arrowd added inline comments.Feb 7 2023, 8:02 PM
documentation/content/en/books/handbook/desktop/_index.adoc
193

Typo "preferred".

205

This can be extended with information on sddm internationalization - sddm_lang var. Example: sddm_lang="ru_RU".

208

How about ... is by manually invoking man:startx[1]?

213

Here you talk about .xinitrc, but the command example appends to .xsession.

arrowd added inline comments.Feb 8 2023, 6:01 AM
documentation/content/en/books/handbook/x11/_index.adoc
163

These two statements should be one.

219

Why use -f /etc/rc.conf argument there?

573–574

How about adding a sentence

Some desktop environments (such as KDE Plasma) provide a graphical UI for setting these parameters. Check it before resorting to manual config editing.

carlavilla updated this revision to Diff 116867.Feb 9 2023, 5:27 PM
carlavilla marked 7 inline comments as done.

Fixed! @arrowd Thanks!
I'll try to finish the Desktop chapter this night.

Do you think there's something more we can add to the KDE Plasma section?

arrowd added a comment.Feb 9 2023, 5:48 PM

This looks pretty good. Great job, @carlavilla !

documentation/content/en/books/handbook/x11/_index.adoc
218

I meant that whole -f /etc/rc.conf was extraneous, as sysrc acts on this file by default. The sysrc /etc/rc.conf ... line is now wrong.

carlavilla updated this revision to Diff 116899.Feb 9 2023, 9:41 PM

Fix some bugs and add more desktops.
Started with the browsers section - WIP

carlavilla marked an inline comment as done.Feb 9 2023, 9:41 PM
carlavilla added inline comments.
documentation/content/en/books/handbook/x11/_index.adoc
218

Sorry, I was on autopilot hahaha

And I took it from https://wiki.freebsd.org/Graphics/#Intel_Integrated_Graphics_.28aka_HD_Graphics.29

jrm added inline comments.Feb 9 2023, 10:35 PM
documentation/content/en/books/handbook/desktop/_index.adoc
159

Changing applications to environments here seems strange to me, because of what the rest of the sentence says. How about something like this?

This chapter demonstrates how to install popular desktop environments as well as desktop application such as web browsers, productivity software, document viewers, and financial software.

fernape added inline comments.Feb 10 2023, 12:08 PM
documentation/content/en/books/handbook/x11/_index.adoc
162

I would rephrase this avoiding in this way that feels more natural:

The following command can be used to identify which graphics card is installed in the system

185

Similarly as before

This command can be used to check the booting mode

235

The FreeBSD Project provides/maintains a matrix... ?

314–315

This warning is a duplicated of this one that appears earlier:

nvidia-modeset must be used only as an alternative to nvidia if starting X server results in a hang.

Probably just one of them (I would say this one) is enough.

583

I would use

... to configure the keyboard layout

But I don't have a very strong opinion here.

611

At some point in this section (probably at the end) we could add something like:

//If you want to know more about fonts, please read this article

fernape added a comment.Feb 10 2023, 3:45 PM

A round of typos and small things.

documentation/content/en/books/handbook/desktop/_index.adoc
775

Typo

s/kde-meta-instal/kde-meta-install

894

Typo

s/gnome-meta-instal/gnome-meta-install

968

Typo

s/prefered/preferred

993

Typo
s/xfce-instal/xfce-install

1068

Typo

s/mate-meta-instal/mate-meta-install

1164

Typo

s/cinnamon-instal/cinnamon-install

1239

Typo

s/lxqt-instal/lxqt-install

documentation/content/en/books/handbook/x11/_index.adoc
134

Typo:

s/Propietary/Proprietary

459

Typo (although not user visible)

s/x-config-video-cards-file-multple/x-config-video-cards-file-multiple

579

While common, probably s/config/configuration

carlavilla updated this revision to Diff 116981.Feb 11 2023, 9:14 AM
carlavilla marked 17 inline comments as done.

Fixed typos

carlavilla added inline comments.Feb 11 2023, 4:30 PM
documentation/content/en/books/handbook/x11/_index.adoc
459

Really good catch haha

carlavilla updated this revision to Diff 116988.Feb 11 2023, 4:30 PM
carlavilla edited the summary of this revision. (Show Details)
jrm added a comment.Feb 12 2023, 3:29 PM

These are suggestions based on our Matrix discussion. It lets readers know once at the beginning of the chapter that any package can be custom built from the port, but we only describe how to install the package for each application.

documentation/content/en/books/handbook/desktop/_index.adoc
56–57

While FreeBSD is popular as a server for its performance and stability, it is also well suited for day-to-day use as a desktop.
With over {numports} applications available in the FreeBSD ports tree, it is straightforward to build a customized desktop that can run a wide variety of desktop applications.

59–63

Prerequisites:

  • Readers of this chapter should already understand how to either install either the crossref:x11[x11,X Window System] or crossref:wayland[wayland,Wayland] on FreeBSD.
  • Readers are instructed throughout this chapter to install official packages. Refer to the section on crossref:ports[ports-using,using the ports collection] to build customized packages from ports.
111–113
Install KDE Plasma meta package

To install the KDE Plasma meta package with KDE Frameworks, Plasma Desktop and Applications execute:

119–128
230
232
239–248
252
331
338–347
404
406
426
433–442
502
577
780–787
804–811
826–833
846–853
868–875
909–916
982–989
1108–1117
1221–1228
1333–1340
carlavilla updated this revision to Diff 117113.Feb 13 2023, 7:32 PM
carlavilla marked 27 inline comments as done.
This revision was not accepted when it landed; it landed in state Needs Review.Feb 13 2023, 7:50 PM
Closed by commit R9:4d1de1c7246d: Upgrade X11 and desktop chapters in the Handbook (authored by carlavilla). · Explain Why
This revision was automatically updated to reflect the committed changes.
carlavilla added a commit: R9:4d1de1c7246d: Upgrade X11 and desktop chapters in the Handbook.
markmi_dsl-only.net added a subscriber: markmi_dsl-only.net.Mar 28 2023, 10:36 PM
markmi_dsl-only.net added inline comments.
documentation/content/en/books/handbook/x11/_index.adoc
187

On aarch64 (a HoneyComb), booted via UEFI/ACPI, I get:

# sysctl machdep.bootmethod
sysctl: unknown oid 'machdep.bootmethod'

The specific material seems to be platform specific for a presumed (set of?) platform(s).

The context was:

# uname -apKU
FreeBSD CA72_16Gp_ZFS 14.0-CURRENT FreeBSD 14.0-CURRENT #90 main-n261544-cee09bda03c8-dirty: Wed Mar 15 20:25:49 PDT 2023     root@CA72_16Gp_ZFS:/usr/obj/BUILDs/main-CA72-nodbg-clang/usr/main-src/arm64.aarch64/sys/GENERIC-NODBG-CA72 arm64 aarch64 1400082 1400082
grahamperrin added a subscriber: grahamperrin.Jul 30 2023, 4:50 AM
grahamperrin added inline comments.
documentation/content/en/books/handbook/x11/_index.adoc
1351

Losing sight of this NVIDIA-provided tool seems unfortunate.

Revision Contents
Changeset List

PathSize
documentation/
1 line
content/
en/
books/
handbook/
desktop/
1356 lines
x11/
1541 lines
website/
1 line

Diff 116988

View Options

documentation/.gitignore

Loading...
View Options

documentation/content/en/books/handbook/desktop/_index.adoc

Loading...
View Options

documentation/content/en/books/handbook/x11/_index.adoc

Loading...
View Options

website/.gitignore

Loading...