From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from eggs.gnu.org (eggs.gnu.org [IPv6:2001:470:142:3::10]) by sourceware.org (Postfix) with ESMTPS id BBE8C3858D35 for ; Wed, 1 Feb 2023 13:03:47 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org BBE8C3858D35 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=gnu.org Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=gnu.org Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pNCm9-00080z-N2; Wed, 01 Feb 2023 08:03:45 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=tFEDJsdVLYwS1pDiJvsq0ZOESeF7gHmE0En7TaLfdig=; b=K/NBh+3BYyp7 qjn0KV4i2Gd2b2HKBxFq27eZPy7UXgcyNWNxZ/kODpPfm5CAShmj88quDrm9Q3Who8O6lxr4pIUh/ gtHnkKCcuknBUJZffAQS9QiDsoAU04octesN2h5HWHcknz6cDtilhjJ1kpxrVrgRk5+GVxcc5Lge0 4wsEO6bR9EttnBBpekzQG3+ufApisPB8SAb3xgXb9o+6v0M5ClrXcz/FWcAy1a57KQtXS9RaYmhaH fPlecxudPcRe5+JEYY3rTWJ9fiZzX+Jv6k/2EXQMHePDUIcx9qXxykDqAiB2Q2usyOEAs//dH/UFW T4KfXhtyVWc299e8G405yw==; Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pNCm9-0002H1-5L; Wed, 01 Feb 2023 08:03:45 -0500 Date: Wed, 01 Feb 2023 15:03:43 +0200 Message-Id: <83357p1qs0.fsf@gnu.org> From: Eli Zaretskii To: Andrew Burgess Cc: gdb-patches@sourceware.org, gdb-patches@sourceware.org, thiago.bauermann@linaro.org, simon.marchi@efficios.com In-Reply-To: <87lelhtwqv.fsf@redhat.com> (message from Andrew Burgess via Gdb-patches on Wed, 01 Feb 2023 12:07:20 +0000) Subject: Re: [PATCH v3 5/8] gdbserver: Transmit target description ID in thread list and stop reply References: <20230130044518.3322695-1-thiago.bauermann@linaro.org> <20230130044518.3322695-6-thiago.bauermann@linaro.org> <87lelhtwqv.fsf@redhat.com> X-Spam-Status: No, score=-2.3 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_PASS,SPF_PASS,TXREP 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: > Cc: Thiago Jung Bauermann , Simon Marchi > > Date: Wed, 01 Feb 2023 12:07:20 +0000 > From: Andrew Burgess via Gdb-patches > > Finally, I wonder if it might make sense to add something like: > > @cindex Target Description IDs > > to every place where we discuss these ID's, then there will be an index > entry that links all the places together? Adding index entries is always welcome, as those help finding subjects quickly and efficiently. However: . we prefer index entries to use only lower-case letters, to avoid having their sorting order (which eventually affects whet you see in the Info reader when you use completion) depend on the locale where the manual is produced from Texinfo; . more importantly, it is not a good idea to have multiple identical index entries, since makeinfo then disambiguates them as foo<1>, foo<2>, etc., and when you see those in the list of completions, you have no idea which one is the one you want. So it is preferable to qualify each such index entry in a way that will convey enough information to the reader to know which one he/she wants. For example: @cindex target description id, and remote packets @cindex target description id, in python programs etc., you get the idea.