From patchwork Tue May 21 11:17:28 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Tom Tromey X-Patchwork-Id: 90581 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id A79FE3858D33 for ; Tue, 21 May 2024 11:18:17 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-il1-x136.google.com (mail-il1-x136.google.com [IPv6:2607:f8b0:4864:20::136]) by sourceware.org (Postfix) with ESMTPS id 6AB3C3858D1E for ; Tue, 21 May 2024 11:17:41 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 6AB3C3858D1E Authentication-Results: sourceware.org; dmarc=pass (p=quarantine dis=none) header.from=adacore.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=adacore.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 6AB3C3858D1E Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=2607:f8b0:4864:20::136 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1716290271; cv=none; b=Z3sFHrXhCGqn4ooIBp8+mg4jRv72NxWxCp7+6C1CyU3guEMu88f9oXGa0UzxRO5qnY4eSE6yR6Fsx7IEKd7h9zinn/08R8bin0wEQs2NKyBCojZJ8YPuhybuX5FLvXMWIAs89N9qH98TX5+3bzvC3E0GblDWu9LWP7dVE7EbI8s= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1716290271; c=relaxed/simple; bh=m2hciVDuT1LSVpE8IrlYWw1RDtcpGNfs2oeNtAmoJBM=; h=DKIM-Signature:From:To:Subject:Date:Message-ID:MIME-Version; b=U2uhQgi1HAJim7c0wH9ao1y7ASGKkhT6I0V1HEeJ9rLslOn6EwZvO3QQdTL6kTtGocBSnJIlYWucfZQxC46SUrKDaI7K720eF8HXLZ3++Pwx+G+bhknWXn+Vc0yqRzpxu267FPt3loGD3/pnRaDALalBaoWUlr01Ek6awdY7+7o= ARC-Authentication-Results: i=1; server2.sourceware.org Received: by mail-il1-x136.google.com with SMTP id e9e14a558f8ab-36c80f9c86bso19698265ab.0 for ; Tue, 21 May 2024 04:17:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=adacore.com; s=google; t=1716290260; x=1716895060; darn=sourceware.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=3DZGu8oCSwu496BGMio3L1xiUpUTBzMfKBmj4daTB7c=; b=CS2Yaco9dl/6MmC+SPF4v5e17dlJn0mJZKxLMEJJ/4FVp6JIBGlDMdUj4drwYHepCL 0Rkl9ORoKQRXVrmj2/oxsLP9JOoc4qnue7b8Qeu06iyXusI6/WOM7OWk2bZzJ57y1Cq5 0Cy0uEtUDew81hR5rKfTC7RjLwsf64nlTaVWq8dhs7sVd5HrFJIaRa5zkC6QeswhTRr4 druOZav4NT4wjnF3uNeaqYlSaKElHSRnf6+1N2KrchLve6FWl8+RLTLNZRc0GCr5VfPR K+9TiwuMrpMIIfZO8ApGAxvoqg+1n7cJSaywnV3GYMK8jCaKM6QRCDGpXloCbuZAGwQx XjzQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1716290260; x=1716895060; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=3DZGu8oCSwu496BGMio3L1xiUpUTBzMfKBmj4daTB7c=; b=ezFvlApV1XQWaFGYCXSnZXiYNfYBTApdm2cGD4bb1NfzhbjTr/a7hKuKvip0JMHO9d VwQPqmnAYn6PP+WbL1Kp8ubL+43tEJH54JMd7XkA+tOSw8mTMeMER+3otbSZbKTKj547 fTPSt170EfgARYJveQTdFA8SB9HOXjsNxRTi4gRgxhKj67olx/kCAmfcXVfF8H0oykqw 5C6/QZc0SfF2mk1MjLVCAXhwVwi99/S7ZpLgVq0SKYA1om5+L/Ygq6ffKLBHA19ozg8q dIZzRgSorFQGr5RKOi6b0Myn4I09y9jSOiN7GgptGShP3scT2FUjpUa9nvGtaAd5rS1L t0rw== X-Gm-Message-State: AOJu0YwbyFooXbs5oqFrzk1T/c0MMYmPev0b4FC8H+Yy8p3X5U7vtgef xaXykuPO+lVMITHtGx/1B3og7gvqWJmaTaW0VD3bMmJ+wZKYb4OMy71xBEjUt3Atiqslj1OmPf4 = X-Google-Smtp-Source: AGHT+IGTYsbgBLxuwvhW4varU6wZ+xOs+TasdY+lNjJsW25P0x+YTJoWSMjvUQrXcvUGm5rpq/x4Cg== X-Received: by 2002:a05:6e02:58b:b0:371:6e0:f89a with SMTP id e9e14a558f8ab-37106e0fb0emr9546975ab.14.1716290260621; Tue, 21 May 2024 04:17:40 -0700 (PDT) Received: from localhost.localdomain (75-166-134-4.hlrn.qwest.net. [75.166.134.4]) by smtp.gmail.com with ESMTPSA id e9e14a558f8ab-37129cdba79sm1234545ab.85.2024.05.21.04.17.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 May 2024 04:17:40 -0700 (PDT) From: Tom Tromey To: gdb-patches@sourceware.org Cc: Tom Tromey Subject: [PATCH] Clarify documentation for pretty_printer.child Date: Tue, 21 May 2024 05:17:28 -0600 Message-ID: <20240521111728.928069-1-tromey@adacore.com> X-Mailer: git-send-email 2.44.0 MIME-Version: 1.0 X-Spam-Status: No, score=-11.2 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, 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 X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org An Ada pretty-printer had a bug where its 'child' method returned a gdb.Value rather than a tuple. Kévin suggested that the documentation for this method could be improved to clarify this. Reviewed-By: Kévin Le Gouguec --- gdb/doc/python.texi | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index 4ca3ae4eca4..86ccc140c6d 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -1869,8 +1869,9 @@ If available, this method should return the number of children. This is not a basic method, so @value{GDBN} will only ever call it for objects derived from @code{gdb.ValuePrinter}. -If available, this method should return the child value indicated by -@var{n}. Indices start at zero. +If available, this method should return the child item (that is, a +tuple holding the name and value of this child) indicated by @var{n}. +Indices start at zero. @end defun @value{GDBN} provides a function which can be used to look up the