microsoft / wslg

Enabling the Windows Subsystem for Linux to include support for Wayland and X server related scenarios
MIT License
9.9k stars 296 forks source link

add documentation on what linux software/packages (and their versions) are provided by wslg #1210

Open razamatan opened 3 months ago

razamatan commented 3 months ago

Is your feature request related to a problem:

i'm running gentoo under wsl2, and i've been trying to use gentoo's package.provided mechanism to avoid installing pusleaudio, weston and wayland to avoid runtime errors and installing them as they're provided by wslg. however, i don't know what versions are installed in wslg easily. currently, my package.provided looks like this:

$ cat /etc/portage/profile/package.provided
dev-libs/wayland-1.21.0
dev-libs/weston-9.0.0
media-sound/pulseaudio-16.1
media-sound/pulseaudio-daemon-17.0-r1

i logged into wslg using wsl --system and tried to --version all the ones listed above. wayland was a stab in the dark, honestly.

i also noticed i needed to install libpulse b/c it's not clear to me where the header and lib files for wslg is exposed under my wsl2 instance for by portage builds to reference pulse for building. i'm assuming this is fine, but it would be good to address how users should compile against the provided wslg parts.

Describe the solution you'd like:

add documentation that identifies the various software/packages provided by wslg and instructions on how to link/compile against them. this way, users like me (or distros) can work to make wslg seamlessly integrated under wsl2.

Describe alternatives you've considered:

  1. not using package.provided mechanism to avoid installing a local version of these daemons and such. this is bad.
  2. manually keeping my package.provided up to date blindly. this works for now, but i would like to make this solution more robust with improved documentation from the wslg project.

Additional context:

No response

razamatan commented 3 months ago

for more context on trying to find include/lib stuff for compiling against the wslg items, i couldn't find anything useful under /mnt/wslg . the distro subdir is just my distro, not the wslg one afaict.

razamatan commented 3 months ago

also, i saw that a dbus exists in /mnt/wslg, but b/c i can't compile against it afaiu, i ended up having to install dbus locally on my gentoo instance.