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 X-Spam-Level: X-Spam-Status: No, score=-2.1 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, USER_AGENT_SANE_1 autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5A5C5C2BB1D for ; Wed, 11 Mar 2020 22:25:20 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 5262620575 for ; Wed, 11 Mar 2020 22:25:20 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=armlinux.org.uk header.i=@armlinux.org.uk header.b="GCcEDNkZ" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2387443AbgCKWZT (ORCPT ); Wed, 11 Mar 2020 18:25:19 -0400 Received: from pandora.armlinux.org.uk ([78.32.30.218]:60702 "EHLO pandora.armlinux.org.uk" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729506AbgCKWZS (ORCPT ); Wed, 11 Mar 2020 18:25:18 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=armlinux.org.uk; s=pandora-2019; h=Sender:In-Reply-To:Content-Type: MIME-Version:References:Message-ID:Subject:Cc:To:From:Date:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=zoMKw5hBPldeyDV/XzXql3f4Lza+9rVoslLVy16220o=; b=GCcEDNkZskVRuwHHJOQG38em4 g7Wnk0AmCQRIWFIHPA1hzTQS95YOIFMHg3YV91HiNnTs0h3m7QAcSTShfYWl1wW1BA3Z232uHqvM5 IKpvzimU7SleKBszGsRqb03YXxUM+AGR9tm14C8g+jk+H617Jz+z+8JQXkUPpvpuXRAp/Y8tgOJ+W M2raVSlLovoyUflLscqlUemEtm4z1fpZlR0Y0nJ1YW7WG1fLaC5Wmm9qvn7zHiYqCIGDNQ3JPjmvf Ando/vA+MradyuetoL69KzX3Sui7APWzbQg1P+qFLCFYLQFChvCGAInif7Vne3HztuuEMrnzaxdhv 4r3Z9fJhw==; Received: from shell.armlinux.org.uk ([2002:4e20:1eda:1:5054:ff:fe00:4ec]:59268) by pandora.armlinux.org.uk with esmtpsa (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jC9mr-0005r6-SK; Wed, 11 Mar 2020 22:25:14 +0000 Received: from linux by shell.armlinux.org.uk with local (Exim 4.92) (envelope-from ) id 1jC9mq-0005h0-J8; Wed, 11 Mar 2020 22:25:12 +0000 Date: Wed, 11 Mar 2020 22:25:12 +0000 From: Russell King - ARM Linux admin To: Peter Lister Cc: linux-doc@vger.kernel.org, netdev@vger.kernel.org, Andrew Lunn , Florian Fainelli , Heiner Kallweit , Jonathan Corbet , linux-kernel@vger.kernel.org Subject: Re: [PATCH 1/1] Reformat return value descriptions as ReST lists. Message-ID: <20200311222512.GV25745@shell.armlinux.org.uk> References: <20200311192823.16213-1-peter@bikeshed.quignogs.org.uk> <20200311192823.16213-2-peter@bikeshed.quignogs.org.uk> <20200311203817.GT25745@shell.armlinux.org.uk> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.10.1 (2018-07-13) Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Wed, Mar 11, 2020 at 10:21:41PM +0000, Peter Lister wrote: > Hello Russell, > > > Is this really necessary? This seems to be rather OTT, and makes the > > comment way too big IMHO. > > The existing form definitely gets the formatted output wrong (I'll send you > a screen grab if you like) and causes doc build warnings. So, yes, it needs > fixing. > > ReST makes free with blank lines round blocks and list entries, and I agree > this makes for inelegant source annotation. I tried to retain the wording > unchanged and present the description as just "whitespace" changes to make a > list in the formatted output - as close as I could to what the author > appears to intend. > > If you're OK with a mild rewrite of the return value description, e.g. as > two sentences (On success: p; q. On failure: x; y; z.), then we can fix the > doc build and have terser source comments and a happier kerneldoc. I think it's more important that the documentation interferes to a minimal degree with the code in the file, so please rewrite if it improves it. (btw, I'm the author.) Thanks. -- RMK's Patch system: https://www.armlinux.org.uk/developer/patches/ FTTC broadband for 0.8mile line in suburbia: sync at 10.2Mbps down 587kbps up