From mboxrd@z Thu Jan 1 00:00:00 1970 From: Dave Martin Subject: Re: [PATCH 04/14] prctl.2: srcfix add comments for navigation Date: Wed, 13 May 2020 11:56:20 +0100 Message-ID: <20200513105620.GE21779@arm.com> References: <1589301419-24459-1-git-send-email-Dave.Martin@arm.com> <1589301419-24459-5-git-send-email-Dave.Martin@arm.com> <8b882b6e-376b-111d-3c3c-7a042b0e91b5@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Return-path: Received: from foss.arm.com ([217.140.110.172]:43306 "EHLO foss.arm.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727794AbgEMK4X (ORCPT ); Wed, 13 May 2020 06:56:23 -0400 Content-Disposition: inline In-Reply-To: <8b882b6e-376b-111d-3c3c-7a042b0e91b5@gmail.com> Sender: linux-arch-owner@vger.kernel.org List-ID: To: "Michael Kerrisk (man-pages)" Cc: linux-man@vger.kernel.org, linux-arch@vger.kernel.org, linux-arm-kernel@lists.infradead.org On Wed, May 13, 2020 at 12:09:27PM +0200, Michael Kerrisk (man-pages) wrote: > Hi Dave, > > On 5/12/20 6:36 PM, Dave Martin wrote: > > The prctl.2 source is unnecessarily hard to navigate, not least > > because prctl option flags are traditionally named PR_* and so look > > just like prctl names. > > > > For each actual prctl, add a comment of the form > > > > .\" prctl PR_FOO > > > > to make it move obvious where each top-level prctl starts. > > > > Of course, we could add some clever macros, but let's not confuse > > dumb parsers. > > A patch like this, which makes sweeping changes across the page, > should be best placed at the end of a series, I think. > The reason is that if I fail to apply this patch (and I am a > little dubious about it), then probably the rest of the patches > in the series won't apply. (Furthermore, it also forced me to > apply patch 02 already, which I wanted to reflect on a little.) Agreed, I'll try to do that in future. > That said, I'll apply it, so that the remaining patches > apply cleanly. I'll consider later whether to keep this > change. For example, I wonder if a visually distinctive > source line that is always the same would be better than > these comments that repeat the PR_* names. For example, > something like > > .\" ========================== > > I'll circle back to this later. I'd prefer to keep the name if we can, since navigating by search is otherwise bothersome due to false hits. Could we do both, say: .\" === PR_FOO === If you prefer to reject this patch, I'm happy to rebase and repost the series as appropriate. In any case, this one is nice to have rather than essential. Cheers ---Dave 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.4 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE, SPF_PASS,URIBL_BLOCKED,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 95B8BCA90AF for ; Wed, 13 May 2020 10:56:27 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 6668B20675 for ; Wed, 13 May 2020 10:56:27 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="eUtN+EsV" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 6668B20675 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=arm.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:References: Message-ID:Subject:To:From:Date:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=TfhkHPjxBOjKvJsTE/VM3Hl6lDACL2k/zIIWFfcarMI=; b=eUtN+EsV4a/EH+ q3KgQULu1IdcC0HzqRcMUGK2U68Hrgkb7dNV1KIUjlosNGDgboEGMMNEK2u0NRhDX8e0lohkdD4fE V+eOgud5QOmTkslE3AVCNWoSnFCLB7ewXMDAtOJ5rUlYaY03TIr8U2VDmFvoqniq9ObcncuqEwU6S bNDGbM2IjR10Vz1r6w1UZgbolCuLCwQ+mG6pU9xxsnZrsMkR9WwSm38LYgHpEby5L/BKDaGN3ivsm /eA5jSLAk7QRPA0hc62dlAWc2a+kHujbS5fhgtam7U5WOj4lqrcxqrJwfKK5WjLXG/qR/npo3+FMe o3gr+bMXs4ItVIdBXp2w==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jYp3q-0002gP-U4; Wed, 13 May 2020 10:56:26 +0000 Received: from foss.arm.com ([217.140.110.172]) by bombadil.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jYp3n-0002ff-Iw for linux-arm-kernel@lists.infradead.org; Wed, 13 May 2020 10:56:25 +0000 Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 1906030E; Wed, 13 May 2020 03:56:23 -0700 (PDT) Received: from arm.com (usa-sjc-imap-foss1.foss.arm.com [10.121.207.14]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 6418A3F71E; Wed, 13 May 2020 03:56:22 -0700 (PDT) Date: Wed, 13 May 2020 11:56:20 +0100 From: Dave Martin To: "Michael Kerrisk (man-pages)" Subject: Re: [PATCH 04/14] prctl.2: srcfix add comments for navigation Message-ID: <20200513105620.GE21779@arm.com> References: <1589301419-24459-1-git-send-email-Dave.Martin@arm.com> <1589301419-24459-5-git-send-email-Dave.Martin@arm.com> <8b882b6e-376b-111d-3c3c-7a042b0e91b5@gmail.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <8b882b6e-376b-111d-3c3c-7a042b0e91b5@gmail.com> User-Agent: Mutt/1.5.23 (2014-03-12) X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200513_035623_669615_047039A5 X-CRM114-Status: GOOD ( 21.04 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: linux-arch@vger.kernel.org, linux-man@vger.kernel.org, linux-arm-kernel@lists.infradead.org Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Wed, May 13, 2020 at 12:09:27PM +0200, Michael Kerrisk (man-pages) wrote: > Hi Dave, > > On 5/12/20 6:36 PM, Dave Martin wrote: > > The prctl.2 source is unnecessarily hard to navigate, not least > > because prctl option flags are traditionally named PR_* and so look > > just like prctl names. > > > > For each actual prctl, add a comment of the form > > > > .\" prctl PR_FOO > > > > to make it move obvious where each top-level prctl starts. > > > > Of course, we could add some clever macros, but let's not confuse > > dumb parsers. > > A patch like this, which makes sweeping changes across the page, > should be best placed at the end of a series, I think. > The reason is that if I fail to apply this patch (and I am a > little dubious about it), then probably the rest of the patches > in the series won't apply. (Furthermore, it also forced me to > apply patch 02 already, which I wanted to reflect on a little.) Agreed, I'll try to do that in future. > That said, I'll apply it, so that the remaining patches > apply cleanly. I'll consider later whether to keep this > change. For example, I wonder if a visually distinctive > source line that is always the same would be better than > these comments that repeat the PR_* names. For example, > something like > > .\" ========================== > > I'll circle back to this later. I'd prefer to keep the name if we can, since navigating by search is otherwise bothersome due to false hits. Could we do both, say: .\" === PR_FOO === If you prefer to reject this patch, I'm happy to rebase and repost the series as appropriate. In any case, this one is nice to have rather than essential. Cheers ---Dave _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel