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.6 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,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 9812EC47256 for ; Tue, 5 May 2020 10:45:00 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 77349206B9 for ; Tue, 5 May 2020 10:45:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1588675500; bh=J8dSAo1NkSjvZvb30jTZhQbKGZ1WYsmYm2gswSFV5RY=; h=Date:From:To:Cc:Subject:References:In-Reply-To:List-ID:From; b=fud8i1gp1CnVrTlwioAKO5JxQxy7yOkZIXj2AAMXJ6zBxysvxjZd/SUUXgpZX3T5m Cj18g31E2aEQTvpiwqhtEJjLq/De8qgd1Oj4XecEx2eb7AI3iaxR2KiQbwAAmjND2f TzbvSKsaffSvttYGwVwRzU/ZU8S6SCz1MzbNTcjQ= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728497AbgEEKpA (ORCPT ); Tue, 5 May 2020 06:45:00 -0400 Received: from mail.kernel.org ([198.145.29.99]:56192 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728233AbgEEKpA (ORCPT ); Tue, 5 May 2020 06:45:00 -0400 Received: from willie-the-truck (236.31.169.217.in-addr.arpa [217.169.31.236]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 1E451206A5; Tue, 5 May 2020 10:44:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1588675499; bh=J8dSAo1NkSjvZvb30jTZhQbKGZ1WYsmYm2gswSFV5RY=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=Pc0Jpyt+vWwwHoLo73p8Vc6s1jyECtwd+SzEDzEOh1CgA7+Ynw6w5KLGRlJpIVh+K GhPCIzhCRMcSIrIkCk4OmS674kxNUmzoocg4/kDYIxZnAiflBNhZkT1kuPZ+F4y3R9 K9i4Rdw3VXSbPuD9xT12RHGONOAN/UuEijWzSnVk= Date: Tue, 5 May 2020 11:44:55 +0100 From: Will Deacon To: Dave Martin Cc: Michael Kerrisk , Catalin Marinas , Vincenzo Frascino , linux-man@vger.kernel.org, linux-arch@vger.kernel.org, linux-arm-kernel@lists.infradead.org Subject: Re: RFC: Adding arch-specific user ABI documentation in linux-man Message-ID: <20200505104454.GC19710@willie-the-truck> References: <20200504153214.GH30377@arm.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20200504153214.GH30377@arm.com> User-Agent: Mutt/1.10.1 (2018-07-13) Sender: linux-man-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-man@vger.kernel.org Hi Dave, On Mon, May 04, 2020 at 04:32:35PM +0100, Dave Martin wrote: > I considering trying to plug some gaps in the arch-specific ABI > documentation in the linux man-pages, specifically for arm64 (and > possibly arm, where compat means we have some overlap). > > For arm64, there are now significant new extensions (Pointer > authentication, SVE, MTE etc.) Currently there is some user-facing > documentation mixed in with the kernel-facing documentation in the > kernel tree, but this situation isn't ideal. > > Do you have an opinion on where in the man-pages documentation should be > added, and how to structure it? > > > Affected areas include: > > * exec interface > * aux vector, hwcaps > * arch-specific signals > * signal frame > * mmap/mprotect extensions > * prctl calls > * ptrace quirks and extensions > * coredump contents > > > Not everything has an obvious home in an existing page, and adding > specifics for every architecture could make some existing manpages very > unwieldy. > > I think for some arch features, we really need some "overview" pages > too: just documenting the low-level details is of limited value > without some guide as to how to use them together. > > > Does the following sketch look reasonable? > > * man7/arm64.7: new page: overview of arm64-specific ABI extensions > > * man7/sve.7 (or man7/arm64-sve.7 or man7/sve.7arm64): new page: > overview of arm64 SVE ABI > > * man2/arm64-ptrace.2 (or man2/ptrace.2arm64): new page: > arm64 ptrace extensions Michael has been nagging me on and off about that for, what, 10 years now? I would therefore be very much in favour of having our ptrace extensions documented! We could even put this stuff under Documentation/arm64/man/ if it's deemed too CPU-specific for the man-pages project, but my preference would still be for it to be hosted there alongside all the other man pages. Will 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.5 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,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 206C3C47259 for ; Tue, 5 May 2020 10:45:10 +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 EB4CF206A5 for ; Tue, 5 May 2020 10:45:09 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="fFeG8yy5"; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="Pc0Jpyt+" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org EB4CF206A5 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org 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=OvbuT/JbWhQzbEJj32hehM/MB5xiMKljGbPn/6vFNC0=; b=fFeG8yy5cL441n /DPKsziwAMRQdnJQSlWfgstSF8ExSeN2LeZmPjgXuRc8TqwEUoaJ+rTG9sW6d8eNFdPce/TlBkcgb pIxgDBycKwofi6zBngICyxGroyRuJxo8s2Yy8x8BMx0LKi7OgCHRMIFRMXZ/2b2pVOKm7mJSMykgX hyDrtf3/s9alPCDzPY83Hj4qV7X3QeGACWmbH6YOCMRoFn5ZK8r++aXSxOQfLzHGRQDASs7mvrpo7 e7gl/b/zPERhhVsll/xBJ81kO+6rgqJalYyGggA01pETSwNz4OFhaM6UGz1+neTJBFrOmmcl2f7ce NEbFI2muE3yPatPGUyLg==; 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 1jVv4U-0007ul-Rs; Tue, 05 May 2020 10:45:06 +0000 Received: from mail.kernel.org ([198.145.29.99]) by bombadil.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jVv4N-0007nK-Ts for linux-arm-kernel@lists.infradead.org; Tue, 05 May 2020 10:45:01 +0000 Received: from willie-the-truck (236.31.169.217.in-addr.arpa [217.169.31.236]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 1E451206A5; Tue, 5 May 2020 10:44:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1588675499; bh=J8dSAo1NkSjvZvb30jTZhQbKGZ1WYsmYm2gswSFV5RY=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=Pc0Jpyt+vWwwHoLo73p8Vc6s1jyECtwd+SzEDzEOh1CgA7+Ynw6w5KLGRlJpIVh+K GhPCIzhCRMcSIrIkCk4OmS674kxNUmzoocg4/kDYIxZnAiflBNhZkT1kuPZ+F4y3R9 K9i4Rdw3VXSbPuD9xT12RHGONOAN/UuEijWzSnVk= Date: Tue, 5 May 2020 11:44:55 +0100 From: Will Deacon To: Dave Martin Subject: Re: RFC: Adding arch-specific user ABI documentation in linux-man Message-ID: <20200505104454.GC19710@willie-the-truck> References: <20200504153214.GH30377@arm.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20200504153214.GH30377@arm.com> User-Agent: Mutt/1.10.1 (2018-07-13) X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200505_034459_996854_5006EED1 X-CRM114-Status: GOOD ( 15.62 ) 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, Catalin Marinas , Michael Kerrisk , Vincenzo Frascino , 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 Hi Dave, On Mon, May 04, 2020 at 04:32:35PM +0100, Dave Martin wrote: > I considering trying to plug some gaps in the arch-specific ABI > documentation in the linux man-pages, specifically for arm64 (and > possibly arm, where compat means we have some overlap). > > For arm64, there are now significant new extensions (Pointer > authentication, SVE, MTE etc.) Currently there is some user-facing > documentation mixed in with the kernel-facing documentation in the > kernel tree, but this situation isn't ideal. > > Do you have an opinion on where in the man-pages documentation should be > added, and how to structure it? > > > Affected areas include: > > * exec interface > * aux vector, hwcaps > * arch-specific signals > * signal frame > * mmap/mprotect extensions > * prctl calls > * ptrace quirks and extensions > * coredump contents > > > Not everything has an obvious home in an existing page, and adding > specifics for every architecture could make some existing manpages very > unwieldy. > > I think for some arch features, we really need some "overview" pages > too: just documenting the low-level details is of limited value > without some guide as to how to use them together. > > > Does the following sketch look reasonable? > > * man7/arm64.7: new page: overview of arm64-specific ABI extensions > > * man7/sve.7 (or man7/arm64-sve.7 or man7/sve.7arm64): new page: > overview of arm64 SVE ABI > > * man2/arm64-ptrace.2 (or man2/ptrace.2arm64): new page: > arm64 ptrace extensions Michael has been nagging me on and off about that for, what, 10 years now? I would therefore be very much in favour of having our ptrace extensions documented! We could even put this stuff under Documentation/arm64/man/ if it's deemed too CPU-specific for the man-pages project, but my preference would still be for it to be hosted there alongside all the other man pages. Will _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel