From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS31976 209.132.180.0/23 X-Spam-Status: No, score=-3.9 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI, RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_NONE shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by dcvr.yhbt.net (Postfix) with ESMTP id 389871F60F for ; Sun, 5 Apr 2020 20:16:56 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727779AbgDEUQz (ORCPT ); Sun, 5 Apr 2020 16:16:55 -0400 Received: from mail-wm1-f67.google.com ([209.85.128.67]:51025 "EHLO mail-wm1-f67.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727444AbgDEUQy (ORCPT ); Sun, 5 Apr 2020 16:16:54 -0400 Received: by mail-wm1-f67.google.com with SMTP id x25so1567560wmc.0 for ; Sun, 05 Apr 2020 13:16:52 -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=mvoM5/GcQipnc8y5cLDIFcdDrYFJyt/pYp42NjEvE2c=; b=iI1FMQnBqguK3lap9ryj49MMmMkgpINJwQSbpq0veqJfrloq4O3A0EUNmDguQO/0Ws SIsPcdowhPSMVwEyyG7IXOEGaXBtpzjiN7siePXtiziv2trXKGWrgyt46Uluapdb4H4F rwca8jTaEMIt2Nxj7PGSjX8uudpxH4xFahsDajFpJL+s9IVzV0IBFQTyNaMclBWfX32q q7X01AFhjVcy9086xUx8Ttr2tZAsgpfMqFGhidRFjtamdqVUnmjtTmDorLnILOBE8KM6 ofL+BjG/0tPupgQDcF+HCcQoiPDB/cuo5PTUCKpNdfgPFBRUrWfgDIQC5aQHL/DlPuiW pJ7w== 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=mvoM5/GcQipnc8y5cLDIFcdDrYFJyt/pYp42NjEvE2c=; b=U59DOvVQJZ+E6FVQnbNN7WVThtpw/3e9n51F1MWq/St2BtQq7LbJOUkP1PZbDclmni iiT3yNNOPyoQ0knbgBIODo8W6KXz0VK9LAuGpoQjBFBZJfjLe4kATQabIi05k5UTvtRK 0RauksERqpeCz1aeB7NDguuKNVfp3vz1uvl5zAQGtMcAmwml3310SmiGP2FukEaVs7fa 3iFPk2ppCezY5y1A9FID2O2bvYfuHXTBbSytj0ZsUejYhygoQCKqf3ntB1lYYPo03jD0 h5xEeUchieIBDFRKDbSJN9TacCKHxxa8WzfBWzKlloM3t+EUbvQdzotOzbjKnVBI6fEX IPXw== X-Gm-Message-State: AGi0PuY7bZQ+jrVato4xN33YbBdNWTn0Lj8HpgO2Z4rHaQcfWN35dfD4 vxL/2w3BKm7Ka26khMtZ4EWGAc4wACrzSA== X-Google-Smtp-Source: APiQypId/eswA9S1vR7F2X++0YYcJW0rgIXZm2V93I7n+AQiAS+7SzQ7Q0iIukHoIAiX6d9u63vURw== X-Received: by 2002:a7b:cb86:: with SMTP id m6mr1717640wmi.64.1586117811284; Sun, 05 Apr 2020 13:16:51 -0700 (PDT) Received: from localhost.localdomain (87-231-246-247.rev.numericable.fr. [87.231.246.247]) by smtp.gmail.com with ESMTPSA id d7sm22468921wrr.77.2020.04.05.13.16.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 05 Apr 2020 13:16:50 -0700 (PDT) From: Damien Robert X-Google-Original-From: Damien Robert To: git@vger.kernel.org, Philippe Blain Cc: Damien Robert Subject: [PATCH v5 2/5] doc: document --recurse-submodules for reset and restore Date: Sun, 5 Apr 2020 22:16:30 +0200 Message-Id: <20200405201633.704987-3-damien.olivier.robert+git@gmail.com> X-Mailer: git-send-email 2.26.0 In-Reply-To: <20200405201633.704987-1-damien.olivier.robert+git@gmail.com> References: <20200405201633.704987-1-damien.olivier.robert+git@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Also unify the formulation about --no-recurse-submodules for checkout and switch, which we reuse for restore. And correct the formulation about submodules' HEAD in read-tree, which we reuse in reset. Signed-off-by: Damien Robert --- Documentation/git-checkout.txt | 2 +- Documentation/git-read-tree.txt | 2 +- Documentation/git-reset.txt | 6 ++++++ Documentation/git-restore.txt | 11 +++++++++++ Documentation/git-switch.txt | 2 +- 5 files changed, 20 insertions(+), 3 deletions(-) diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index c8fb995fa7..140bd3eabb 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -296,7 +296,7 @@ Note that this option uses the no overlay mode by default (see also 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`) - is used, the work trees of submodules will not be updated. + is used, submodules working trees will not be updated. Just like linkgit:git-submodule[1], this will detach `HEAD` of the submodule. diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index da33f84f33..501f2ec375 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -118,7 +118,7 @@ OPTIONS --[no-]recurse-submodules:: Using --recurse-submodules will update the content of all initialized submodules according to the commit recorded in the superproject by - calling read-tree recursively, also setting the submodules HEAD to be + calling read-tree recursively, also setting the submodules' HEAD to be detached at that commit. --no-sparse-checkout:: diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index 932080c55d..252e2d4e47 100644 --- a/Documentation/git-reset.txt +++ b/Documentation/git-reset.txt @@ -87,6 +87,12 @@ but carries forward unmerged index entries. different between `` and `HEAD`. If a file that is different between `` and `HEAD` has local changes, reset is aborted. + +--[no-]recurse-submodules:: + When the working tree is updated, using --recurse-submodules will + also recursively reset the working tree of all active submodules + according to the commit recorded in the superproject, also setting + the submodules' HEAD to be detached at that commit. -- See "Reset, restore and revert" in linkgit:git[1] for the differences diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt index 5bf60d4943..8e3b339802 100644 --- a/Documentation/git-restore.txt +++ b/Documentation/git-restore.txt @@ -107,6 +107,17 @@ in linkgit:git-checkout[1] for details. patterns and unconditionally restores any files in ``. +--recurse-submodules:: +--no-recurse-submodules:: + If `` names an active submodule and the restore location + includes the working tree, the submodule will only be updated if + this option is given, in which case its working tree will be + restored to the commit recorded in the superproject, and any local + modifications overwritten. If nothing (or + `--no-recurse-submodules`) is used, submodules working trees will + not be updated. Just like linkgit:git-checkout[1], this will detach + `HEAD` of the submodule. + --overlay:: --no-overlay:: In overlay mode, the command never removes files when diff --git a/Documentation/git-switch.txt b/Documentation/git-switch.txt index 197900363b..79dbc9624d 100644 --- a/Documentation/git-switch.txt +++ b/Documentation/git-switch.txt @@ -183,7 +183,7 @@ name, the guessing is aborted. You can explicitly give a name with Using `--recurse-submodules` will update the content of all initialized submodules according to the commit recorded in the superproject. If nothing (or `--no-recurse-submodules`) is - used, the work trees of submodules will not be updated. Just + used, submodules working trees will not be updated. Just like linkgit:git-submodule[1], this will detach `HEAD` of the submodules. -- Patched on top of v2.26.0-106-g9fadedd637 (git version 2.26.0)