On 11/7/24 1:40 PM, Jonathan Corbet wrote: > Randy Dunlap <rdunlap@xxxxxxxxxxxxx> writes: > >> On 11/7/24 12:45 PM, Jonathan Corbet wrote: >>> anish kumar <yesanishhere@xxxxxxxxx> writes: >>> >>>> Add a comprehensive debugging guide for ALSA audio issues, covering >>>> topics from bootup to runtime debugging. This document aims to help >>>> developers diagnose and resolve common audio problems in Linux. >>>> >>>> The guide includes sections on: >>>> - Bootup/bringup issues >>>> - Runtime debugging >>>> - XRUN debugging >>>> - Audio pops and clicks >>>> >>>> This addresses the lack of a centralized debugging resource for ALSA >>>> and should help improve the troubleshooting process for audio drivers. >>>> >>>> Inspired by discussions on LKML: >>>> https://lkml.org/lkml/2024/9/24/392 >>>> >>>> Signed-off-by: anish kumar <yesanishhere@xxxxxxxxx> >>>> --- >>>> Documentation/sound/soc/debug.rst | 334 ++++++++++++++++++++++++++++++ >>>> Documentation/sound/soc/index.rst | 1 + >>>> 2 files changed, 335 insertions(+) >>>> create mode 100644 Documentation/sound/soc/debug.rst >>> >>> At a first glance, this seems useful. >>> >>> I was just looking at Sebastian's new debugging documentation: >>> >>> https://lore.kernel.org/all/20241028-media_docs_improve_v3-v1-0-2b1b486c223e@xxxxxxxxxxxxx/ >>> >>> ... so my immediate thought is that this documentation should be >>> coherent and together, rather than scattered though the docs. Maybe >>> move this to process/debugging and integrate it with his work? >> >> and once again I disagree that these docs should be in Documentation/process/. > > OK, I guess I missed that...where do you think we should put them? It was just a few minutes before this email. ;) I see a few possibilities, none perfect: a. in Documentation/driver-api/debug/ [not quite driver-api though] b. in Documentation/core-api/ along with debugging-via-ohci1394.rst [maybe in a new /debug/ subdir] c. in (new) Documentation/debug/ and invite the kernel debugging community to add some of their docs here as well. I'm open to other places (except "process"). -- ~Randy
