Received: by 2002:a17:90a:1609:0:0:0:0 with SMTP id n9csp2301434pja; Thu, 26 Mar 2020 12:55:29 -0700 (PDT) X-Google-Smtp-Source: ADFU+vtPNbbp2t3/2GZ1c7IyU/VecflfZb1ePg+kEw/Hmecf+HbngSHjpn+yf4p7CQruZ8CQR/oi X-Received: by 2002:a05:6830:4025:: with SMTP id i5mr8023475ots.203.1585252529331; Thu, 26 Mar 2020 12:55:29 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1585252529; cv=none; d=google.com; s=arc-20160816; b=ytziXxpfKTI6GMz5iEbEc670HfSyeeS/HTnWK96jobAPQ4SUjV0vzzUbCiFO21C2gO s80cfgJ/WM0HdruoNRIVhk9QgZD6H8RJWKnaua1ZaeOSMPbuni7IAH03CiqnVrYCEY6Q PscOY+jzqb1DZy3wkX0cqbUPlQDBuARF3weofVShbrDrwECwh55Bh2Yotw1hryYQ4WiO oqLfypsGXs65cslc74JBB0bbk+MGETrSY5K0tdDPM5JZqjuEY8c2/Uk7Y214xwU+LWLI fL6gk5klJqGFPIa5xPJgxeUTsZ/J/qmigIAzd3TbHlTQw5sfTry1C74F9C/Anud9/NKr KrZQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:in-reply-to:content-disposition :mime-version:references:message-id:subject:cc:to:from:date :dkim-signature; bh=qBHJQbHLQF5fkECeKcaVm9P1eGfOjzxiiidEad5lOk0=; b=AKA3X74n55BKCLLTJGhLUJjdMv1fdr43DEjFIJG04fqPzLpDxtGKY9pRlYdy0jQdV/ czwKg57ey8Ycjc621OmN5OQxlnVPO2RoUeabThI6OLe2UGp9D9xjmDzxFaq9lDt+EVhG SeFiR+6WUYuN6HUUKEjBc8FPcmge7evUu+MpKxVtdoXHrvO2WvBHJRrjJRbW4h7IhhrL j4YseTj6emaVVzE+tFjMKvXBaBeGPg3un//10OJQJZKUsxXrL5hVwhpIs6VmdZwwLV+J H8yBfabcWwh3oeH38Ax97VqvVbQNyi4ofd7edg/QgJE377H6OvqUQECQsSSWsYweCHlW CYwQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@infradead.org header.s=bombadil.20170209 header.b=qYUIFzAt; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id a190si1327415oib.146.2020.03.26.12.55.15; Thu, 26 Mar 2020 12:55:29 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=fail header.i=@infradead.org header.s=bombadil.20170209 header.b=qYUIFzAt; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728649AbgCZTyV (ORCPT + 99 others); Thu, 26 Mar 2020 15:54:21 -0400 Received: from bombadil.infradead.org ([198.137.202.133]:41740 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728317AbgCZTyU (ORCPT ); Thu, 26 Mar 2020 15:54:20 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=In-Reply-To:Content-Type:MIME-Version :References:Message-ID:Subject:Cc:To:From:Date:Sender:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description; bh=qBHJQbHLQF5fkECeKcaVm9P1eGfOjzxiiidEad5lOk0=; b=qYUIFzAtI84UJLvuJGcNV+sO/w SSvEvCyVIHdUEkaeu1Ab3448vSH9GWkQdoya+vLKZig1NWhJuFGdaoAbYlNaixUGgkmkO8scdsM9o kkuN88Zz4/l/JiR7Dq3BDnRmOPjJgKRygtDYEjW8FM51VU6tPyrRcnDnqX4u0xHonq33djUEpFbRT lVJDRivxv9EaiFLuQG9Ov1N7f7OF8tfkA7cpX+lfQwi4BKaqJFBCMC1Z8Q86p8e+4QMenAif9wlx6 ZIfCunk+1+tP2NHsRghq0z512sFGi5fmMw4hBGfHUNCliW7M5AB/mVhG5QlpEfrUm14g/IIasmZQ+ I+pyjxNQ==; Received: from willy by bombadil.infradead.org with local (Exim 4.92.3 #3 (Red Hat Linux)) id 1jHYa4-0005Xg-FA; Thu, 26 Mar 2020 19:54:20 +0000 Date: Thu, 26 Mar 2020 12:54:20 -0700 From: Matthew Wilcox To: peter@bikeshed.quignogs.org.uk Cc: linux-kernel@vger.kernel.org, Greg Kroah-Hartman , "Rafael J. Wysocki" , linux-doc@vger.kernel.org, Jonathan Corbet Subject: Re: [PATCH v3 1/1] A compact idiom to add code examples in kerneldoc comments. Message-ID: <20200326195420.GO22483@bombadil.infradead.org> References: <20200326192947.GM22483@bombadil.infradead.org> <20200326195156.11858-1-peter@bikeshed.quignogs.org.uk> <20200326195156.11858-2-peter@bikeshed.quignogs.org.uk> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20200326195156.11858-2-peter@bikeshed.quignogs.org.uk> Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Thu, Mar 26, 2020 at 07:51:56PM +0000, peter@bikeshed.quignogs.org.uk wrote: > From: Peter Lister > > scripts/kernel-doc - When a double colon follows a section heading > (e.g. Example::), write a double colon line to the ReST output to make > the following text (e.g. a code snippet) into a literal block. > > drivers/base/platform.c - Changed Example: headings to Example:: to > literalise code snippets as above. > > This patch also removes two kerneldoc build warnings: > ./drivers/base/platform.c:134: WARNING: Unexpected indentation. > ./drivers/base/platform.c:213: WARNING: Unexpected indentation. > > Signed-off-by: Peter Lister Reviewed-by: Matthew Wilcox (Oracle) (just to be clear, I'm no python programmer; I like the idea and it looks clear enough to me)