After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 730562 - Improve software instructions for debugging sound problems
Improve software instructions for debugging sound problems
Status: RESOLVED FIXED
Product: gnome-user-docs
Classification: Core
Component: gnome-help
3.12.x
Other Mac OS
: Normal normal
: ---
Assigned To: Maintainers of Gnome user documentation
Maintainers of Gnome user documentation
gnomeasia
Depends on:
Blocks:
 
 
Reported: 2014-05-22 09:11 UTC by Kat
Modified: 2014-09-20 15:25 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Kat 2014-05-22 09:11:15 UTC
aplay and lspci seem to no longer be the correct tools to use for debugging sound issues, mention of these tools needs to be reviewed and most likely removed.

I recommend deleting the sections about these tools from all pages.
Comment 1 yeqing.xiong 2014-05-23 09:06:41 UTC
We recommend :
1. we should explain that aplay and lspci cannot be used correctly now at the bottom of the related page.
2. List the steps about how to remove the tools.
Comment 2 yeqing.xiong 2014-05-23 09:52:46 UTC
what's more, give a advice of other tools to replace aplay and lspci.
Comment 3 Kat 2014-05-24 02:40:38 UTC
Hi, it would be good to document alternative tools, but I think that for now, it is just best to remove the section about hardware detection from https://git.gnome.org/browse/gnome-user-docs/tree/gnome-help/C/sound-nosound.page#n87

To do so, you need to open a terminal, go to the directory which is called gnome-user-docs. You should have a git clone of this directory already, but if you do not, then you can make a new one using 'git clone git://git.gnome.org/gnome-user-docs'.

You also need to set up git on your computer, see https://wiki.gnome.org/Git/Developers#Setting_up_Git for how to set your name and email address.

Once you have done that, open the file gnome-help/C/sound-nosound.page for editing and delete the section about hardware detection. Save the file and close it.

Run 'git commit -a', which will open a text editor. In the first line of that file, describe what you have done and mention the bug number. Keep your description to under 50 characters long. For example, "Remove sound hardware debugging, bug 730562". Save the file and close it.

Now, run 'git format-patch -1'. This will create a .patch file in your gnome-user-docs directory. Attach that file to this bug using "Add an attachment" link at the bottom.

Thank you for your contribution!
Comment 4 David King 2014-09-20 15:25:49 UTC
Thanks for the investigation. I have pushed updated instructions to master as 559e7684d5a72500f60354cd0810de5fe14f592e.