From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 84F77C433F5 for ; Fri, 1 Apr 2022 06:26:40 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S245394AbiDAG21 (ORCPT ); Fri, 1 Apr 2022 02:28:27 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42576 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S245389AbiDAG2U (ORCPT ); Fri, 1 Apr 2022 02:28:20 -0400 Received: from mail-wr1-x42b.google.com (mail-wr1-x42b.google.com [IPv6:2a00:1450:4864:20::42b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D981325FD76 for ; Thu, 31 Mar 2022 23:26:29 -0700 (PDT) Received: by mail-wr1-x42b.google.com with SMTP id i4so2714927wrb.5 for ; Thu, 31 Mar 2022 23:26:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=79X7EtfQCqwMr9U+t9hQNmDXR2b/b+GMQS5utWvmVGQ=; b=fmfXk+Tv4xoqeekZzf6ZPTtQTZzHuzsEiNhIbI99tXJEhnC/b+7H7/6zXj3xUr3Gk1 d7AiW1f/qw/y5HSVcIGSlkjHg5+2XT2CtNk9FW5dCbsF6Gh/RnvSVzGWJuJ5+8ikninc Jh5BQrsxGB93d3lgswATCM7ggLH3Ho4K6b2roHHWA9wytrD5u8mGLDjESgELUx+9fUAn 9zBXebPeViMHI+GTxJDVicHYBwg/a41E116freioQua2oX9WgeVY74IRTx7UNpiYJ9qW bW6WXv2TyTeHljiOY7cbryPfWDEOzNK8LFM+cZbFtNiQRGIig5RB+XRc8iRFUN+qmZii Sc0Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=79X7EtfQCqwMr9U+t9hQNmDXR2b/b+GMQS5utWvmVGQ=; b=CBONbOKo+DC953CxcWDM4gAaXozXHl/PTDPnhAFp57I5VMh3FWYee8LK8BfiE5ayTt PsHl2VdGN+JFvUfCor4Ig4Nova3kiUjtaXNzUlip+rfDAD3iacXeGMFmmjG/kPwVuGfS nOwI6tNm5eJgKlY6cwCYCJimxqYOAe9v8sdtQuqDRXM1IjU0/QLsSCa2Y+vpPQK0bReO DVEjPrhlWcMzJ8ssmTaVwKR5osl8v/lEBXC+49APq8ZhNrEpHqJwlUPsEkNSn5bMp8wB 6PQg57Ir1s7SFkFP+XhXGnLY8Q0CNxWCUVXn+o31w/YKOZlNXKZG+4fTyU/jFKTFfdDh 1Iig== X-Gm-Message-State: AOAM530yxemZMkQu+uH2taV0VMGqYCrbfkl2yUZ1g8AKcESxcepKzzU4 fi1p15XciU8yLeet0y5dZCoRZ+ezx1LHdT9Ynh3qdw== X-Google-Smtp-Source: ABdhPJxnCUH3DJN5Nhe1ho/cqLXP0iSBxtKYIuNCsF9SlZXn6TImxlu2h66ypv37iXWHmKcGWs6XmmUw8zB+duCMT7A= X-Received: by 2002:a05:6000:2c7:b0:205:cb41:2a82 with SMTP id o7-20020a05600002c700b00205cb412a82mr6304240wry.395.1648794388277; Thu, 31 Mar 2022 23:26:28 -0700 (PDT) MIME-Version: 1.0 References: <20220401024707.10550-1-rdunlap@infradead.org> In-Reply-To: <20220401024707.10550-1-rdunlap@infradead.org> From: David Gow Date: Fri, 1 Apr 2022 14:26:16 +0800 Message-ID: Subject: Re: [PATCH] Documentation: kunit: eliminate code-block warnings To: Randy Dunlap Cc: Linux Kernel Mailing List , Brendan Higgins , "open list:KERNEL SELFTEST FRAMEWORK" , KUnit Development , Jonathan Corbet , "open list:DOCUMENTATION" , Harinder Singh , Tim Bird Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Fri, Apr 1, 2022 at 10:47 AM Randy Dunlap wrote: > > Fix Sphinx complaints about code-block directive missing an argument. > For start.rst, add "none" since that is already heavily used in that > file. For run_wrapper.rst, use the simpler "::" literal block instead. > > dev-tools/kunit/start.rst:83: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > > dev-tools/kunit/run_wrapper.rst:17: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > dev-tools/kunit/run_wrapper.rst:23: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > dev-tools/kunit/run_wrapper.rst:31: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > dev-tools/kunit/run_wrapper.rst:51: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > dev-tools/kunit/run_wrapper.rst:57: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > dev-tools/kunit/run_wrapper.rst:78: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > dev-tools/kunit/run_wrapper.rst:85: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > dev-tools/kunit/run_wrapper.rst:109: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > dev-tools/kunit/run_wrapper.rst:116: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > dev-tools/kunit/run_wrapper.rst:124: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > dev-tools/kunit/run_wrapper.rst:139: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > dev-tools/kunit/run_wrapper.rst:162: WARNING: Error in "code-block" directive: > 1 argument(s) required, 0 supplied. > > Fixes: c48b9ef1f794 ("Documentation: KUnit: Rewrite getting started") > Fixes: 46201d47d6c4 ("Documentation: kunit: Reorganize documentation related to running tests") > Signed-off-by: Randy Dunlap > Cc: Brendan Higgins > Cc: linux-kselftest@vger.kernel.org > Cc: kunit-dev@googlegroups.com > Cc: Jonathan Corbet > Cc: linux-doc@vger.kernel.org > Cc: Harinder Singh > Cc: Tim Bird > --- Thanks for fixing these. Out of curiosity, is there a particular config option or version you need to set in sphinx to get these warnings? My setup (with Sphinx 4.3.2) doesn't warn on this. Nevertheless, I'll keep a closer eye on code-block directives in future. Reviewed-by: David Gow Cheers, -- David