From: Dave Martin <Dave.Martin@arm.com> To: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com> Cc: linux-man@vger.kernel.org, linux-arch@vger.kernel.org, linux-arm-kernel@lists.infradead.org Subject: Re: [PATCH 04/14] prctl.2: srcfix add comments for navigation Date: Wed, 13 May 2020 11:56:20 +0100 [thread overview] Message-ID: <20200513105620.GE21779@arm.com> (raw) In-Reply-To: <8b882b6e-376b-111d-3c3c-7a042b0e91b5@gmail.com> 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
WARNING: multiple messages have this Message-ID (diff)
From: Dave Martin <Dave.Martin@arm.com> To: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com> Cc: linux-arch@vger.kernel.org, linux-man@vger.kernel.org, linux-arm-kernel@lists.infradead.org Subject: Re: [PATCH 04/14] prctl.2: srcfix add comments for navigation Date: Wed, 13 May 2020 11:56:20 +0100 [thread overview] Message-ID: <20200513105620.GE21779@arm.com> (raw) In-Reply-To: <8b882b6e-376b-111d-3c3c-7a042b0e91b5@gmail.com> 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
next prev parent reply other threads:[~2020-05-13 10:56 UTC|newest] Thread overview: 149+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-05-12 16:36 [PATCH 00/14] prctl.2 man page updates for Linux 5.6 Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-12 16:36 ` [PATCH 01/14] prctl.2: tfix clarify that prctl can apply to threads Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-13 8:30 ` Michael Kerrisk (man-pages) 2020-05-13 8:30 ` Michael Kerrisk (man-pages) 2020-05-13 8:30 ` Michael Kerrisk (man-pages) 2020-05-12 16:36 ` [PATCH 02/14] prctl.2: Add health warning Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-13 10:10 ` Michael Kerrisk (man-pages) 2020-05-13 10:10 ` Michael Kerrisk (man-pages) 2020-05-13 10:10 ` Michael Kerrisk (man-pages) 2020-05-13 11:13 ` Dave Martin 2020-05-13 11:13 ` Dave Martin 2020-05-13 11:40 ` Michael Kerrisk (man-pages) 2020-05-13 11:40 ` Michael Kerrisk (man-pages) 2020-05-13 11:40 ` Michael Kerrisk (man-pages) 2020-05-13 11:41 ` Dave Martin 2020-05-13 11:41 ` Dave Martin 2020-05-13 11:41 ` Dave Martin 2020-05-12 16:36 ` [PATCH 03/14] prctl.2: tfix mis-description of thread ID values in procfs Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-13 8:36 ` Michael Kerrisk (man-pages) 2020-05-13 8:36 ` Michael Kerrisk (man-pages) 2020-05-12 16:36 ` [PATCH 04/14] prctl.2: srcfix add comments for navigation Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-13 10:09 ` Michael Kerrisk (man-pages) 2020-05-13 10:09 ` Michael Kerrisk (man-pages) 2020-05-13 10:56 ` Dave Martin [this message] 2020-05-13 10:56 ` Dave Martin 2020-05-13 11:03 ` Michael Kerrisk (man-pages) 2020-05-13 11:03 ` Michael Kerrisk (man-pages) 2020-05-13 11:03 ` Michael Kerrisk (man-pages) 2020-05-13 11:15 ` Dave Martin 2020-05-13 11:15 ` Dave Martin 2020-05-13 11:48 ` Michael Kerrisk (man-pages) 2020-05-13 11:48 ` Michael Kerrisk (man-pages) 2020-05-13 11:48 ` Michael Kerrisk (man-pages) 2020-05-13 11:51 ` Dave Martin 2020-05-13 11:51 ` Dave Martin 2020-05-13 11:51 ` Dave Martin 2020-05-12 16:36 ` [PATCH 05/14] prctl.2: tfix listing order of prctls Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-13 10:10 ` Michael Kerrisk (man-pages) 2020-05-13 10:10 ` Michael Kerrisk (man-pages) 2020-05-13 11:21 ` Dave Martin 2020-05-13 11:21 ` Dave Martin 2020-05-13 11:21 ` Dave Martin 2020-05-13 11:31 ` Michael Kerrisk (man-pages) 2020-05-13 11:31 ` Michael Kerrisk (man-pages) 2020-05-13 11:31 ` Michael Kerrisk (man-pages) 2020-05-13 11:45 ` Dave Martin 2020-05-13 11:45 ` Dave Martin 2020-05-13 11:45 ` Dave Martin 2020-05-12 16:36 ` [PATCH 06/14] prctl.2: ffix quotation mark tweaks Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-13 10:11 ` Michael Kerrisk (man-pages) 2020-05-13 10:11 ` Michael Kerrisk (man-pages) 2020-05-13 10:11 ` Michael Kerrisk (man-pages) 2020-05-13 11:39 ` Dave Martin 2020-05-13 11:39 ` Dave Martin 2020-05-13 11:39 ` Dave Martin 2020-05-13 11:46 ` Michael Kerrisk (man-pages) 2020-05-13 11:46 ` Michael Kerrisk (man-pages) 2020-05-13 11:51 ` Dave Martin 2020-05-13 11:51 ` Dave Martin 2020-05-13 11:51 ` Dave Martin 2020-05-12 16:36 ` [PATCH 07/14] prctl.2: Document removal of Intel MPX prctls Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-12 16:41 ` Dave Hansen 2020-05-12 16:41 ` Dave Hansen 2020-05-13 10:11 ` Michael Kerrisk (man-pages) 2020-05-13 10:11 ` Michael Kerrisk (man-pages) 2020-05-13 10:11 ` Michael Kerrisk (man-pages) 2020-05-12 16:36 ` [PATCH 08/14] prctl.2: Work around bogus constant "maxsig" in PR_SET_PDEATHSIG Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-13 10:30 ` Michael Kerrisk (man-pages) 2020-05-13 10:30 ` Michael Kerrisk (man-pages) 2020-05-13 10:30 ` Michael Kerrisk (man-pages) 2020-05-12 16:36 ` [PATCH 09/14] prctl.2: tfix minor punctuation in SPECULATION_CTRL prctls Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-13 10:31 ` Michael Kerrisk (man-pages) 2020-05-13 10:31 ` Michael Kerrisk (man-pages) 2020-05-13 10:31 ` Michael Kerrisk (man-pages) 2020-05-12 16:36 ` [PATCH 10/14] prctl.2: Add PR_SPEC_INDIRECT_BRANCH for " Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-13 11:21 ` Michael Kerrisk (man-pages) 2020-05-13 11:21 ` Michael Kerrisk (man-pages) 2020-05-13 11:21 ` Michael Kerrisk (man-pages) 2020-05-13 11:49 ` Dave Martin 2020-05-13 11:49 ` Dave Martin 2020-05-13 12:06 ` Michael Kerrisk (man-pages) 2020-05-13 12:06 ` Michael Kerrisk (man-pages) 2020-05-13 12:06 ` Michael Kerrisk (man-pages) 2020-05-13 13:53 ` Dave Martin 2020-05-13 13:53 ` Dave Martin 2020-05-13 13:53 ` Dave Martin 2020-05-12 16:36 ` [PATCH 11/14] prctl.2: Add PR_SPEC_DISABLE_NOEXEC " Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-12 16:36 ` [PATCH 12/14] prctl.2: Clarify the unsupported hardware case of EINVAL Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-13 10:48 ` Michael Kerrisk (man-pages) 2020-05-13 10:48 ` Michael Kerrisk (man-pages) 2020-05-12 16:36 ` [PATCH 13/14] prctl.2: Add SVE prctls (arm64) Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-13 8:43 ` Will Deacon 2020-05-13 8:43 ` Will Deacon 2020-05-13 8:43 ` Will Deacon 2020-05-13 10:46 ` Dave Martin 2020-05-13 10:46 ` Dave Martin 2020-05-13 10:46 ` Dave Martin 2020-05-13 11:01 ` Michael Kerrisk (man-pages) 2020-05-13 11:01 ` Michael Kerrisk (man-pages) 2020-05-13 14:02 ` Dave Martin 2020-05-13 14:02 ` Dave Martin 2020-05-13 14:02 ` Dave Martin 2020-05-13 21:11 ` Will Deacon 2020-05-13 21:11 ` Will Deacon 2020-05-13 21:11 ` Will Deacon 2020-05-18 16:37 ` Dave Martin 2020-05-18 16:37 ` Dave Martin 2020-05-26 14:45 ` Dave Martin 2020-05-26 14:45 ` Dave Martin 2020-05-12 16:36 ` [PATCH 14/14] prctl.2: Add PR_PAC_RESET_KEYS (arm64) Dave Martin 2020-05-12 16:36 ` Dave Martin 2020-05-13 7:25 ` Will Deacon 2020-05-13 7:25 ` Will Deacon 2020-05-13 14:36 ` Dave Martin 2020-05-13 14:36 ` Dave Martin 2020-05-13 14:36 ` Dave Martin 2020-05-13 21:00 ` Will Deacon 2020-05-13 21:00 ` Will Deacon 2020-05-13 21:00 ` Will Deacon 2020-05-18 16:11 ` Dave Martin 2020-05-18 16:11 ` Dave Martin 2020-05-18 16:11 ` Dave Martin 2020-05-18 16:29 ` Will Deacon 2020-05-18 16:29 ` Will Deacon 2020-05-18 16:29 ` Will Deacon 2020-05-13 11:28 ` [PATCH 00/14] prctl.2 man page updates for Linux 5.6 Michael Kerrisk (man-pages) 2020-05-13 11:28 ` Michael Kerrisk (man-pages)
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20200513105620.GE21779@arm.com \ --to=dave.martin@arm.com \ --cc=linux-arch@vger.kernel.org \ --cc=linux-arm-kernel@lists.infradead.org \ --cc=linux-man@vger.kernel.org \ --cc=mtk.manpages@gmail.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.