From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 04F3BC433F5 for ; Wed, 9 Mar 2022 16:02:36 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234274AbiCIQDc (ORCPT ); Wed, 9 Mar 2022 11:03:32 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40694 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234277AbiCIQC5 (ORCPT ); Wed, 9 Mar 2022 11:02:57 -0500 Received: from mail-wr1-x42b.google.com (mail-wr1-x42b.google.com [IPv6:2a00:1450:4864:20::42b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 563B717AEF0 for ; Wed, 9 Mar 2022 08:01:55 -0800 (PST) Received: by mail-wr1-x42b.google.com with SMTP id r6so3345596wrr.2 for ; Wed, 09 Mar 2022 08:01:55 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=RxrhDEZAKd1TxOQXR/q4fcpzONcBLxkiP9hpg49quRw=; b=NUrmalYNvUU3TrT68QNW/28Fq53KeyPduwk2IFQNo0zyYyAgfS/duaNwNebIXIGFwd PLwl2xSDn8X72eOlf48RFuWz76tIDc0Uh21kAXHcM72R8hVb2m83rbeLjR/+vQmZOgxr A1pbwDE5dObx6ZAbzp68g8M9CZF2RvHFv+3L9474HrVO7iZiJ00mlAZZvz3BN1RRt/6T SHN9s9oiIfRqAl4afaDha979TQSjOGhDDOAPClWAvIy1Emcj21eAtqhXMzqvQoVrhMY4 E2SN1lTX8VmdHiVbZuwacDnNEK8/vyEFk3migbaZNwzpKMxbAlonBmnKPMqduOrkxdby LZvQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=RxrhDEZAKd1TxOQXR/q4fcpzONcBLxkiP9hpg49quRw=; b=KdoJROyUTRSBn1mYppzZHAB99dK473MxJuv854BMHrlX58dy27/c85Qw3i9o4JY7Am eNgOXA4Vav2mecVQ3l0ZGMFQ7QAP5lsDtYiRhVuPb85eO4DbsjzVIaeozDPBdt1tD+AC 1YXX4PQzscHQxcSLymewADgYtty6f9DHKJNig+XgYdS56hjDdRfJn3ilW0iQtoYR8Cnk CKcDodiUc60/gW4OrjFz0lTmTUnRymGEOlxu12XL2CCgki0dLheyEQeYm0TLdERjL3F1 cWuhPlEyHf1kKGPOrEZGUGgPEnwcollhzR4xt3Nrw+fBXHTlXHkX4Ulssn7O5Y8Nro3U 52Rw== X-Gm-Message-State: AOAM530vNIYKGtuHtVtsR0S8z+DdVembiSGi08tW+ZPH7VGzG3WBDeGV +nBFM7Pmh4pKwFo8oCRIzeNZsKQf/G4= X-Google-Smtp-Source: ABdhPJy/mSEQw/gxK3z/Ru0HoSIabRrEa6FjW6Z6+qOhtw0eFLKKWFjfjcrC5pgTYxmSj2TlYfQW2Q== X-Received: by 2002:a5d:5850:0:b0:203:76f7:5421 with SMTP id i16-20020a5d5850000000b0020376f75421mr254609wrf.114.1646841713629; Wed, 09 Mar 2022 08:01:53 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id r17-20020a05600c35d100b00389d75e2a61sm152087wmq.28.2022.03.09.08.01.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 09 Mar 2022 08:01:53 -0800 (PST) Message-Id: In-Reply-To: References: From: "Derrick Stolee via GitGitGadget" Date: Wed, 09 Mar 2022 16:01:37 +0000 Subject: [PATCH v4 07/13] MyFirstObjectWalk: update recommended usage Fcc: Sent Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit MIME-Version: 1.0 To: git@vger.kernel.org Cc: stolee@gmail.com, avarab@gmail.com, gitster@pobox.com, zhiyou.jx@alibaba-inc.com, jonathantanmy@google.com, Jeff Hostetler , Derrick Stolee , Derrick Stolee Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Derrick Stolee The previous change consolidated traverse_commit_list() and traverse_commit_list_filtered(). This allows us to simplify the recommended usage in MyFirstObjectWalk.txt to use this new set of values. While here, add some clarification on the difference between the two methods. Signed-off-by: Derrick Stolee --- Documentation/MyFirstObjectWalk.txt | 44 +++++++++++------------------ 1 file changed, 16 insertions(+), 28 deletions(-) diff --git a/Documentation/MyFirstObjectWalk.txt b/Documentation/MyFirstObjectWalk.txt index ca267941f3e..8d9e85566e6 100644 --- a/Documentation/MyFirstObjectWalk.txt +++ b/Documentation/MyFirstObjectWalk.txt @@ -522,24 +522,25 @@ function shows that the all-object walk is being performed by `traverse_commit_list()` or `traverse_commit_list_filtered()`. Those two functions reside in `list-objects.c`; examining the source shows that, despite the name, these functions traverse all kinds of objects. Let's have a look at -the arguments to `traverse_commit_list_filtered()`, which are a superset of the -arguments to the unfiltered version. +the arguments to `traverse_commit_list()`. -- `struct list_objects_filter_options *filter_options`: This is a struct which - stores a filter-spec as outlined in `Documentation/rev-list-options.txt`. -- `struct rev_info *revs`: This is the `rev_info` used for the walk. +- `struct rev_info *revs`: This is the `rev_info` used for the walk. If + its `filter` member is not `NULL`, then `filter` contains information for + how to filter the object list. - `show_commit_fn show_commit`: A callback which will be used to handle each individual commit object. - `show_object_fn show_object`: A callback which will be used to handle each non-commit object (so each blob, tree, or tag). - `void *show_data`: A context buffer which is passed in turn to `show_commit` and `show_object`. + +In addition, `traverse_commit_list_filtered()` has an additional paramter: + - `struct oidset *omitted`: A linked-list of object IDs which the provided filter caused to be omitted. -It looks like this `traverse_commit_list_filtered()` uses callbacks we provide -instead of needing us to call it repeatedly ourselves. Cool! Let's add the -callbacks first. +It looks like these methods use callbacks we provide instead of needing us +to call it repeatedly ourselves. Cool! Let's add the callbacks first. For the sake of this tutorial, we'll simply keep track of how many of each kind of object we find. At file scope in `builtin/walken.c` add the following @@ -712,20 +713,9 @@ help understand. In our case, that means we omit trees and blobs not directly referenced by `HEAD` or `HEAD`'s history, because we begin the walk with only `HEAD` in the `pending` list.) -First, we'll need to `#include "list-objects-filter-options.h"` and set up the -`struct list_objects_filter_options` at the top of the function. - ----- -static void walken_object_walk(struct rev_info *rev) -{ - struct list_objects_filter_options filter_options = { 0 }; - - ... ----- - For now, we are not going to track the omitted objects, so we'll replace those parameters with `NULL`. For the sake of simplicity, we'll add a simple -build-time branch to use our filter or not. Replace the line calling +build-time branch to use our filter or not. Preface the line calling `traverse_commit_list()` with the following, which will remind us which kind of walk we've just performed: @@ -733,19 +723,17 @@ walk we've just performed: if (0) { /* Unfiltered: */ trace_printf(_("Unfiltered object walk.\n")); - traverse_commit_list(rev, walken_show_commit, - walken_show_object, NULL); } else { trace_printf( _("Filtered object walk with filterspec 'tree:1'.\n")); - parse_list_objects_filter(&filter_options, "tree:1"); - - traverse_commit_list_filtered(&filter_options, rev, - walken_show_commit, walken_show_object, NULL, NULL); + CALLOC_ARRAY(rev->filter, 1); + parse_list_objects_filter(rev->filter, "tree:1"); } + traverse_commit_list(rev, walken_show_commit, + walken_show_object, NULL); ---- -`struct list_objects_filter_options` is usually built directly from a command +The `rev->filter` member is usually built directly from a command line argument, so the module provides an easy way to build one from a string. Even though we aren't taking user input right now, we can still build one with a hardcoded string using `parse_list_objects_filter()`. @@ -784,7 +772,7 @@ object: ---- ... - traverse_commit_list_filtered(&filter_options, rev, + traverse_commit_list_filtered(rev, walken_show_commit, walken_show_object, NULL, &omitted); ... -- gitgitgadget