Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

handbook/wayland: improve synopsis readability #287

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ our toolchain in your own projects, please read the Documentation Primer at:

for information about the tools and formatting languages we use.
Chapter 1 has a Quick Start section, and Chapter 2 covers the software
and related items in more detail.
and related items in more detail.
Copy link
Contributor

@concussious concussious May 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, that didn't work. What I was suggesting is to revert proposed changes to the README entirely.

The current state of the PR damages the tree by changing the blame for line 9.

EDIT: and please don't credit me, I absolutely did not coauthor any of this.

8 changes: 4 additions & 4 deletions documentation/content/en/books/handbook/wayland/_index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ endif::[]

[[wayland-synopsis]]
== Wayland Synopsis
Wayland is a new display server, but it differs from Xorg in several important ways.
First, Wayland is only a protocol that acts as an intermediary between clients using a different mechanism which removes the dependency on an X server.
Xorg includes both the X11 protocol, used to run remote displays and the X server will accept connections and display windows.
Under Wayland, the compositor or window manager provides the display server instead of a traditional X server.
Wayland is a communication protocol that can replace a display server such as Xorg. It differs from Xorg in several important ways.

First, Wayland is only a protocol that acts as an intermediary between clients using a mechanism which removes the dependency on an X server.
Xorg includes both the X11 protocol, used to run remote displays, and the X server, used to accept connections and display windows.
Under Wayland, the compositor or window manager provides the display server instead of a traditional X server.
Since Wayland is not an X server, traditional X screen connections will need to utilize other methods such as VNC or RDP for remote desktop management.
Second, Wayland can manage composite communications between clients and a compositor as a separate entity which does not need to support the X protocols.
Comment on lines +53 to 59

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i really like the suggestions, flow a little nicer than the previous version.

Copy link
Contributor

@concussious concussious Apr 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They absolutely flow nicer than before.
EDIT: thus, actually I retract my deleted suggestion to submit a PR prepending a synopsis to this.

My suggestion is just a suggestion, and it is an honor for me to be here.

That said, please look at the introductory paragraph of the synopsis of every preceding chapter.


Expand Down
Loading