From patchwork Wed May 3 03:54:16 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 89558 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp1070447vqo; Tue, 2 May 2023 21:32:13 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ6dIiMj9bkeiiM0A3ibd4YX/ec7vgCt0uNKo26d8Wc0ap35n9ZsrZ25mMZF0EO5fSkCIsAa X-Received: by 2002:a17:902:f693:b0:1a6:db0a:8005 with SMTP id l19-20020a170902f69300b001a6db0a8005mr779527plg.68.1683088333642; Tue, 02 May 2023 21:32:13 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1683088333; cv=none; d=google.com; s=arc-20160816; b=wv3vqHrWUxwD4Z9miDyXDiVBLWUf0Vm4UhuffLozX17MEx8ie9j73i2rHBzC+Tt925 yiXyLJMZTG4iMih43Wihb2BqNLcZ7MpXT4C6ah0i/ko6VK5gYVdKLXNI7+ZjTk2tcQXt CzgDAzCwgkJFZBiQqbm1dtMbZNvLjDXzM3PD0rn61+uMbRIOU3nzDda6opyhO8ZWw5Y7 MAURRb85D7ty22hQQzOK7VZNH+ZGtgU83/8pUtxByu5ooqK5gfcf6Y2SmVjR3F+oXceT kVx972y8p1P9wasGzPpurL+C+CeH/k9/d6R/p2rsGcBPJ4L+uCAFO1+uVKt/rCZI6fkr UYlA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=6q3+C/O6BV/0gC+jrMbg3MwoGAyt7Cv6nHU3v3zys3I=; b=UMGJ7R//CCLCvvsrJtlW1xweVmMY5ikCABRFZp7WdDYVh85kaPXQLg/+YmRO+vcRrn ADwOc9BuuQSP6R9iAXRxcKyvRE+nA6I4ybMZ/Nop6SSi6ImPIX7yUklttcAetSLViwK1 pL/QUUtacyjxLQoLH8JsJNX0ob+Oh7u64j1wSPwIlI67aOdbwuP5Oiq37afGW1gTXfDn qtw+3bNU9xzfHyga4BUFZOEEpLwtyVaRmJoG7Kr6iheLlPPy560UUWfRS8DzrzChOhgN mAxXJ0C5g+IKgCS3VOY/wDOUrn+6aR3aZyWuO3Z2LVVOhEsRzCZV55FtUQnIw+wcpP3u mVIQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20221208 header.b=rDNoWnGh; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id d22-20020a170902aa9600b001a6709378c0si30699650plr.333.2023.05.02.21.31.56; Tue, 02 May 2023 21:32:13 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20221208 header.b=rDNoWnGh; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229555AbjECDy1 (ORCPT + 99 others); Tue, 2 May 2023 23:54:27 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36852 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229487AbjECDyZ (ORCPT ); Tue, 2 May 2023 23:54:25 -0400 Received: from mail-pl1-x630.google.com (mail-pl1-x630.google.com [IPv6:2607:f8b0:4864:20::630]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 05B741730; Tue, 2 May 2023 20:54:24 -0700 (PDT) Received: by mail-pl1-x630.google.com with SMTP id d9443c01a7336-1aaf2ede38fso32476155ad.2; Tue, 02 May 2023 20:54:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683086063; x=1685678063; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=6q3+C/O6BV/0gC+jrMbg3MwoGAyt7Cv6nHU3v3zys3I=; b=rDNoWnGhJwAj76Ge80sW8/InyLnBi7jwU23z97T9EoARIFUNIbUaF+GQ2D6DSU+vll BsowuuPL6I9xhwUYyaiYWWm3C01pX1qNTK7LzYk/ZiqHGEhsel0iJBK5GbeC5O/cIUkL dryGwMTYB0/Lsxn6sOHxgqg0DWg6rCzHVtKM6OfSmGKsvLXR1l6emV6kQY8nKt6ppTM8 K/k1e28rmsxf4toOeLGhuN/YtinfmiH6IjLZGLmiYE4+q512hzPS9bGYvhb2la5246Ka cdqT1bMUPyYmrk6CgHTVwxzc7wR1NU2mAmSVJgTUU9GMskLiEM/Lfa3XUrwrP6/sBLay ErgQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683086063; x=1685678063; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=6q3+C/O6BV/0gC+jrMbg3MwoGAyt7Cv6nHU3v3zys3I=; b=TMu3lRfxienkkazSMuH+fqtcuixaxCO60VNn6qZhk0L4dztKHMbafn8zWN9l0k0LwN V0nHfCSTCi/x/e6BxTGFdbfaiJ4zn29wFuTpZ2X2al6UB/UqikYqn/5OfpVu0bkjKTa4 fqySOsZgncq/vrdsVWzaPavqcC4KTTZOZ5U54cTKMxZdDBJt0DMoi2QN1qkGd47WyeG0 K/tcMlwoFgjGCQMP69a0VDt4feNYPPESbxvVMvOim4hk6KUndktCrY8hpMuvcHJyiQ44 iuoMaA9WfAvJAX4WnUEPM/mZs1wpptLgBW+HuyBRHRiVfDLtyn2gtk3Mau6FN27rcndH xsuA== X-Gm-Message-State: AC+VfDwKN3iuzbpJpKS+ZPwoELnvNvtlEK4L7GWsGTbOCnrikSnhWj6Q oKXAaHyGV1PsDk5M8pSdfPM= X-Received: by 2002:a17:902:e88d:b0:1a6:6fe3:df8d with SMTP id w13-20020a170902e88d00b001a66fe3df8dmr899006plg.8.1683086063246; Tue, 02 May 2023 20:54:23 -0700 (PDT) Received: from debian.me (subs03-180-214-233-11.three.co.id. [180.214.233.11]) by smtp.gmail.com with ESMTPSA id c7-20020a170902aa4700b001a1faeac240sm20512918plr.186.2023.05.02.20.54.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 02 May 2023 20:54:22 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id EA49D10622E; Wed, 3 May 2023 10:54:19 +0700 (WIB) From: Bagas Sanjaya To: Linux ALSA Subsystem Development , Linux Documentation , Linux Kernel Mailing List Cc: Jaroslav Kysela , Takashi Iwai , Jonathan Corbet , Oswald Buddenhagen , Miquel Raynal , Takashi Sakamoto , Bagas Sanjaya , kernel test robot Subject: [PATCH] ALSA: docs: Fix code block indentation in ALSA driver example Date: Wed, 3 May 2023 10:54:16 +0700 Message-Id: <20230503035416.62722-1-bagasdotme@gmail.com> X-Mailer: git-send-email 2.40.1 MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=2821; i=bagasdotme@gmail.com; h=from:subject; bh=6LXELRL34BN4LPhBXSHO4pfAXrYd4OlwOyi8Y9pLNbI=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDCmBt16EPVP9HMJw1cC8qGTVAZcZf8692rCv/c3y4A//r 828EGOb3FHKwiDGxSArpsgyKZGv6fQuI5EL7WsdYeawMoEMYeDiFICJqLcz/HdaG928N+2fsO23 7GWPuuIr9ObPqFrxL47fLLTKoTT8rQzD//LruWeVlM387uu+VpnT0rnkSfrzML3a7PZ5HdJPUph mMQIA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-0.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,RCVD_IN_SORBS_WEB,SPF_HELO_NONE,SPF_PASS, T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1764846032660413499?= X-GMAIL-MSGID: =?utf-8?q?1764846032660413499?= Sphinx reports htmldocs warnings: Documentation/sound/kernel-api/writing-an-alsa-driver.rst:3997: WARNING: Literal block expected; none found. Documentation/sound/kernel-api/writing-an-alsa-driver.rst:4004: WARNING: Literal block expected; none found. Documentation/sound/kernel-api/writing-an-alsa-driver.rst:4009: WARNING: Unexpected indentation. Documentation/sound/kernel-api/writing-an-alsa-driver.rst:4035: WARNING: Literal block expected; none found. These are due to indentation of example driver snippets which is outside the code block scope. Fix these by indenting code blocks in question to the scope. Fixes: 4d421eebe1465d ("ALSA: docs: writing-an-alsa-driver.rst: polishing") Reported-by: kernel test robot Closes: https://lore.kernel.org/linux-doc/202305021822.4U6XOvGf-lkp@intel.com/ Signed-off-by: Bagas Sanjaya --- .../kernel-api/writing-an-alsa-driver.rst | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) base-commit: 348551ddaf311c76b01cdcbaf61b6fef06a49144 diff --git a/Documentation/sound/kernel-api/writing-an-alsa-driver.rst b/Documentation/sound/kernel-api/writing-an-alsa-driver.rst index c0f97b5e424969..4335c98b3d828f 100644 --- a/Documentation/sound/kernel-api/writing-an-alsa-driver.rst +++ b/Documentation/sound/kernel-api/writing-an-alsa-driver.rst @@ -3994,21 +3994,21 @@ Driver with A Single Source File Suppose you have a file xyz.c. Add the following two lines:: - snd-xyz-objs := xyz.o - obj-$(CONFIG_SND_XYZ) += snd-xyz.o + snd-xyz-objs := xyz.o + obj-$(CONFIG_SND_XYZ) += snd-xyz.o 2. Create the Kconfig entry Add the new entry of Kconfig for your xyz driver:: - config SND_XYZ - tristate "Foobar XYZ" - depends on SND - select SND_PCM - help - Say Y here to include support for Foobar XYZ soundcard. - To compile this driver as a module, choose M here: - the module will be called snd-xyz. + config SND_XYZ + tristate "Foobar XYZ" + depends on SND + select SND_PCM + help + Say Y here to include support for Foobar XYZ soundcard. + To compile this driver as a module, choose M here: + the module will be called snd-xyz. The line ``select SND_PCM`` specifies that the driver xyz supports PCM. In addition to SND_PCM, the following components are supported for @@ -4032,7 +4032,7 @@ located in the new subdirectory, sound/pci/xyz. 1. Add a new directory (``sound/pci/xyz``) in ``sound/pci/Makefile`` as below:: - obj-$(CONFIG_SND) += sound/pci/xyz/ + obj-$(CONFIG_SND) += sound/pci/xyz/ 2. Under the directory ``sound/pci/xyz``, create a Makefile::