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 29DE1C3DA7D for ; Thu, 5 Jan 2023 06:26:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229699AbjAEGZt (ORCPT ); Thu, 5 Jan 2023 01:25:49 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49482 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230035AbjAEGZV (ORCPT ); Thu, 5 Jan 2023 01:25:21 -0500 Received: from mx-out1.startmail.com (mx-out1.startmail.com [145.131.90.139]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6B47F5276E for ; Wed, 4 Jan 2023 22:25:20 -0800 (PST) From: Toon Claes DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=startmail.com; s=2020-07; t=1672899918; bh=0d/KhMm6zj+6qQK6iZevjxUE02FQNHJrpRZglQZF+E4=; h=From:To:Subject:Date:Message-Id:In-Reply-To:References: Mime-Version:Content-Transfer-Encoding:From:Subject:To:Date:Sender: Content-Type:Content-Transfer-Encoding:Content-Disposition: Mime-Version:Reply-To:In-Reply-To:References:Message-Id:Autocrypt; b=sRPpVknyQ2h1AbYB9ahlxp7tpe2n/J9GM7MQephTsqD3VnSmH676jWPXXOp7E28K0 Gcz5t03O9McwQ/SjqaJE2q79qmLYxN9XT72mQmNxv/LuF8x2pM/56TZbwyZFdoL4c+ 0NSMESOIuHEe7Zq5fpj8O2WfC3bmNhLSnSYrRFisPZsa9CLyUpc73Z4pMXLEzx3p2I /eFTqqdZ5g8NU2ltiDFBa1o3wYb7reVYP0jKN8VMIAxfC3KA+dxW0h1x3F5JK6U2UE xnDq25aZyl0XSNZk8Jtq4fVh+eOUczG1AXklHiEnQXO0QXtPlAd46uQeY0aI8J1gmv FehGufo6NsGaQ== To: git@vger.kernel.org Cc: Toon Claes , Phillip Wood Subject: [PATCH v2 1/1] cat-file: quote-format name in error when using -z Date: Thu, 5 Jan 2023 07:24:47 +0100 Message-Id: <20230105062447.2943709-2-toon@iotcl.com> In-Reply-To: <20230105062447.2943709-1-toon@iotcl.com> References: <20221209150048.2400648-1-toon@iotcl.com> <20230105062447.2943709-1-toon@iotcl.com> Mime-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Since it's supported to have NUL-delimited input, introduced in db9d67f2e9 (builtin/cat-file.c: support NUL-delimited input with `-z`, 2022-07-22), it's possible to pass paths that contain newlines. This works great when the object is found, but when it's not, the input path is returned in the error message. Because this can contain newlines, the error message might get spread over multiple lines, making it harder to machine-parse this error message. With this change, the input is quote-formatted in the error message, if needed. This ensures the error message is always on a single line and makes parsing the error more straightforward. Signed-off-by: Toon Claes --- builtin/cat-file.c | 19 +++++++++++++++++++ t/t1006-cat-file.sh | 8 ++++++++ 2 files changed, 27 insertions(+) diff --git a/builtin/cat-file.c b/builtin/cat-file.c index b3be58b1fb..6d7d5e2188 100644 --- a/builtin/cat-file.c +++ b/builtin/cat-file.c @@ -14,6 +14,7 @@ #include "tree-walk.h" #include "oid-array.h" #include "packfile.h" +#include "quote.h" #include "object-store.h" #include "promisor-remote.h" #include "mailmap.h" @@ -439,8 +440,17 @@ static void batch_object_write(const char *obj_name, &data->oid, &data->info, OBJECT_INFO_LOOKUP_REPLACE); if (ret < 0) { + struct strbuf quoted = STRBUF_INIT; + + if (opt->nul_terminated && + obj_name) { + quote_c_style(obj_name, "ed, NULL, 0); + obj_name = quoted.buf; + } + printf("%s missing\n", obj_name ? obj_name : oid_to_hex(&data->oid)); + strbuf_release("ed); fflush(stdout); return; } @@ -475,6 +485,13 @@ static void batch_one_object(const char *obj_name, result = get_oid_with_context(the_repository, obj_name, flags, &data->oid, &ctx); if (result != FOUND) { + struct strbuf quoted = STRBUF_INIT; + + if (opt->nul_terminated) { + quote_c_style(obj_name, "ed, NULL, 0); + obj_name = quoted.buf; + } + switch (result) { case MISSING_OBJECT: printf("%s missing\n", obj_name); @@ -499,6 +516,8 @@ static void batch_one_object(const char *obj_name, result); break; } + + strbuf_release("ed); fflush(stdout); return; } diff --git a/t/t1006-cat-file.sh b/t/t1006-cat-file.sh index 23b8942edb..11344a35bf 100755 --- a/t/t1006-cat-file.sh +++ b/t/t1006-cat-file.sh @@ -447,6 +447,14 @@ test_expect_success FUNNYNAMES '--batch-check, -z with newline in input' ' test_cmp expect actual ' +test_expect_success '--batch-check, -z with newline in non-existent named object' ' + printf "HEAD:newline${LF}embedded" >in && + git cat-file --batch-check -z actual && + + printf "\"HEAD:newline\\\\nembedded\" missing\n" >expect && + test_cmp expect actual +' + batch_command_multiple_info="info $hello_sha1 info $tree_sha1 info $commit_sha1 -- 2.38.1