From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 91110 invoked by alias); 30 Apr 2018 14:37:36 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 91090 invoked by uid 89); 30 Apr 2018 14:37:36 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-3.4 required=5.0 tests=AWL,BAYES_00,RCVD_IN_DNSWL_NONE,SPF_HELO_PASS autolearn=ham version=3.3.2 spammy=researching, Small, closest, caps X-HELO: gateway32.websitewelcome.com Received: from gateway32.websitewelcome.com (HELO gateway32.websitewelcome.com) (192.185.144.98) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Mon, 30 Apr 2018 14:37:34 +0000 Received: from cm14.websitewelcome.com (cm14.websitewelcome.com [100.42.49.7]) by gateway32.websitewelcome.com (Postfix) with ESMTP id 4B4587958C0 for ; Mon, 30 Apr 2018 09:37:33 -0500 (CDT) Received: from box5379.bluehost.com ([162.241.216.53]) by cmsmtp with SMTP id D9vpfhJYZ5CKDD9vpfEKzg; Mon, 30 Apr 2018 09:37:33 -0500 X-Authority-Reason: nr=8 Received: from 97-122-176-117.hlrn.qwest.net ([97.122.176.117]:38242 helo=bapiya.Home) by box5379.bluehost.com with esmtpsa (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.89_1) (envelope-from ) id 1fD9vp-003hNM-2O for gdb-patches@sourceware.org; Mon, 30 Apr 2018 09:37:33 -0500 From: Tom Tromey To: gdb-patches@sourceware.org Subject: [RFA 00/12] Small help text tweaks Date: Mon, 30 Apr 2018 14:37:00 -0000 Message-Id: <20180430143731.30007-1-tom@tromey.com> X-BWhitelist: no X-Source-L: No X-Exim-ID: 1fD9vp-003hNM-2O X-Source-Sender: 97-122-176-117.hlrn.qwest.net (bapiya.Home) [97.122.176.117]:38242 X-Source-Auth: tom+tromey.com X-Email-Count: 8 X-Source-Cap: ZWx5bnJvYmk7ZWx5bnJvYmk7Ym94NTM3OS5ibHVlaG9zdC5jb20= X-Local-Domain: yes X-SW-Source: 2018-04/txt/msg00633.txt.bz2 I've long understood the GNU style for "metasyntactic variables" -- text that is a placeholder for some value -- to be to write them in all caps. For example, from "gdb --help": --core=COREFILE Analyze the core dump COREFILE. However, while researching for this post, I couldn't actually find this in the GNU coding standards -- I thought it was there, but the closest I could find was in the Emacs Lisp manual. Nevertheless, I'm pressing forward with this series, which fixes a number of spots in gdb to use this style in the help text for commands. I found the commands to change using "apropos <" -- since the most common alternate style is to wrap a metasyntactic with <>. Regression tested by the buildbot. Tom