From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id yCYjIR8P8GLpZiIAWB0awg (envelope-from ) for ; Sun, 07 Aug 2022 15:14:39 -0400 Received: by simark.ca (Postfix, from userid 112) id 7C8911EA05; Sun, 7 Aug 2022 15:14:39 -0400 (EDT) Authentication-Results: simark.ca; dkim=pass (1024-bit key; secure) header.d=sourceware.org header.i=@sourceware.org header.a=rsa-sha256 header.s=default header.b=XzmzkPe0; dkim-atps=neutral X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on simark.ca X-Spam-Level: X-Spam-Status: No, score=-3.0 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 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 (2048 bits) server-digest SHA256) (No client certificate requested) by simark.ca (Postfix) with ESMTPS id DBE341E797 for ; Sun, 7 Aug 2022 15:14:38 -0400 (EDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id E1590385800F for ; Sun, 7 Aug 2022 19:14:37 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org E1590385800F DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1659899677; bh=iLsCZfs41QWcg49qUfTa6CBYzRnN6DQNwuI2zohcU5E=; h=Subject:To:Date:In-Reply-To:References:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To: From; b=XzmzkPe0JOIPbxg3gnvS6dobRL6o9vuGHOexBj4UxAon74fC7tTYGHzoVmmmaNYF3 F7FrrEoPGDPQuRXQ2HATmuy70u98Yn2++h80iWHkvijJacxbXyCwSaDEVBAk96K6qu rjN2MaZArEHWaZIHRuJ7M9Vjsh2+ZK7pLrgCZUGI= Received: from mailsec217.isp.belgacom.be (mailsec217.isp.belgacom.be [195.238.22.113]) by sourceware.org (Postfix) with ESMTPS id CCD103858C50 for ; Sun, 7 Aug 2022 19:14:16 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org CCD103858C50 X-ExtLoop: 1 X-IPAS-Result: =?us-ascii?q?A2BjAQDEDvBi/1uGgG0NTR4BAQsSDEAJhkSETpELA5E1j?= =?us-ascii?q?UELAQEBAQEBAQEBCUIEAQGFAgMCAoR5JjgTAQIEAQEBAQMCAwEBAQEBAQMBA?= =?us-ascii?q?QYBAQEBAQEGBAGBG4UvgnspAYNjAQEBAQIBI2YLDQsCAiYCAlcGARKFe6kKe?= =?us-ascii?q?oExGmeEcIMsgWWBESyBZoYNgxqEIjeBVUSEPz6EIgEBg3aCQyIEmCgcOAMaK?= =?us-ascii?q?x5CAwtSCAkXEhAQAgQRGgsGAxY+CQIEDgNACA0DEQQDDxgJEggQBAYDMQwlC?= =?us-ascii?q?wMUDAEGAwYFAwEDGwMUAwUkBwMZDyMNDQQYBx0DAwUlAwICGwcCAgMCBhUGA?= =?us-ascii?q?gJOOQgECAQrJA8FAgcvBQQvAh4EBQYRCAIWAgYEBAQEFgIQCAIIJxcHExgbG?= =?us-ascii?q?QEFWRAJIRwOGgoGBQYTAyBtBQo7DygzNTwrHxsKgRIqKxUDBAQDAgYTAwMiA?= =?us-ascii?q?hAuMQMVBikTEi0JK3UJAgMiaQUDAwQqLgMJHx8HCSQqPQUFKwEdmUYGZEdog?= =?us-ascii?q?QY1NQItoXmMF5JdNAeDVIE+BgyeTjKXAgORYpcAIKF/hTmBeIF+bVOCZ1GdG?= =?us-ascii?q?nM7AgYLAQEDCY8HAQE?= IronPort-PHdr: A9a23:yeI42hOELiZaGtysweQl6nZSChdPi9zP1u491JMrhvp0f7i5+Ny6Z QqDv64r1gSXFtyAtrptsKn/i+jYQ2sO4JKM4jgpUadncFs7s/gQhBEqG8WfCEf2f7bAZi0+G 9leBhc+pynoeUdaF9zjaFLMv3a88SAdGgnlNQpyO+/5BpPeg9642uys9ZDfeRtEiTS8bL99M Rm7owXcvdQKjIV/Lao81gHHqWZSdeRMwmNoK1OTnxLi6cq14ZVu7Sdete8/+sBZSan1cLg2Q rJeDDQ9LmA6/9brugXZTQuO/XQTTGMbmQdVDgff7RH6WpDxsjbmtud4xSKXM9H6QawyVD+/9 KpgVgPmhzkbOD446GHXi9J/jKRHoBK6uhdzx5fYbJyJOPZie6/Qe84RS2hcUcZLTyFPAZ6yY YsRAeQPP+lYoZXyqFUBohWxHgSsGOHixyVUinPqx6A30eIsGhzG0gw6GNIOtWzZos/1NKcTV eC1zbHIzS3dYPhL2Tjy8pLIchc4ofGRXLJ/b9DRyVIyHA7CllWQqY3lPzeU1uQVq2iU8fBsV Oy1hG49rAFxuyWvxsYyhYnTnYIY0UvE9SZ5wYYzO9K4VFR3bsW6H5ZJsSyRKoR5TN84TW5yp CY61qMJuYS9fCUS1pgr2R3SZuCIfoSU/h7uVuacLDhliXxlZL6yiBm8/0i9x+DyUsS5zlhEo zRLn9TPtX0A2R3e58iJR/Zy+kqs2DCC3B3Q5OFcOU04iLbXJpo7zrItiJYesl7PEjL4lUj5l qObclgo9+614Or9eLrmvIWTN4pshwH7NaQhh9KwDPwjMggLQ2ib4eO81KD//UHhQLVFkPk2k q7BvZ/eOMgWorC1DxVI3osi6BuzFSqq3M4FkXQDKl1JYBOHj473NFHSOP30EOuzjlC2nDt22 fzLPaftDojDI3XMirvseatx51ZZyAUpzNBf45xUCqsGIPL2QkLxrNzYDh49Mwy12+bnEMty2 pkQWG2VGK+ZN7rSsUKJ5u0xOemMf5QYuC3+K/kl4f7hk2M5lUUGcqa3xZcXbmu3Eex8I0qFe XrsnssBEWASswYgVODqkkGNUSZPZ3auWKIx/i07CIWjDYrYWoCtmruB3CKlEZxWfGxJFleME XLwe4WeR/gMcD6SItNmkjEcWriuVpQu2Qi2tADg17poMurU9TMDtZ/4z9h14PDTlQsu+jNqA cWSyXuNQH9ukmMPXT820/M3nUso9lCGmZRihPlVBJQH+/RMehsgMpvR3qpxDNWkHkr5ftaNS U6+T52ZCCs2V88wzsUVK1h8Ep2NghqGxyO2CL8YjPTfC5A+t7rVw3PxKt1V0HHbzqIskFA8T 41IL2Lw1YBl8A2GP47Il0SBj6viSq0G2zfQ9WqZ1iLapEFZVA9oSaiDQnkFYVLLrNnj/WvZT K6oBKhhOAYXmp3KEbdDdtC81QYOf/zkItmLJjvpww+N IronPort-Data: A9a23:L/uhsqJzqVsTuQfMFE+RcZclxSXFcZb7ZxGr2PjKsXjdYENS1TxTx 2EcCziPOPeIZGT3LdB0Ptiw/B5XsJCGy4AxSQId+CA2RRqmiyZl6fd1j6vUF3nPRiEWZBs/t 63yUvGZcIZsCCa0Si6FatANl1ElvU2zbue6WbWs1hxZH1c+En9x0U07wobVv6Yx6TSHK1LV0 T/Ni5CHULOV82Yc3rU8sv/rRLtH5ZweiRtA1rAMTakjUGz2yxH5OKkiyZSZdBMUdGX78tmSH I4vxJnhlo/QEoxE5tmNyt4XeWVSKlLe0JTnZnd+A8CfbhZ+SiMa34UnZP8dVl1umh6KmIBN4 sVsu5egcFJ8VkHMsLx1vxhwIHgvZ+sfpu+BeD7m4Pn7I0/uKiO9haw0XAdvZtFeq78f7WJmr JT0LBgVbhGHhvquzfSkQ/Nrn9kiIdPwFJgcq3dt0XfTAJ7KRLiZHvuVv44EhV/cgOhTMsr5X ckSVAYyNjvrPxheHnM8NI0HybLAan7XNmcwREiujbYw5kDP1gt03amrO93QEvSFSc8Qhk+Er WLL5EziBQwAP9GAwCCItHW2iYfycTjTAdpDUuTiprgz2wHVlzV75AAqaGZXaMKR0iaWM++z4 WRIp0LCcYBaGIeXohURkvF2TLNofvLRZjaIL9AH1Q== IronPort-HdrOrdr: A9a23:cvX3Ma2gKbr1zbH/n0C7UgqjBJQkLtp133Aq2lEZdPU1SL3gqy nKpp8mPHDP5Qr5NEtPpTn4AtjkfZq+z+8S3WByB8bAYOCOggLBRr2K0bGC/9SJIUHDH4VmtZ uIHZIQNPTASXd+gdf/6Am8V/YMqeP3lJyAtKPwynt9SQlrbuVB4gt/F2+gYypLrXF9dPgEKK Y= X-IronPort-Anti-Spam-Filtered: true Received: from unknown (HELO [192.168.1.19]) ([109.128.134.91]) by relay.proximus.be with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 07 Aug 2022 21:13:59 +0200 Message-ID: <32ec0c63ee0db07f5b94faf547f2ec2792b2c827.camel@skynet.be> Subject: Re: [RFA] Allow to document user-defined aliases. To: Tom Tromey , Philippe Waroquiers via Gdb-patches Date: Sun, 07 Aug 2022 21:14:03 +0200 In-Reply-To: <87v8r7g6wc.fsf@tromey.com> References: <20220725041113.185127-1-philippe.waroquiers@skynet.be> <87v8r7g6wc.fsf@tromey.com> Content-Type: text/plain; charset="UTF-8" User-Agent: Evolution 3.38.3-1 MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , From: Philippe Waroquiers via Gdb-patches Reply-To: Philippe Waroquiers Errors-To: gdb-patches-bounces+public-inbox=simark.ca@sourceware.org Sender: "Gdb-patches" On Thu, 2022-08-04 at 13:12 -0600, Tom Tromey wrote: > > > > > > "Philippe" == Philippe Waroquiers via Gdb-patches > > > > > > writes: > > Philippe> When using 'help ALIASNAME', GDB shows the help of the aliased command. > Philippe> This is a good default behaviour. > > Philippe> However, GDB alias command allows to define aliases with arguments > Philippe> possibly changing or tuning significantly the behaviour of > Philippe> the aliased command. In such a case, showing the help of the aliased > Philippe> command might not be ideal. > [...] > Philippe> When a user-defined alias is documented specifically, help and apropos > Philippe> use the provided alias documentation instead of the documentation of > Philippe> the aliased command. > > This makes sense to me. My perspective is that the way a command is > defined (there are 4 or 5 ways now) isn't as important as what it does, > and users are normally interested in the latter. Ok, let's start on this basis. In any case, if one day, we really still want to make an alias appear in the list of aliases of the aliased command, we can add an option to the alias command such as: -l list this alias in the aliased command help even if it has its own documentation. > > One question I have is whether there is any way to see how the command > is defined, if it is documented. For commands using "define" there is > "show user-defined"... perhaps that ought to be made to work with > aliases as well. The command 'help aliases' show the user defined aliases. However, I think that when doing 'help for-a-user-documented-alias', it would be better to still show the alias definition. I will produce an RFA v2 with the above change, and also fixing the comments you have given in the other mail. Thanks for the review. Philippe