[PR PATCH] steam: move documentation to README.voidlinux

[PR PATCH] steam: move documentation to README.voidlinux

[cinerea0]

[-- Attachment #1: Type: text/plain, Size: 1607 bytes --]

There is a new pull request by cinerea0 against master on the void-packages repository

https://github.com/cinerea0/void-packages steam
https://github.com/void-linux/void-packages/pull/30243

steam: move documentation to README.voidlinux
<!-- Mark items with [x] where applicable -->

#### General
- [ ] This is a new package and it conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)

#### Have the results of the proposed changes been tested?
- [x] I use the packages affected by the proposed changes on a regular basis and confirm this PR works for me
- [ ] I generally don't use the affected packages but briefly tested this PR

<!--
If GitHub CI cannot be used to validate the build result (for example, if the
build is likely to take several hours), make sure to
[skip CI](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#continuous-integration).
When skipping CI, uncomment and fill out the following section.
Note: for builds that are likely to complete in less than 2 hours, it is not
acceptable to skip CI.
-->
<!-- 
#### Does it build and run successfully? 
(Please choose at least one native build and, if supported, at least one cross build. More are better.)
- [ ] I built this PR locally for my native architecture, (ARCH-LIBC)
- [ ] I built this PR locally for these architectures (if supported. mark crossbuilds):
  - [ ] aarch64-musl
  - [ ] armv7l
  - [ ] armv6l-musl
-->


A patch file from https://github.com/void-linux/void-packages/pull/30243.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-steam-30243.patch --]
[-- Type: text/x-diff, Size: 4231 bytes --]

From b49fc0388acbcc992af1d1ad1409d12b62ddcbb0 Mon Sep 17 00:00:00 2001
From: cinerea0 <cinerea0@protonmail.com>
Date: Wed, 14 Apr 2021 16:21:13 -0400
Subject: [PATCH] steam: move documentation to README.voidlinux

---
 srcpkgs/steam/INSTALL.msg            | 25 ++------------
 srcpkgs/steam/files/README.voidlinux | 49 ++++++++++++++++++++++++++++
 srcpkgs/steam/template               |  5 ++-
 3 files changed, 55 insertions(+), 24 deletions(-)
 create mode 100644 srcpkgs/steam/files/README.voidlinux

diff --git a/srcpkgs/steam/INSTALL.msg b/srcpkgs/steam/INSTALL.msg
index 196c392f45be..3f33b10f959e 100644
--- a/srcpkgs/steam/INSTALL.msg
+++ b/srcpkgs/steam/INSTALL.msg
@@ -1,23 +1,2 @@
-Steam on x86_64 requires support for OpenGL/Vulkan in 32bits mode,
-the 32bit packages are available in the `multilib` repository.
-
-	# xbps-install -Syv void-repo-multilib{,-nonfree}
-	# xbps-install -S
-
-Generic (for all systems):
-
-	- libgcc-32bit libstdc++-32bit libdrm-32bit libglvnd-32bit
-
-For users of the open source drivers:
-
-	- mesa-dri-32bit
-
-For users of the proprietary NVIDIA driver:
-
-	- nvidia-libs-32bit (latest nvidia package)
-	- nvidia390-libs-32bit (latest previous package)
-	- nvidia340-libs-32bit (latest package for old GPUs)
-
-For mesa users this would result in:
-
-	# xbps-install -Syv libgcc-32bit libstdc++-32bit libdrm-32bit libglvnd-32bit mesa-dri-32bit
+Consult /usr/share/doc/steam/README.voidlinux for further installation
+instructions and troubleshooting information.
diff --git a/srcpkgs/steam/files/README.voidlinux b/srcpkgs/steam/files/README.voidlinux
new file mode 100644
index 000000000000..25f226d921fb
--- /dev/null
+++ b/srcpkgs/steam/files/README.voidlinux
@@ -0,0 +1,49 @@
+Steam on i686 should work without needing to install any extra packages.
+Steam on x86_64 requires support for OpenGL/Vulkan in 32bits mode,
+the 32bit packages are available in the multilib repository.
+
+	# xbps-install -S void-repo-multilib{,-nonfree}
+	# xbps-install -S
+
+Generic (for all systems):
+
+	- libgcc-32bit libstdc++-32bit libdrm-32bit libglvnd-32bit
+
+For users of the open source drivers:
+
+	- mesa-dri-32bit
+
+For users of the proprietary NVIDIA driver:
+
+	- nvidia-libs-32bit (latest nvidia package)
+	- nvidia390-libs-32bit (latest previous package)
+	- nvidia340-libs-32bit (latest package for old GPUs)
+
+For mesa users this would result in:
+
+	# xbps-install -S libgcc-32bit libstdc++-32bit libdrm-32bit libglvnd-32bit mesa-dri-32bit
+
+The dbus service must be enabled, and the mono package will need to be
+installed for some games to function.
+
+If games are running slowly or not at all, or there are issues with network
+streaming, verify that your user belongs to the video group.
+
+If your audio is not working, try installing pulseaudio and
+alsa-plugins-pulseaudio.
+
+If you are encountering runtime errors, the Steam Ubuntu bootstrap tarball might
+be using an incompatible libstdc++ library. You can verify this by running the
+following command:
+
+	$ LIBGL_DEBUG=verbose steam
+
+If that is the issue, removing the supplied libstdc++ from
+~/.local/share/steam will fix it. Note that this is a temporary solution, as
+this file will be restored every time the Steam client is updated. For a more
+reliable solution, you can try overriding problematic libraries with
+LD_PRELOAD:
+
+	$ LD_PRELOAD='/usr/$LIB/libstdc++.so.6 /usr/$LIB/libgcc_s.so.1 /usr/$LIB/libxcb.so.1' steam
+
+For convenience, you can put this in a script or an alias.
diff --git a/srcpkgs/steam/template b/srcpkgs/steam/template
index 972db525e1eb..a92e751af686 100644
--- a/srcpkgs/steam/template
+++ b/srcpkgs/steam/template
@@ -1,7 +1,7 @@
 # Template file for 'steam'
 pkgname=steam
 version=1.0.0.70
-revision=1
+revision=2
 archs="i686 x86_64"
 wrksrc=steam-launcher
 depends="zenity xz curl dbus freetype gdk-pixbuf hicolor-icon-theme desktop-file-utils
@@ -30,4 +30,7 @@ do_install() {
 	# Device support for Steam-related hardware (e.g. controllers over Steam Link)
 	vinstall ${FILESDIR}/60-steam-input.rules 644 usr/lib/udev/rules.d
 	vinstall ${FILESDIR}/60-steam-vr.rules 644 usr/lib/udev/rules.d
+	
+	# Void-specific documentation.
+	vdoc "${FILESDIR}/README.voidlinux"
 }

Re: [PR REVIEW] steam: move documentation to README.voidlinux

[abenson]

[-- Attachment #1: Type: text/plain, Size: 199 bytes --]

New review comment by abenson on void-packages repository

https://github.com/void-linux/void-packages/pull/30243#discussion_r613596389

Comment:
This might be pedantic, but get rid of the tab here.

Re: [PR REVIEW] steam: move documentation to README.voidlinux

[abenson]

[-- Attachment #1: Type: text/plain, Size: 187 bytes --]

New review comment by abenson on void-packages repository

https://github.com/void-linux/void-packages/pull/30243#discussion_r613596769

Comment:
Drop this line, `nvidia340` is gone(ish)

Re: [PR PATCH] [Updated] steam: move documentation to README.voidlinux

[cinerea0]

[-- Attachment #1: Type: text/plain, Size: 1612 bytes --]

There is an updated pull request by cinerea0 against master on the void-packages repository

https://github.com/cinerea0/void-packages steam
https://github.com/void-linux/void-packages/pull/30243

steam: move documentation to README.voidlinux
<!-- Mark items with [x] where applicable -->

#### General
- [ ] This is a new package and it conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)

#### Have the results of the proposed changes been tested?
- [x] I use the packages affected by the proposed changes on a regular basis and confirm this PR works for me
- [ ] I generally don't use the affected packages but briefly tested this PR

<!--
If GitHub CI cannot be used to validate the build result (for example, if the
build is likely to take several hours), make sure to
[skip CI](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#continuous-integration).
When skipping CI, uncomment and fill out the following section.
Note: for builds that are likely to complete in less than 2 hours, it is not
acceptable to skip CI.
-->
<!-- 
#### Does it build and run successfully? 
(Please choose at least one native build and, if supported, at least one cross build. More are better.)
- [ ] I built this PR locally for my native architecture, (ARCH-LIBC)
- [ ] I built this PR locally for these architectures (if supported. mark crossbuilds):
  - [ ] aarch64-musl
  - [ ] armv7l
  - [ ] armv6l-musl
-->


A patch file from https://github.com/void-linux/void-packages/pull/30243.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-steam-30243.patch --]
[-- Type: text/x-diff, Size: 4230 bytes --]

From 8cc7ebe927512403cc06067c88b789ceaeda2b25 Mon Sep 17 00:00:00 2001
From: cinerea0 <cinerea0@protonmail.com>
Date: Wed, 14 Apr 2021 17:24:22 -0400
Subject: [PATCH] steam: move documentation to README.voidlinux

---
 srcpkgs/steam/INSTALL.msg            | 25 ++------------
 srcpkgs/steam/files/README.voidlinux | 49 ++++++++++++++++++++++++++++
 srcpkgs/steam/template               |  5 ++-
 3 files changed, 55 insertions(+), 24 deletions(-)
 create mode 100644 srcpkgs/steam/files/README.voidlinux

diff --git a/srcpkgs/steam/INSTALL.msg b/srcpkgs/steam/INSTALL.msg
index 196c392f45be..3f33b10f959e 100644
--- a/srcpkgs/steam/INSTALL.msg
+++ b/srcpkgs/steam/INSTALL.msg
@@ -1,23 +1,2 @@
-Steam on x86_64 requires support for OpenGL/Vulkan in 32bits mode,
-the 32bit packages are available in the `multilib` repository.
-
-	# xbps-install -Syv void-repo-multilib{,-nonfree}
-	# xbps-install -S
-
-Generic (for all systems):
-
-	- libgcc-32bit libstdc++-32bit libdrm-32bit libglvnd-32bit
-
-For users of the open source drivers:
-
-	- mesa-dri-32bit
-
-For users of the proprietary NVIDIA driver:
-
-	- nvidia-libs-32bit (latest nvidia package)
-	- nvidia390-libs-32bit (latest previous package)
-	- nvidia340-libs-32bit (latest package for old GPUs)
-
-For mesa users this would result in:
-
-	# xbps-install -Syv libgcc-32bit libstdc++-32bit libdrm-32bit libglvnd-32bit mesa-dri-32bit
+Consult /usr/share/doc/steam/README.voidlinux for further installation
+instructions and troubleshooting information.
diff --git a/srcpkgs/steam/files/README.voidlinux b/srcpkgs/steam/files/README.voidlinux
new file mode 100644
index 000000000000..25f226d921fb
--- /dev/null
+++ b/srcpkgs/steam/files/README.voidlinux
@@ -0,0 +1,49 @@
+Steam on i686 should work without needing to install any extra packages.
+Steam on x86_64 requires support for OpenGL/Vulkan in 32bits mode,
+the 32bit packages are available in the multilib repository.
+
+	# xbps-install -S void-repo-multilib{,-nonfree}
+	# xbps-install -S
+
+Generic (for all systems):
+
+	- libgcc-32bit libstdc++-32bit libdrm-32bit libglvnd-32bit
+
+For users of the open source drivers:
+
+	- mesa-dri-32bit
+
+For users of the proprietary NVIDIA driver:
+
+	- nvidia-libs-32bit (latest nvidia package)
+	- nvidia390-libs-32bit (latest previous package)
+	- nvidia340-libs-32bit (latest package for old GPUs)
+
+For mesa users this would result in:
+
+	# xbps-install -S libgcc-32bit libstdc++-32bit libdrm-32bit libglvnd-32bit mesa-dri-32bit
+
+The dbus service must be enabled, and the mono package will need to be
+installed for some games to function.
+
+If games are running slowly or not at all, or there are issues with network
+streaming, verify that your user belongs to the video group.
+
+If your audio is not working, try installing pulseaudio and
+alsa-plugins-pulseaudio.
+
+If you are encountering runtime errors, the Steam Ubuntu bootstrap tarball might
+be using an incompatible libstdc++ library. You can verify this by running the
+following command:
+
+	$ LIBGL_DEBUG=verbose steam
+
+If that is the issue, removing the supplied libstdc++ from
+~/.local/share/steam will fix it. Note that this is a temporary solution, as
+this file will be restored every time the Steam client is updated. For a more
+reliable solution, you can try overriding problematic libraries with
+LD_PRELOAD:
+
+	$ LD_PRELOAD='/usr/$LIB/libstdc++.so.6 /usr/$LIB/libgcc_s.so.1 /usr/$LIB/libxcb.so.1' steam
+
+For convenience, you can put this in a script or an alias.
diff --git a/srcpkgs/steam/template b/srcpkgs/steam/template
index 972db525e1eb..1574edc98dd1 100644
--- a/srcpkgs/steam/template
+++ b/srcpkgs/steam/template
@@ -1,7 +1,7 @@
 # Template file for 'steam'
 pkgname=steam
 version=1.0.0.70
-revision=1
+revision=2
 archs="i686 x86_64"
 wrksrc=steam-launcher
 depends="zenity xz curl dbus freetype gdk-pixbuf hicolor-icon-theme desktop-file-utils
@@ -30,4 +30,7 @@ do_install() {
 	# Device support for Steam-related hardware (e.g. controllers over Steam Link)
 	vinstall ${FILESDIR}/60-steam-input.rules 644 usr/lib/udev/rules.d
 	vinstall ${FILESDIR}/60-steam-vr.rules 644 usr/lib/udev/rules.d
+
+	# Void-specific documentation.
+	vdoc "${FILESDIR}/README.voidlinux"
 }

Re: [PR REVIEW] steam: move documentation to README.voidlinux

[abenson]

[-- Attachment #1: Type: text/plain, Size: 221 bytes --]

New review comment by abenson on void-packages repository

https://github.com/void-linux/void-packages/pull/30243#discussion_r613597263

Comment:
(I should have already done this, but it's an opportunity as good as any!)

Re: [PR PATCH] [Updated] steam: move documentation to README.voidlinux

[cinerea0]

[-- Attachment #1: Type: text/plain, Size: 1612 bytes --]

There is an updated pull request by cinerea0 against master on the void-packages repository

https://github.com/cinerea0/void-packages steam
https://github.com/void-linux/void-packages/pull/30243

steam: move documentation to README.voidlinux
<!-- Mark items with [x] where applicable -->

#### General
- [ ] This is a new package and it conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)

#### Have the results of the proposed changes been tested?
- [x] I use the packages affected by the proposed changes on a regular basis and confirm this PR works for me
- [ ] I generally don't use the affected packages but briefly tested this PR

<!--
If GitHub CI cannot be used to validate the build result (for example, if the
build is likely to take several hours), make sure to
[skip CI](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#continuous-integration).
When skipping CI, uncomment and fill out the following section.
Note: for builds that are likely to complete in less than 2 hours, it is not
acceptable to skip CI.
-->
<!-- 
#### Does it build and run successfully? 
(Please choose at least one native build and, if supported, at least one cross build. More are better.)
- [ ] I built this PR locally for my native architecture, (ARCH-LIBC)
- [ ] I built this PR locally for these architectures (if supported. mark crossbuilds):
  - [ ] aarch64-musl
  - [ ] armv7l
  - [ ] armv6l-musl
-->


A patch file from https://github.com/void-linux/void-packages/pull/30243.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-steam-30243.patch --]
[-- Type: text/x-diff, Size: 4176 bytes --]

From cf3b1662803a3b118b84f57891256bdee39221a6 Mon Sep 17 00:00:00 2001
From: cinerea0 <cinerea0@protonmail.com>
Date: Wed, 14 Apr 2021 17:39:22 -0400
Subject: [PATCH] steam: move documentation to README.voidlinux

---
 srcpkgs/steam/INSTALL.msg            | 25 ++-------------
 srcpkgs/steam/files/README.voidlinux | 48 ++++++++++++++++++++++++++++
 srcpkgs/steam/template               |  5 ++-
 3 files changed, 54 insertions(+), 24 deletions(-)
 create mode 100644 srcpkgs/steam/files/README.voidlinux

diff --git a/srcpkgs/steam/INSTALL.msg b/srcpkgs/steam/INSTALL.msg
index 196c392f45be..3f33b10f959e 100644
--- a/srcpkgs/steam/INSTALL.msg
+++ b/srcpkgs/steam/INSTALL.msg
@@ -1,23 +1,2 @@
-Steam on x86_64 requires support for OpenGL/Vulkan in 32bits mode,
-the 32bit packages are available in the `multilib` repository.
-
-	# xbps-install -Syv void-repo-multilib{,-nonfree}
-	# xbps-install -S
-
-Generic (for all systems):
-
-	- libgcc-32bit libstdc++-32bit libdrm-32bit libglvnd-32bit
-
-For users of the open source drivers:
-
-	- mesa-dri-32bit
-
-For users of the proprietary NVIDIA driver:
-
-	- nvidia-libs-32bit (latest nvidia package)
-	- nvidia390-libs-32bit (latest previous package)
-	- nvidia340-libs-32bit (latest package for old GPUs)
-
-For mesa users this would result in:
-
-	# xbps-install -Syv libgcc-32bit libstdc++-32bit libdrm-32bit libglvnd-32bit mesa-dri-32bit
+Consult /usr/share/doc/steam/README.voidlinux for further installation
+instructions and troubleshooting information.
diff --git a/srcpkgs/steam/files/README.voidlinux b/srcpkgs/steam/files/README.voidlinux
new file mode 100644
index 000000000000..35d1fe4798d0
--- /dev/null
+++ b/srcpkgs/steam/files/README.voidlinux
@@ -0,0 +1,48 @@
+Steam on i686 should work without needing to install any extra packages.
+Steam on x86_64 requires support for OpenGL/Vulkan in 32bits mode,
+the 32bit packages are available in the multilib repository.
+
+	# xbps-install -S void-repo-multilib{,-nonfree}
+	# xbps-install -S
+
+Generic (for all systems):
+
+	- libgcc-32bit libstdc++-32bit libdrm-32bit libglvnd-32bit
+
+For users of the open source drivers:
+
+	- mesa-dri-32bit
+
+For users of the proprietary NVIDIA driver:
+
+	- nvidia-libs-32bit (latest nvidia package)
+	- nvidia390-libs-32bit (latest previous package)
+
+For mesa users this would result in:
+
+	# xbps-install -S libgcc-32bit libstdc++-32bit libdrm-32bit libglvnd-32bit mesa-dri-32bit
+
+The dbus service must be enabled, and the mono package will need to be
+installed for some games to function.
+
+If games are running slowly or not at all, or there are issues with network
+streaming, verify that your user belongs to the video group.
+
+If your audio is not working, try installing pulseaudio and
+alsa-plugins-pulseaudio.
+
+If you are encountering runtime errors, the Steam Ubuntu bootstrap tarball might
+be using an incompatible libstdc++ library. You can verify this by running the
+following command:
+
+	$ LIBGL_DEBUG=verbose steam
+
+If that is the issue, removing the supplied libstdc++ from
+~/.local/share/steam will fix it. Note that this is a temporary solution, as
+this file will be restored every time the Steam client is updated. For a more
+reliable solution, you can try overriding problematic libraries with
+LD_PRELOAD:
+
+	$ LD_PRELOAD='/usr/$LIB/libstdc++.so.6 /usr/$LIB/libgcc_s.so.1 /usr/$LIB/libxcb.so.1' steam
+
+For convenience, you can put this in a script or an alias.
diff --git a/srcpkgs/steam/template b/srcpkgs/steam/template
index 972db525e1eb..1574edc98dd1 100644
--- a/srcpkgs/steam/template
+++ b/srcpkgs/steam/template
@@ -1,7 +1,7 @@
 # Template file for 'steam'
 pkgname=steam
 version=1.0.0.70
-revision=1
+revision=2
 archs="i686 x86_64"
 wrksrc=steam-launcher
 depends="zenity xz curl dbus freetype gdk-pixbuf hicolor-icon-theme desktop-file-utils
@@ -30,4 +30,7 @@ do_install() {
 	# Device support for Steam-related hardware (e.g. controllers over Steam Link)
 	vinstall ${FILESDIR}/60-steam-input.rules 644 usr/lib/udev/rules.d
 	vinstall ${FILESDIR}/60-steam-vr.rules 644 usr/lib/udev/rules.d
+
+	# Void-specific documentation.
+	vdoc "${FILESDIR}/README.voidlinux"
 }

Re: steam: move documentation to README.voidlinux

[cinerea0]

[-- Attachment #1: Type: text/plain, Size: 465 bytes --]

New comment by cinerea0 on void-packages repository

https://github.com/void-linux/void-packages/pull/30243#issuecomment-819868553

Comment:
As per discussion in https://github.com/void-linux/void-docs/pull/496, instructions currently located in INSTALL.msg have been moved to README.voidlinux, and troubleshooting information previously located in the Void wiki has been moved to that file as well. The INSTALL.msg file now directs users to check the README file.

Re: [PR PATCH] [Merged]: steam: move documentation to README.voidlinux

[abenson]

[-- Attachment #1: Type: text/plain, Size: 1456 bytes --]

There's a merged pull request on the void-packages repository

steam: move documentation to README.voidlinux
https://github.com/void-linux/void-packages/pull/30243

Description:
<!-- Mark items with [x] where applicable -->

#### General
- [ ] This is a new package and it conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)

#### Have the results of the proposed changes been tested?
- [x] I use the packages affected by the proposed changes on a regular basis and confirm this PR works for me
- [ ] I generally don't use the affected packages but briefly tested this PR

<!--
If GitHub CI cannot be used to validate the build result (for example, if the
build is likely to take several hours), make sure to
[skip CI](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#continuous-integration).
When skipping CI, uncomment and fill out the following section.
Note: for builds that are likely to complete in less than 2 hours, it is not
acceptable to skip CI.
-->
<!-- 
#### Does it build and run successfully? 
(Please choose at least one native build and, if supported, at least one cross build. More are better.)
- [ ] I built this PR locally for my native architecture, (ARCH-LIBC)
- [ ] I built this PR locally for these architectures (if supported. mark crossbuilds):
  - [ ] aarch64-musl
  - [ ] armv7l
  - [ ] armv6l-musl
-->