From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS31976 209.132.180.0/23 X-Spam-Status: No, score=-2.6 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,RCVD_IN_DNSWL_HI,RCVD_IN_SORBS_SPAM, RP_MATCHES_RCVD shortcircuit=no autolearn=no autolearn_force=no version=3.4.0 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by dcvr.yhbt.net (Postfix) with ESMTP id D58D12047F for ; Mon, 7 Aug 2017 21:19:49 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752166AbdHGVTq (ORCPT ); Mon, 7 Aug 2017 17:19:46 -0400 Received: from mail-pg0-f65.google.com ([74.125.83.65]:34839 "EHLO mail-pg0-f65.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752094AbdHGVTo (ORCPT ); Mon, 7 Aug 2017 17:19:44 -0400 Received: by mail-pg0-f65.google.com with SMTP id l64so1396646pge.2 for ; Mon, 07 Aug 2017 14:19:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=lR3+IeueQWsEDB/PfqL8MvyMaEhpA0zyM70yE2wYpic=; b=ceVn6gULX0sldB08NkCGj9/wkAJFvI4wAWDfM1v15wUre9N9tEo3cvS7OPzBwg8vr0 wwKabtSYto9A4fJ7Qc5yzz2ruIqR8tZKKDOtbh6bEXdbCOACi56mwK51QP7ME7B2XZoU Xmak+HL8b4eUMZpl0T43ud4DlkZwyRsEI9RxW2dsOF05HCvLJU5lzXzMDkcdFeXs3Yks 6QP0WS2j2XFBazsEdsYbUaQI2DDVVU8qAxTOtRLPSmHWlPX2sdDsxqhpQcm/SWk4EhaH 7RDf3U72QZClwrQxs781zdFdzXjz88mOr/nYC6YJjud+g2A60cua60lLfAvDyCxjPH8s GNmg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=lR3+IeueQWsEDB/PfqL8MvyMaEhpA0zyM70yE2wYpic=; b=qqjke1NKqljMycW9pot6ZyqcyPUBbFfoFnjpAUbfurFZN9jycgrpQ1KkBdhojJk1m6 +IMfXWGekNHxz1AvnZMwP6wrAYtAAcZxQhH4SxP1IO5KJK/tOL4OFi/uyhUmmLCHgzIn tMscQ0H2Yllvm6vEyuZkkFkDLgcUYh0osWHHNuSR2kOpqC5Jwxyn01kfVp0Up43AZmJw x/S0x8OnrMwBZUUqSXOebzFE1fD+XUehLcGcm4R+1v5ukFqYxzDbwqhie1M3ZvvM/7N5 XvToIHJ+tsgAS+2QR8/9xqeaiy0vVoKim82v7RNMzpPywUVIPHS0dAHOchzPlrascRWf OYdg== X-Gm-Message-State: AHYfb5hKOV0NLiVvQHL9A9LM3rOplpIQxNPeJNhXkWmlZINU4eVsEf61 uEIbypWwYP53llJ5fyA= X-Received: by 10.99.96.206 with SMTP id u197mr1792850pgb.107.1502140784146; Mon, 07 Aug 2017 14:19:44 -0700 (PDT) Received: from localhost.localdomain ([2405:205:6016:3285:fd77:5453:49e2:f3b5]) by smtp.gmail.com with ESMTPSA id z127sm15141084pfb.64.2017.08.07.14.19.40 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 07 Aug 2017 14:19:43 -0700 (PDT) From: Prathamesh Chavan To: git@vger.kernel.org Cc: sbeller@google.com, christian.couder@gmail.com, Prathamesh Chavan Subject: [GSoC][PATCH 09/13] submodule foreach: correct '$path' in nested submodules from a subdirectory Date: Tue, 8 Aug 2017 02:48:56 +0530 Message-Id: <20170807211900.15001-10-pc44800@gmail.com> X-Mailer: git-send-email 2.13.0 In-Reply-To: <20170807211900.15001-1-pc44800@gmail.com> References: <20170807211900.15001-1-pc44800@gmail.com> Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org When running 'git submodule foreach' from a subdirectory of your repository, nested submodules get a bogus value for $sm_path: For a submodule 'sub' that contains a nested submodule 'nested', running 'git -C dir submodule foreach echo $path' would report path='../nested' for the nested submodule. The first part '../' is derived from the logic computing the relative path from $pwd to the root of the superproject. The second part is the submodule path inside the submodule. This value is of little use and is hard to document. There are two different possible solutions that have more value: (a) The path value is documented as the path from the toplevel of the superproject to the mount point of the submodule. In this case we would want to have path='sub/nested'. (b) As Ramsay noticed the documented value is wrong. For the non-nested case the path is equal to the relative path from $pwd to the submodules working directory. When following this model, the expected value would be path='../sub/nested'. The behavior for (b) was introduced in 091a6eb0fe (submodule: drop the top-level requirement, 2013-06-16) the intent for $path seemed to be relative to $cwd to the submodule worktree, but that did not work for nested submodules, as the intermittent submodules were not included in the path. If we were to fix the meaning of the $path using (a) such that "path" is "the path from the toplevel of the superproject to the mount point of the submodule", we would break any existing submodule user that runs foreach from non-root of the superproject as the non-nested submodule '../sub' would change its path to 'sub'. If we would fix the meaning of the $path using (b), such that "path" is "the relative path from $pwd to the submodule", then we would break any user that uses nested submodules (even from the root directory) as the 'nested' would become 'sub/nested'. Both groups can be found in the wild. The author has no data if one group outweighs the other by large margin, and offending each one seems equally bad at first. However in the authors imagination it is better to go with (a) as running from a sub directory sounds like it is carried out by a human rather than by some automation task. With a human on the keyboard the feedback loop is short and the changed behavior can be adapted to quickly unlike some automation that can break silently. Discussed-with: Ramsay Jones Signed-off-by: Prathamesh Chavan Signed-off-by: Stefan Beller --- git-submodule.sh | 1 - t/t7407-submodule-foreach.sh | 36 ++++++++++++++++++++++++++++++++++-- 2 files changed, 34 insertions(+), 3 deletions(-) diff --git a/git-submodule.sh b/git-submodule.sh index ec57d6528..4b7da2fc1 100755 --- a/git-submodule.sh +++ b/git-submodule.sh @@ -320,7 +320,6 @@ cmd_foreach() prefix="$prefix$sm_path/" sanitize_submodule_env cd "$sm_path" && - sm_path=$(git submodule--helper relative-path "$sm_path" "$wt_prefix") && # we make $path available to scripts ... path=$sm_path && if test $# -eq 1 diff --git a/t/t7407-submodule-foreach.sh b/t/t7407-submodule-foreach.sh index 6ba5daf42..0663622a4 100755 --- a/t/t7407-submodule-foreach.sh +++ b/t/t7407-submodule-foreach.sh @@ -82,9 +82,9 @@ test_expect_success 'test basic "submodule foreach" usage' ' cat >expect <expect <../../actual + ) && + test_i18ncmp expect actual +' cat > expect <