From patchwork Mon Apr 6 13:57:09 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Damien Robert X-Patchwork-Id: 11475587 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 09B6914DD for ; Mon, 6 Apr 2020 13:57:46 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id D2EE4233F8 for ; Mon, 6 Apr 2020 13:57:45 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="fjdT6DoC" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728550AbgDFN5o (ORCPT ); Mon, 6 Apr 2020 09:57:44 -0400 Received: from mail-wr1-f68.google.com ([209.85.221.68]:33134 "EHLO mail-wr1-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728514AbgDFN5m (ORCPT ); Mon, 6 Apr 2020 09:57:42 -0400 Received: by mail-wr1-f68.google.com with SMTP id a25so17628367wrd.0 for ; Mon, 06 Apr 2020 06:57:40 -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 :mime-version:content-transfer-encoding; bh=E+Q6JaNMMD7zUzOz2lG8423EFFmQSh4IWdLGxHP7AhE=; b=fjdT6DoC/lZnOqxn9eVnAD7cfhT/yMIIuGNTQZAuGkPNxSjDyFeAqFhS0GHNhQ5IAg UzVbYF2oe1soh1igMHkLgt1v9Nk9igoPFsW5Nnb8GQ4JksJ6ivx8BeiN2eGjvmP1smPm a3K0ZqxnvzPUUxY2dgVZM6NKS2wwDRCvxU5eRoBi4KRBLbM6hWtYTYioWnm6OAalLhiA ikuEclzd+sg9dcfG/nNDG0ETDVxaKJYRXoORHM7w8aCXIoh21wao7AyaIAyhP7T1XUWI 5E9hYJIczlJyViEzeRnyXBNNxoNvlAD4y5nLRh6wP6qpzpj/xoTaDV92zSXEZff5q5R+ ZJeQ== 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:mime-version:content-transfer-encoding; bh=E+Q6JaNMMD7zUzOz2lG8423EFFmQSh4IWdLGxHP7AhE=; b=Hnp53nXYOA49b1rn9252HocpQ8M1ln87gesMX1yFNxz8W8Moc+VlaDWnFPhyr0Nx2O 4g2Gy/lmT89xIER+52bKE0JMK3UMFSLdP+ky0CZvwrkewmZxkbgc2o83lsm1SlSbU0EL +eejA7/RrLOnbQkKBZdRKPhvg/4PegUS1fVFVWhgaXaYeJ/f8zLlINNQaec5OOcfgY+e VqKpis9PKex+azsSl4zXxzMtCm7zjpiEpmsY5qslEXkfSfA9Lg46UWwat78xrnaLwLwI i+LdMOI2tDb+pAcZcSITgs9fZ3uot/QHGgMC0Mq3+LtOBw9J5I3ZB5LePC5Jq/OWQsWn wI2w== X-Gm-Message-State: AGi0PuYAwRMpU59s2MFE8Mo6F7o/8xoZAYlPUjMFb7vQRecWVcZs0Npb KHHkwhzGx5s53NBgemEN30PZ5OhM+mA= X-Google-Smtp-Source: APiQypKkEYg+TgbtW5P2VKAC+5W6mEl3Tyy9W7ukQjxD0iYiO8NElG3TCfgaknNWFc4uPgwsIBXGEw== X-Received: by 2002:adf:fd81:: with SMTP id d1mr7752047wrr.394.1586181459547; Mon, 06 Apr 2020 06:57:39 -0700 (PDT) Received: from localhost.localdomain (87-231-246-247.rev.numericable.fr. [87.231.246.247]) by smtp.gmail.com with ESMTPSA id s13sm10414149wrw.20.2020.04.06.06.57.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 06 Apr 2020 06:57:38 -0700 (PDT) From: Damien Robert X-Google-Original-From: Damien Robert To: git@vger.kernel.org, Philippe Blain Cc: Damien Robert Subject: [PATCH v6 5/5] doc: --recurse-submodules mostly applies to active submodules Date: Mon, 6 Apr 2020 15:57:09 +0200 Message-Id: <20200406135709.60041-6-damien.olivier.robert+git@gmail.com> X-Mailer: git-send-email 2.26.0 In-Reply-To: <20200406135709.60041-1-damien.olivier.robert+git@gmail.com> References: <20200406135709.60041-1-damien.olivier.robert+git@gmail.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The documentation refers to "initialized" or "populated" submodules, to explain which submodules are affected by '--recurse-submodules', but the real terminology here is 'active' submodules. Update the documentation accordingly. Some terminology: - Active is defined in gitsubmodules(7), it only involves the configuration variables 'submodule.active', 'submodule..active' and 'submodule..url'. The function submodule.c::is_submodule_active checks that a submodule is active. - Populated means that the submodule's working tree is present (and the gitfile correctly points to the submodule repository), i.e. either the superproject was cloned with ` --recurse-submodules`, or the user ran `git submodule update --init`, or `git submodule init []` and `git submodule update []` separately which populated the submodule working tree. This does not involve the 3 configuration variables above. - Initialized (at least in the context of the man pages involved in this patch) means both "populated" and "active" as defined above, i.e. what `git submodule update --init` does. The --recurse-submodules option mostly affects active submodules. An exception is `git fetch` where the option affects populated submodules. As a consequence, in `git pull --recurse-submodules` the fetch affects populated submodules, but the resulting working tree update only affects active submodules. In the documentation of `git-pull`, let's distinguish between the fetching part which affects populated submodules, and the updating of worktrees, which only affects active submodules. Signed-off-by: Damien Robert Helped-by: Philippe Blain --- Documentation/git-checkout.txt | 2 +- Documentation/git-grep.txt | 2 +- Documentation/git-ls-files.txt | 2 +- Documentation/git-pull.txt | 6 ++++-- Documentation/git-read-tree.txt | 2 +- Documentation/git-switch.txt | 2 +- 6 files changed, 9 insertions(+), 7 deletions(-) diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 140bd3eabb..5b697eee1b 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -292,7 +292,7 @@ Note that this option uses the no overlay mode by default (see also --recurse-submodules:: --no-recurse-submodules:: - Using `--recurse-submodules` will update the content of all initialized + Using `--recurse-submodules` will update the content of all active submodules according to the commit recorded in the superproject. If local modifications in a submodule would be overwritten the checkout will fail unless `-f` is used. If nothing (or `--no-recurse-submodules`) diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index ddb6acc025..cdf8e26b47 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -93,7 +93,7 @@ OPTIONS with `--no-index`. --recurse-submodules:: - Recursively search in each submodule that has been initialized and + Recursively search in each submodule that is active and checked out in the repository. When used in combination with the option the prefix of all submodule output will be the name of the parent project's object. This option has no effect diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index 8461c0e83e..3cb2ebb438 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -148,7 +148,7 @@ a space) at the start of each line: top directory. --recurse-submodules:: - Recursively calls ls-files on each submodule in the repository. + Recursively calls ls-files on each active submodule in the repository. Currently there is only support for the --cached mode. --abbrev[=]:: diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt index 47bc4a7061..b336df00c7 100644 --- a/Documentation/git-pull.txt +++ b/Documentation/git-pull.txt @@ -85,8 +85,10 @@ OPTIONS Pass --verbose to git-fetch and git-merge. --[no-]recurse-submodules[=yes|on-demand|no]:: - This option controls if new commits of all populated submodules should - be fetched and updated, too (see linkgit:git-fetch[1], linkgit:git-config[1] and linkgit:gitmodules[5]). + This option controls if new commits of populated submodules should + be fetched, and if the working trees of active submodules should be + updated, too (see linkgit:git-fetch[1], linkgit:git-config[1] and + linkgit:gitmodules[5]). + If the checkout is done via rebase, local submodule commits are rebased as well. + diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index 501f2ec375..5fa8bab64c 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -116,7 +116,7 @@ OPTIONS located in. --[no-]recurse-submodules:: - Using --recurse-submodules will update the content of all initialized + Using --recurse-submodules will update the content of all active submodules according to the commit recorded in the superproject by calling read-tree recursively, also setting the submodules' HEAD to be detached at that commit. diff --git a/Documentation/git-switch.txt b/Documentation/git-switch.txt index 79dbc9624d..3759c3a265 100644 --- a/Documentation/git-switch.txt +++ b/Documentation/git-switch.txt @@ -181,7 +181,7 @@ name, the guessing is aborted. You can explicitly give a name with --recurse-submodules:: --no-recurse-submodules:: Using `--recurse-submodules` will update the content of all - initialized submodules according to the commit recorded in the + active submodules according to the commit recorded in the superproject. If nothing (or `--no-recurse-submodules`) is used, submodules working trees will not be updated. Just like linkgit:git-submodule[1], this will detach `HEAD` of the