From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM11-CO1-obe.outbound.protection.outlook.com (mail-co1nam11on2086.outbound.protection.outlook.com [40.107.220.86]) by sourceware.org (Postfix) with ESMTPS id 3A61E38582B4 for ; Mon, 11 Dec 2023 01:48:30 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 3A61E38582B4 Authentication-Results: sourceware.org; dmarc=pass (p=reject dis=none) header.from=siemens.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=siemens.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 3A61E38582B4 Authentication-Results: server2.sourceware.org; arc=pass smtp.remote-ip=40.107.220.86 ARC-Seal: i=2; a=rsa-sha256; d=sourceware.org; s=key; t=1702259311; cv=pass; b=EHgPBJhGo0GXdiuffno9jlEJmLQeEveCWnSRwnulQnsuy+WHPZ9GI1ircTF8ETltoYub9tobWqhKCxn87xeOrsnaGSERZcZ+pro4fmh7rlLo6Lp79Six/2BbbsgsGYU7PNoTx/5+ObYDjT3qM32abuLudBnK4TX7QsNiDd2xvNE= ARC-Message-Signature: i=2; a=rsa-sha256; d=sourceware.org; s=key; t=1702259311; c=relaxed/simple; bh=rW9c2mQ5SjkZACmdnCniDesSw5pQGOO6puAapoZQMB4=; h=DKIM-Signature:Message-ID:Date:Subject:To:From:MIME-Version; b=F8mvn3ChdvUC+3VsRvmkzH2fQsCsMZzZf1CRg67ztEtUCqXvNX8OYwcM1lpD6NWLo0XSgcdH3ucANKA94BAOr/dE/mWE2Rp3R1nE3gUj+Eaqsi9cL9fL3//HnNCgYk8zc9Qp3Qp/ojrDVzWJeJwG5o8SlAshOxilTJ0CZgF2MVQ= ARC-Authentication-Results: i=2; server2.sourceware.org ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=NT8dpHVUYR1/4r+5x3ney0h0xsTBuTqld7PUKz0AFE1PPy/lKXXOi/q7j5nItAEHrg7U9rEUWG1qHnFh57bGk2sIBkFMjqpQUX2AG+BglmhBLNtdC9SPOaJhzcHIKsh5E7h7womQhAH5tukwx81c7RI0XCPIpae5x+pe6hRw9ps9B4zrqg2RNkIdylpZwDt8Astl8T7kNx5sclIeU5Nno1196K+t2NCMlZeMmf2AfSJ0YaRRJPG4gxgJEfQTIBqkkK2UgW3Mq/soiRzRz649OKSO9RLTzX565uPL4tiGFrSDObOlvtlmtmNN9jqC5KLVCLtzf+xUQtNEsKIzAnaisw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=Jk5xjGBkIEOawRPrhfYKhGqOn9QkqUJ0JDhG9C7thd4=; b=JA+JqZr580+wlR5kX7hrvIVClk18w/lQ+1cfWJVtJuKlZW0kpl/XuntOx7rNp7hrgF76I9DU2LyFsEfsd4HL8JcgEx8akr+zeLvcW4JyP/uJa6HIhS9auEYMjiAO1L2tcaTHlgHjgdPoG7tE4F7w7k/lL3K+5+lm7EMzU+HV1wqqLuaprB4+pO3vHWSmEuEGVVQAUDXQhboUUlgUdI3k6Tp3+g6TXDhbSzMCawYFTVnWQnhZgubTW8uz8APe6pPZg+9mXULgPQCTjAdsX8euhOGqJy9uxUZlim9XfzG4HMY7sEzq/cvUx/gyoeeJUWNUEjHCzcENNfTBAAgDDtngBw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=siemens.com; dmarc=pass action=none header.from=siemens.com; dkim=pass header.d=siemens.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=siemens.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=Jk5xjGBkIEOawRPrhfYKhGqOn9QkqUJ0JDhG9C7thd4=; b=Jbnb8+PdNcVV5Y/tH/SjWoYDIZTnWwR3MwwP8Ux+/djZnV1fRHSvPuQMX5agq3iMFktL/QmC+3t7Y4e9Ou5TY3lwSvE1GGTJBmglywVhNe3g6TaxwHrnZF0Gyn2DsxxeKZHDBt/bDWMsHzaOnntjnuEFxnoPnKwkD05QbAHSQkt6U1WM5verRlZvcflIE+KexNDcj4nBRZlsa2XOqc86UKFLG80RPOIzg9BjsFH7f1PBLJOFiN9nqD0e9bPSvK7zoNVUKOGiwUGwEd9N12N+kLgpBxyNHlnuk1aJSqwMIHXOp7bFz4as9HEq95cQbFNDxmijqgm5q0d8+W/wSVESKA== Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=siemens.com; Received: from CH2PR07MB7222.namprd07.prod.outlook.com (2603:10b6:610:ab::21) by BY5PR07MB7032.namprd07.prod.outlook.com (2603:10b6:a03:1e6::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7068.32; Mon, 11 Dec 2023 01:48:27 +0000 Received: from CH2PR07MB7222.namprd07.prod.outlook.com ([fe80::69bd:212e:8997:d6f9]) by CH2PR07MB7222.namprd07.prod.outlook.com ([fe80::69bd:212e:8997:d6f9%5]) with mapi id 15.20.7068.031; Mon, 11 Dec 2023 01:48:26 +0000 Message-ID: Date: Sun, 10 Dec 2023 18:48:21 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.8.0 Subject: Re: [PATCH] extend.texi: Mark builtin arguments with @var{...} Content-Language: en-US To: Jakub Jelinek Cc: Gerald Pfeifer , Joseph Myers , gcc-patches@gcc.gnu.org References: From: Sandra Loosemore In-Reply-To: Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-ClientProxiedBy: SJ0PR05CA0010.namprd05.prod.outlook.com (2603:10b6:a03:33b::15) To CH2PR07MB7222.namprd07.prod.outlook.com (2603:10b6:610:ab::21) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH2PR07MB7222:EE_|BY5PR07MB7032:EE_ X-MS-Office365-Filtering-Correlation-Id: f811e324-30b3-4d45-77ed-08dbf9eb4377 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: yvzX8NUR/4Bqe+EfsxcKjSk29QOTjg0NV1ppcovPFLA/6iumWREhgGNfiZP2RU2UbcAisLJehmxVLDjuHJaAxF7145qxublRt0/ZA1GIr5h3s1dsc4egjaZvBF5xjtNNBw2iflgpV77VwnS6B49m+0Kh/7GZGL3EVNYYpSWP9Zlk7nlbGMz0eSPc0D6PkQ1ec23dwl2e21Ug8nYACDixo3bRabPpvHrgSR8rn26uTYddvTyHc5lKjLUXiBAGgHRDYic9r8Z4i2tL1P7wexijreisx+As+RkXOZUloOK+grEMa+pfFd42AIy4e96WFiS6evZX59zlNBcH24og+EKjPqxys8LYqW5OWu2knT8msAxtF9YlkTiC7ZToCD7Kql+ZMNmgNmYDjS0NIDv+ETmsGfTZJIWkY9GGtVEftdLhwz5Yo+ZSNOrXwvWqKOyoLx4my6+Wo1+oL2c3u6t721Z1JQHGNAbFwFXO10/TSnAcX7g4HgnSPdukzsEXLLYUsd1LEEqCeS8O3Q1/tFGv1AGEDs7zyCd5hyytvEr4yxTfkHh4YMs8B07t1j+VoFsfQhmSd26Fi8srzCOEg+31HNPxFSRiEKEYQVI1UCU/hj2lvpt1XQ4V8pJLUfD9t7lhZObE7Xn573+tNfWUPan3ZaAsgw== X-Forefront-Antispam-Report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:CH2PR07MB7222.namprd07.prod.outlook.com;PTR:;CAT:NONE;SFS:(13230031)(376002)(136003)(39850400004)(346002)(396003)(366004)(230922051799003)(451199024)(64100799003)(1800799012)(186009)(2616005)(6506007)(6666004)(6512007)(53546011)(83380400001)(5660300002)(44832011)(41300700001)(2906002)(4326008)(478600001)(6486002)(8676002)(8936002)(66946007)(66556008)(316002)(66476007)(54906003)(6916009)(82960400001)(86362001)(31696002)(38100700002)(36756003)(31686004)(43740500002)(45980500001);DIR:OUT;SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?T0RiVHZPYWVTVGRiVnlGSDFSL3JTQjY3enk1WFRibHVvRTFJSGdiQTgzckJS?= =?utf-8?B?MEQ2UXQ0QW50dm1CUGF2eXJ1TXdNaEJJcUh4cW1wOGlnbHdoL1U5Zk1nOXZr?= =?utf-8?B?WFYvL3hua3BSOEtPNUU2Q2RGZnliRkJLUWl5MU1iRG1WM3AybFd0Q2lCaUVY?= =?utf-8?B?T3VoWXMwUFFSS2RtaklFVUtvRTY3UlJwN2EwamtmT0RQbFpwWUhXVW9OMkhR?= =?utf-8?B?bERkWkJ1cTcxTk9nVXhIditlM2pJY1ZMQjMyYVNrdkUxNlJ1aFQ3SStPNjRw?= =?utf-8?B?MlBGaEZiTHU0U0ZoY1kxVmhIUnVKU1BaclhaSTJSelAyMlh5MlJYZWc4a25R?= =?utf-8?B?eWpHejIrRzk5T3VGek9OS1hpUUx5cUpTY0RRYmJZUDkzaExmaUxiOVFOWm5K?= =?utf-8?B?WjR1eDFCU1U3WEgyWXg5ZjkrUU9EUVMrMXpNdy9nTEx3SDNMTlBEMDBNS1VC?= =?utf-8?B?VDk1eG9ibFdzTHEyVW9Cc3pUT2oxd2JtTDdmMXZmK3FaSGNFc2MyR21laGUz?= =?utf-8?B?K3Q3MU9YTW8zZ1F1QU9BRHYySHdiaDBDbFdrWHRQbXhvZkp0QjIzMk96NUFR?= =?utf-8?B?TmZabXFwNmdSMTZJWW1KWjgxakxtUnhmZDc4aWdYVFZ6M2hSUWNFSkJnTUhi?= =?utf-8?B?VUFROU9DcEhPRURxaDBKdGYvZ3owdXFUcmlXT0pSTTNUeldlaFF1SWg0VERV?= =?utf-8?B?R1kzWG5PNUN5bDBDVHM5MXE4eGZYUktNNVU4RXVKSGlXbisyc0l4SEJtU2xh?= =?utf-8?B?eDUySWtGUjBGMmRGRmczR3JHNWlPUmdnWHBXeDY1TGtNSHNidXpzS0w0R1Fq?= =?utf-8?B?VjkvckJQQ05NcUNRSzNuOHRrUHJHcDIrd08wTlY4RlA1U1pXWlRBTmlFb0ZD?= =?utf-8?B?NXVaR25GVEpXemhHTkU1UnBKaCtNeXMyNFJsQU5ycXdvdGpRWVVRc1dLQmRJ?= =?utf-8?B?MWc1ZTlHM0hEejRtaDlUc0ZlQ0J1UlIvMkFVVms3ZkovQlZYWmEwZGxKUzd5?= =?utf-8?B?TmFFZnkwa1JUNWZCSVc1dmNlVnZRWjVGNWpKc2xRNXJOL2Vudm93aVFjVVp4?= =?utf-8?B?YWtZWmVNU3l2dlg0eWowaW9wcWkzMWxkamV4blJtTWR6UjlaZTRuUzlYZjds?= =?utf-8?B?MXhJZGlGR043Z0pJVWpnb3c2L25tZldaRUhVaFdqaE1jYlB2NU50MTE5UmtP?= =?utf-8?B?cSt6UEVlbTdQc3Y0M2MwMjlTclpuZ1dFR3djbmg0R3VuMENkQ0ZONW80emFy?= =?utf-8?B?bXpnRFRiVXBlbm95ZmlVNjNHRWJwR1NuVjViRUtPK2hIci9pRmxGMk9LY2NO?= =?utf-8?B?YzUxTWRZbzI4MGlMM1pueDBSWnl2bXNjeWUvbnN1VWpPMC9qVHM0QWdTU1NH?= =?utf-8?B?L1ZsUk5pZzN6ZVcwNE1RK2c4cmdmdVRScG1DU1NtRzY0U040WGU3UyszSkxT?= =?utf-8?B?cVdVSGNUTDM1S0I4ZlZWK0xYRlozYUdKMG5nTmQ0dHpML0RYbWVxVm1mUFU2?= =?utf-8?B?TDlUck1QOHl2c3ZmZWp2YXpXV2R4ZnNrVWVqS1hFN0FyNzlsWHB0QTZFRDg1?= =?utf-8?B?bDgwaTg5Y1ZES3plcUowa3BwOHdvM3VDbWpHUjFRazhPbHB6Vm1oZ2FOaVkr?= =?utf-8?B?SWF3U1ZjT2hCdFlEZGx6NWE2bnVhNTRiSTJvK0xsdnV3azdMUVVZa21DZDlW?= =?utf-8?B?blVWRGJrU0pJRFNrT3AyaFhXMFVieEtzRllQc3pXdVF4RUlLTzRXaE4ycDdy?= =?utf-8?B?ZHFhVWhMTElObzJjUWpPdlAvYU93VUZ0Q2laYmVuejFQRHBjamRMdEpPSkZo?= =?utf-8?B?ZjZPT0JtbFFQaTBaRXJybzBJaFpsWjRwTzloQ1IrMnNaTStmdDVpK1FNbFlI?= =?utf-8?B?NWtML3dQWlJ1cGwzcmlQTFJ6eTdHMzc3YVhya3ZjNndWM1Z5dWVhalhIcU16?= =?utf-8?B?cnJ6dmdqSU1icnZhNWlJNGgydHA1ZzJPampmQnlwZXNWaGhQeVRick1PVXht?= =?utf-8?B?L21BV24xemlvV29qZVF6WFQrUSs1aTlwTW82UHhQd2hkNWsxVVhKNXBKam9K?= =?utf-8?B?MXdkaGFwZXVuT0xhdFZLQy9iTlZyTW9Dd3ozV1MwNkQ4TkgwakVRUTlmUkha?= =?utf-8?B?dXVWV2Jvd2dXVlM3NjdsL2NLb1RNemZud3VLejNnbVEwbk5PSEYrQmhhRnlr?= =?utf-8?B?QS9Ob01sZDBmUTJ1U0pDT05vZnpBWnRRcVBRc1hWSjB1VjdyQzh4U20xcUUz?= =?utf-8?B?ZEVSdEZ6Y2d5R3lnQVhDMXVtTnF3PT0=?= X-OriginatorOrg: siemens.com X-MS-Exchange-CrossTenant-Network-Message-Id: f811e324-30b3-4d45-77ed-08dbf9eb4377 X-MS-Exchange-CrossTenant-AuthSource: CH2PR07MB7222.namprd07.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 Dec 2023 01:48:25.5104 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 38ae3bcd-9579-4fd4-adda-b42e1495d55a X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: YD+aN3SMwFQGuduTA86cTDWf11Kunl3Qk0J4tnp9qebzmFk0KxIb6Jr5z9528nCqqYNbb7xIOVqfIqL/wm9lw3QVcQGm78roDLoIpYyIZi0= X-MS-Exchange-Transport-CrossTenantHeadersStamped: BY5PR07MB7032 X-Spam-Status: No, score=-3.8 required=5.0 tests=BAYES_00,DKIMWL_WL_MED,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FORGED_SPF_HELO,NICE_REPLY_A,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_NONE,TXREP,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: On 12/4/23 00:36, Jakub Jelinek wrote: > On Fri, Dec 01, 2023 at 10:43:57AM -0700, Sandra Loosemore wrote: >> On 12/1/23 10:33, Jakub Jelinek wrote: >>> Shall we tweak that somehow? If the argument names are unimportant, perhaps >>> it is fine to leave that out, but shouldn't we always use @var{...} around >>> the parameter names when specified? >> >> Yup. The Texinfo manual says: "When using @deftypefn command and >> variations, you should mark parameter names with @var to distinguish these >> from data type names, keywords, and other parts of the literal syntax of the >> programming language." > > Here is a patch which does that (but not adding types to where they were > missing, that will be harder to search for). > > Bootstrapped/regtested on x86_64-linux and i686-linux, ok for trunk? This is mostly OK, but I noticed some things you missed: > @@ -12946,13 +12946,13 @@ and @code{__ATOMIC_CONSUME}. > > @enddefbuiltin > > -@defbuiltin{void __atomic_load (@var{type} *ptr, @var{type} *ret, int memorder)} > +@defbuiltin{void __atomic_load (@var{type} *@var{ptr}, @var{type} *ret, int @var{memorder})} @var markup on "ret" here. > -@defbuiltin{void __atomic_store_n (@var{type} *ptr, @var{type} val, int memorder)} > +@defbuiltin{void __atomic_store_n (@var{type} *@var{ptr}, @var{type} val, int @var{memorder})} And on "val" here... > -@defbuiltin{void __atomic_store (@var{type} *ptr, @var{type} *val, int memorder)} > +@defbuiltin{void __atomic_store (@var{type} *@var{ptr}, @var{type} *val, int @var{memorder})} ...and here... > -@defbuiltin{@var{type} __atomic_exchange_n (@var{type} *ptr, @var{type} val, int memorder)} > +@defbuiltin{@var{type} __atomic_exchange_n (@var{type} *@var{ptr}, @var{type} val, int @var{memorder})} ...and here. > -@defbuiltin{void __atomic_exchange (@var{type} *ptr, @var{type} *val, @var{type} *ret, int memorder)} > +@defbuiltin{void __atomic_exchange (@var{type} *@var{ptr}, @var{type} *val, @var{type} *ret, int @var{memorder})} And both "val" and "ret" here. OK with those things fixed. -Sandra