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=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 151FCC4740A for ; Mon, 9 Sep 2019 18:27:55 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id E46F121A4A for ; Mon, 9 Sep 2019 18:27:54 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1731442AbfIIS1y (ORCPT ); Mon, 9 Sep 2019 14:27:54 -0400 Received: from tartarus.angband.pl ([54.37.238.230]:41192 "EHLO tartarus.angband.pl" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1730720AbfIIS1y (ORCPT ); Mon, 9 Sep 2019 14:27:54 -0400 Received: from kilobyte by tartarus.angband.pl with local (Exim 4.92) (envelope-from ) id 1i7OOB-0003Ia-1Z; Mon, 09 Sep 2019 20:27:47 +0200 Date: Mon, 9 Sep 2019 20:27:47 +0200 From: Adam Borowski To: walter harms Cc: mtk.manpages@gmail.com, Florin Blanaru , linux-man Subject: Re: Quick fix for syscall man page Message-ID: <20190909182747.GA12602@angband.pl> References: <5D761692.9090905@bfs.de> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <5D761692.9090905@bfs.de> X-Junkbait: aaron@angband.pl, zzyx@angband.pl User-Agent: Mutt/1.10.1 (2018-07-13) X-SA-Exim-Connect-IP: X-SA-Exim-Mail-From: kilobyte@angband.pl X-SA-Exim-Scanned: No (on tartarus.angband.pl); SAEximRunCond expanded to false Sender: linux-man-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-man@vger.kernel.org On Mon, Sep 09, 2019 at 11:08:34AM +0200, walter harms wrote: > Am 09.09.2019 10:52, schrieb Michael Kerrisk (man-pages): > > [Adding Adam Borowski in CC, since he wrote the riscv text back at the > > start of 2018, andand he may have a comment.] I don't know RISCV; I needed to learn how to issue syscalls to port something -- so I've searched for relevant documentation, tested that it indeed works, then submitted that line to make the man page complete. > > On Thu, 5 Sep 2019 at 18:35, Florin Blanaru wrote: > >> http://man7.org/linux/man-pages/man2/syscall.2.html > >> > >> In the first table, for the riscv Arch/ABI, the instruction should be > >> ecall instead of scall. > >> > >> According the official manual, the instruction has been renamed. > >> https://content.riscv.org/wp-content/uploads/2017/05/riscv-spec-v2.2.pdf What matters for us, and the vast majority of programmers, is that the rename predates merging into official releases of binutils. Thus, there is no reason to ever use the old name in actual code. > Maybe it would be helpful to add a "footnote" that this is a rename only. > Otherwise people may get confused. I wonder, perhaps just a commit message would be enough? The alias is historic only; new documentation is supposed to use the new name. Man pages contain a lot of data that has been obsolete for decades -- it might be good to avoid stuff that became obsolete before the official release. But it's up to you -- you know better what's your policy about historical information. > > --- a/man2/syscall.2 > > +++ b/man2/syscall.2 > > @@ -196,7 +196,7 @@ mips syscall v0 v0 v1 a3 1, 6 > > -riscv scall a7 a0 a1 - > > +riscv ecall a7 a0 a1 - Meow! -- ⢀⣴⠾⠻⢶⣦⠀ We domesticated dogs 36000 years ago; together we chased ⣾⠁⢰⠒⠀⣿⡁ animals, hung out and licked or scratched our private parts. ⢿⡄⠘⠷⠚⠋⠀ Cats domesticated us 9500 years ago, and immediately we got ⠈⠳⣄⠀⠀⠀⠀ agriculture, towns then cities. -- whitroth on /.