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.

Sign up for GitHub

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

Jump to bottom

Document backend configurations #3208

Closed
tronical opened this issue Aug 2, 2023 · 1 comment
Closed

Document backend configurations #3208

tronical opened this issue Aug 2, 2023 · 1 comment
Assignees
@tronical
Labels
a:documentation Improvements or additions to documentation (infrastructure and text itself) (mN,bS)
Milestone
1.2

Comments

@tronical
Copy link
Member

tronical commented Aug 2, 2023

There are different ways of configuring the backends, for example the winit backend has certain environment variables that it supports (WINIT_ prefixed), the linuxkms backend has some regarding the keyboard layout, vulkan/gbm display selection, etc.

We should have a section in our documentation that explains how to customise the default behavior.
@tronical tronical added the a:documentation Improvements or additions to documentation (infrastructure and text itself) (mN,bS) label Aug 2, 2023
@tronical tronical added this to the 1.2 milestone Aug 2, 2023
@tronical tronical self-assigned this Aug 2, 2023
tronical added a commit that referenced this issue Aug 24, 2023
@tronical
Initial draft for backend documentation
0d44e13 
Fixes #3208
@tronical tronical mentioned this issue Aug 24, 2023
Merged
tronical added a commit that referenced this issue Aug 24, 2023
@tronical
Initial draft for backend documentation
58a4dd8 
cc #3208
tronical added a commit that referenced this issue Aug 24, 2023
@tronical
Initial draft for backend documentation
5182660 
cc #3208
@tronical
Copy link
Member Author

I left out the WINIT_ variables because they can (and do) change between breaking winit releases (the next release 0.29 does AFAIK). What's left is to link to the backend config page from the Rust, C++, and NodeJS docs.

tronical added a commit that referenced this issue Aug 25, 2023
@tronical
Add back-links to advanced topics for Rust and C++
793f24d 
The invalid anchor in the RST is a hack that's required in order to get relative links
working with sphinx (see sphinx-doc/sphinx#701 (comment) )

cc #3208
tronical added a commit that referenced this issue Aug 25, 2023
@tronical
Add links from Rust and C++ to the common platform backend docs
291bcc6 
... and adjust the C++ platform backend docs a little to the current
state.

cc #3208
@tronical tronical mentioned this issue Aug 25, 2023
Merged
tronical added a commit that referenced this issue Aug 25, 2023
@tronical
Add links from Rust and C++ to the common platform backend docs
e7a8833 
... and adjust the C++ platform backend docs a little to the current
state.

cc #3208
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tronical tronical

Labels
a:documentation Improvements or additions to documentation (infrastructure and text itself) (mN,bS)
Projects
None yet
Milestone
1.2
Development

No branches or pull requests
1 participant
@tronical