Received: by 10.192.165.148 with SMTP id m20csp1078654imm; Thu, 10 May 2018 05:24:12 -0700 (PDT) X-Google-Smtp-Source: AB8JxZqnmlR9Qn0WVsx1mpXS4nluUSyPSIcO/+oDXkZZPZ+LEG/fNtgtWJJgEWU6GCOsSleaTLBd X-Received: by 2002:a17:902:7d09:: with SMTP id z9-v6mr1244892pll.4.1525955052092; Thu, 10 May 2018 05:24:12 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1525955052; cv=none; d=google.com; s=arc-20160816; b=H+G8guD6CW0CaxL9fhX/UTWkaCz7zstyrTnbk/7mDohdxkR7TjEaYlLzYwK7zxC926 MxhmhM9FNbNTiK3eJnXEF37105DBZqFETOANbKVXi4Gp9FLncc+r/n3Q0Y0f1xGwWDu5 2FnqvolvhkiQ88eP/mmA2MGWdalJ/lrCA3WFN/3hlNqzGA3P0W7coVsHPDQrAIUIRfOq ITZgNLue2fNME7ri1IuCDwVxFZgR/Cw0pNZ08dS1eF8lFW35utHQyTffWkMRzlbS76ba QUKmDt/7uu5LdcfNwj9eNTDcdPTG33P6ywrL8bAC0+I8aFIX1w593PzUyeVK9MatQ0qE 8g8A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:user-agent:in-reply-to :content-disposition:mime-version:references:message-id:subject:cc :to:from:date:dkim-signature:arc-authentication-results; bh=BXfu7QcnPSs46qNv/W81zpn5NaSwmExDeUwL4oE/D4A=; b=k1vwLk5nD5wYWvXVP8y/V7IHFG7Aavoa04V3/xIsd65THoGh3Tf01s8YJQ8Um3y3PQ 602IeslXgcUMi+FV9csa8yhiHKrUIs5EIiuRp+SmKaUWsFeg4cQWtDAD8HXvGZ/NKiP2 3PtWdYG5zjR+ys5Abj9qZyi9kE6sdxD995Qiq6lyx/+KX7JURYxJbhk6w9PWoxstmVAg 6wWQNV8z4fSojDETlHJFuUXHdsYzVes8XzZVdIqRT1v0345pjUVv45SteCXGsc1dMYjq c+YupDsjlnu+AtT2HXSvDraRjQUOfmjhBwcvhTo0I+7uLTLpYU/h0WYkGmXMtMFJzg1E BnUg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@amarulasolutions.com header.s=google header.b=KOc2u82J; 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 l4-v6si653085plt.258.2018.05.10.05.23.56; Thu, 10 May 2018 05:24:12 -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=pass header.i=@amarulasolutions.com header.s=google header.b=KOc2u82J; 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 S1757305AbeEJMXp (ORCPT + 99 others); Thu, 10 May 2018 08:23:45 -0400 Received: from mail-wm0-f43.google.com ([74.125.82.43]:35343 "EHLO mail-wm0-f43.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1756741AbeEJMXn (ORCPT ); Thu, 10 May 2018 08:23:43 -0400 Received: by mail-wm0-f43.google.com with SMTP id o78-v6so4074567wmg.0 for ; Thu, 10 May 2018 05:23:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amarulasolutions.com; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=BXfu7QcnPSs46qNv/W81zpn5NaSwmExDeUwL4oE/D4A=; b=KOc2u82J8sXFSauLFKqG7xQ5INvaj5YLQP5yWeJrFhtaaZLHn6dgplQ99IvQRzhpd+ 6Pgpo6rnxobWLyrm9O4ZUwL8aIzO+i2zrNj8uAmJCt8KeO3vex9/txw92R1BVOF5ShU9 JKylopIZfhmL/0JEljiUrwz6ZXnP0+b93Q2HI= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=BXfu7QcnPSs46qNv/W81zpn5NaSwmExDeUwL4oE/D4A=; b=kF60NKcq/BalFI4uq7K8chSNSHvYYpJN7CEH+1st0HOp2TkF1/BvAjSBEA9BZ4LSBm zXOSOmPm5yL2SByw4qiu4al9k4xZ+o8iWPH5Zio3kGCQvlG04SW4Kr5KB+7M/v8r/oPF rgOcaSjnPZgifrLZ9OMnEOsmZgVEjRwBgc8cM6mLVf/A9nFNlqkf7BkVJLFyWO0xEcKe cYi2dxs67W/M2OFAdfsaP0hLCHUQjc3uthWSvPTFvzHYClDtcvbxLxKjDGkMOlezNAU1 kyLb7sPOqp9364ZeZyFTnKAJjrGBeuvj+m0DP5NYVCYB3Jh25XC9tJI/X5Be2qbV8K81 S0JA== X-Gm-Message-State: ALKqPwfW9osXQSeXyTh72qqDhgoqOY2iu9k26v+0Se4XZMI0KrR6cZVa HvyNMeGqWiJHvCVowvAbKhWaBQ== X-Received: by 2002:a1c:c702:: with SMTP id x2-v6mr1197978wmf.57.1525955022522; Thu, 10 May 2018 05:23:42 -0700 (PDT) Received: from andrea (85.100.broadband17.iol.cz. [109.80.100.85]) by smtp.gmail.com with ESMTPSA id 76-v6sm32237272wmj.0.2018.05.10.05.23.41 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 10 May 2018 05:23:41 -0700 (PDT) Date: Thu, 10 May 2018 14:23:35 +0200 From: Andrea Parri To: Jonathan Corbet Cc: Peter Zijlstra , Mauro Carvalho Chehab , Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Ingo Molnar Subject: Re: [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings Message-ID: <20180510122335.GA7704@andrea> References: <6b9b3184cbfabab1ad89c974ddf1c61631e8f1bf.1525684985.git.mchehab+samsung@kernel.org> <20180509084120.GF12217@hirez.programming.kicks-ass.net> <20180509084518.247650e2@lwn.net> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20180509084518.247650e2@lwn.net> User-Agent: Mutt/1.5.24 (2015-08-30) Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Wed, May 09, 2018 at 08:45:18AM -0600, Jonathan Corbet wrote: > On Wed, 9 May 2018 10:41:20 +0200 > Peter Zijlstra wrote: > > > > This is easily done by using "::" instead of just ":". > > > > And I'll voice my objection once again. This makes a regular comment > > worse. This rst stuff is utter shit for making normal text files less > > readable in your favourite text editor. > > > > If this gets merged, I'll simply remove that spurious ':' the next time > > I'm near that comment. > > Seriously, Peter? > > It's a simple colon. It goes along with the /** marker for kerneldoc > comments and the @ markers found within them, both of which you seem to > have found a way to live with. > > The RST work was discussed for a year before we even started. It has > brought in the efforts of a large number of developers, all of whom see > the value in actually caring about our documentation and making it > accessible to a much larger group of readers. And it has all happened > while preserving the primacy of the plain-text documentation. > > You're not the only consumer of the docs. You may not appreciate the > improvements that have come, but others certainly do. I do hope that you > can find it in youself to avoid vandalizing things for everybody else ...? You wrote it: the fact that some people (including its developers) see a value in the RST work or the fact that such work made the kernel doc. accessible to a larger group of readers are not in question here; only remember that other people (including some developers running into the "disadventure" of opening an RST doc. from their preferred text editor and being brought to conclude: "WTH! I need to open a web browser, I guess...") _use_ such doc. and _do care_ about it, and that what might be an improvement for some people might look as "vandalizing" to others. We're talking about readability/accessibility here, but I think similar considerations apply to other aspects of the doc. such as availability/ completeness (yes, I did hear developers arguing "I won't write such a doc., because...") and consistency (w.r.t. the doc. itself and sources). Andrea > > Thanks, > > jon