From patchwork Wed Mar 30 21:09:52 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Thomas Schwinge X-Patchwork-Id: 1611384 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=gcc.gnu.org (client-ip=8.43.85.97; helo=sourceware.org; envelope-from=gcc-patches-bounces+incoming=patchwork.ozlabs.org@gcc.gnu.org; receiver=) Received: from sourceware.org (server2.sourceware.org [8.43.85.97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by bilbo.ozlabs.org (Postfix) with ESMTPS id 4KTJx56ZYdz9sFq for ; Thu, 31 Mar 2022 08:10:16 +1100 (AEDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id D31BE3838006 for ; Wed, 30 Mar 2022 21:10:13 +0000 (GMT) X-Original-To: gcc-patches@gcc.gnu.org Delivered-To: gcc-patches@gcc.gnu.org Received: from esa3.mentor.iphmx.com (esa3.mentor.iphmx.com [68.232.137.180]) by sourceware.org (Postfix) with ESMTPS id 1DA223839801 for ; Wed, 30 Mar 2022 21:10:02 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 1DA223839801 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=codesourcery.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=mentor.com X-IronPort-AV: E=Sophos;i="5.90,223,1643702400"; d="scan'208,223";a="73648759" Received: from orw-gwy-02-in.mentorg.com ([192.94.38.167]) by esa3.mentor.iphmx.com with ESMTP; 30 Mar 2022 13:10:01 -0800 IronPort-SDR: q/4unyNNDX56JLZsovrZiWf1ZjJUqYXBklkRRmrUn30pmcQcB+mJuYhGk7aEhs/shrVq3NsHik SXNBDmRMLmQANceG7PjXT7RwV8oCC43jucVJaHFtTrFEW2W+FehMpJ2mmB44bC0tzsnEbLcz06 GKZuQcH7vxmDfv5LD7T6euSQ7Ys/mKVSUmrDbJJdyJH2/ThgwuHhW+Xik9YDS7euWiYeGmlPbh QMOCF3FCa91/SHTxJd8OtqXbpUtZmstKug2VxWKzE5990KnL1nJiXc1WOHI14i+CkyXGbRsS4n Kos= From: Thomas Schwinge To: , "Joseph S. Myers" Subject: options: Clarifications around option definition records' help texts (was: make conflicting help text an error) In-Reply-To: References: User-Agent: Notmuch/0.29.3+94~g74c3f1b (https://notmuchmail.org) Emacs/27.1 (x86_64-pc-linux-gnu) Date: Wed, 30 Mar 2022 23:09:52 +0200 Message-ID: <87y20rywnz.fsf@euler.schwinge.homeip.net> MIME-Version: 1.0 X-Originating-IP: [137.202.0.90] X-ClientProxiedBy: svr-ies-mbx-06.mgc.mentorg.com (139.181.222.6) To svr-ies-mbx-01.mgc.mentorg.com (139.181.222.1) X-Spam-Status: No, score=-12.0 required=5.0 tests=BAYES_00, GIT_PATCH_0, HEADER_FROM_DIFFERENT_DOMAINS, KAM_DMARC_STATUS, SPF_HELO_PASS, SPF_PASS, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on server2.sourceware.org X-BeenThere: gcc-patches@gcc.gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gcc-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Manuel =?utf-8?b?TMOzcGV6LUliw6HDsWV6?= Errors-To: gcc-patches-bounces+incoming=patchwork.ozlabs.org@gcc.gnu.org Sender: "Gcc-patches" Hi! On 2012-05-13T11:03:36+0000, "Joseph S. Myers" wrote: > On Sun, 13 May 2012, Manuel Lpez-Ibez wrote: >> [an option is duplicated somewhere else] >> >> Only 2 options in Ada trigger this warning, and their help text has no >> effect, since it gest overridden by the ones in c.opt. Fixing this >> properly would require language-specific namespace, so two options >> with the same name in different languages can have completely >> different help text (and Init() and other flags). Not something I am >> planning to work on in the future. ;-) > I don't think we want to support different help strings for > different languages; if an option is supported for multiple languages, we > should have a generic description of that option that is correct for all > of them. To not just bury that in the email archives: OK to push the attached "options: Clarifications around option definition records' help texts"? Grüße Thomas ----------------- Siemens Electronic Design Automation GmbH; Anschrift: Arnulfstraße 201, 80634 München; Gesellschaft mit beschränkter Haftung; Geschäftsführer: Thomas Heurung, Frank Thürauf; Sitz der Gesellschaft: München; Registergericht München, HRB 106955 From d9cc0118898a7abdd1b7de515f0cc02b752aebec Mon Sep 17 00:00:00 2001 From: Thomas Schwinge Date: Wed, 30 Mar 2022 23:00:28 +0200 Subject: [PATCH] options: Clarifications around option definition records' help texts gcc/ * doc/options.texi (Option file format): Clarifications around option definition records' help texts. --- gcc/doc/options.texi | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/gcc/doc/options.texi b/gcc/doc/options.texi index d552b64d1f4..94dceaafbc5 100644 --- a/gcc/doc/options.texi +++ b/gcc/doc/options.texi @@ -160,6 +160,17 @@ used instead of the option's name and the text to the right of the tab forms the help text. This allows you to elaborate on what type of argument the option takes. +There is no support for different help texts for different languages. +If an option is supported for multiple languages, use a generic +description that is correct for all of them. + +If an option has multiple option definition records (in different +front ends' @file{*.opt} files, and/or @file{gcc/common.opt}, for +example), convention is to not duplicate the help text for each of +them, but instead put a comment like @code{; documented in common.opt} +in place of the help text for all but one of the multiple option +definition records. + @item A target mask record. These records have one field of the form @samp{Mask(@var{x})}. The options-processing script will automatically -- 2.25.1