From: Junio C Hamano <gitster@pobox•com>
To: Jens Lehmann <Jens.Lehmann@web•de>
Cc: Matthijs Kooijman <matthijs@stdin•nl>,
git@vger•kernel.org, Heiko Voigt <hvoigt@hvoigt•net>
Subject: Re: [PATCH] submodule update: document the '--checkout' option
Date: Fri, 28 Feb 2014 13:39:32 -0800 [thread overview]
Message-ID: <xmqqbnxqudbf.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <530FB5C4.8080400@web.de> (Jens Lehmann's message of "Thu, 27 Feb 2014 22:01:40 +0000")
Jens Lehmann <Jens.Lehmann@web•de> writes:
> Good point. What about this?
>
>
> Documentation/git-submodule.txt | 13 +++++++++++--
> git-submodule.sh | 2 +-
> 2 files changed, 12 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
> index bfef8a0..9054217 100644
> --- a/Documentation/git-submodule.txt
> +++ b/Documentation/git-submodule.txt
> @@ -15,8 +15,8 @@ SYNOPSIS
> 'git submodule' [--quiet] init [--] [<path>...]
> 'git submodule' [--quiet] deinit [-f|--force] [--] <path>...
> 'git submodule' [--quiet] update [--init] [--remote] [-N|--no-fetch]
> - [-f|--force] [--rebase] [--reference <repository>] [--depth <depth>]
> - [--merge] [--recursive] [--] [<path>...]
> + [-f|--force] [--checkout|--merge|--rebase] [--reference <repository>]
> + [--depth <depth>] [--recursive] [--] [<path>...]
This has already been done by 23d25e48 (submodule: explicit local
branch creation in module_clone, 2014-01-26). That commit also adds
some text to the description of 'update' subcommand, but not a
separate entry for '--checkout' mode.
Does the result of applying this patch except for this particular
hunk still make sense as a whole? It appears to me that it does,
but just to double check...
Thanks.
> 'git submodule' [--quiet] summary [--cached|--files] [(-n|--summary-limit) <n>]
> [commit] [--] [<path>...]
> 'git submodule' [--quiet] foreach [--recursive] <command>
> @@ -287,6 +287,15 @@ SHA-1. If you don't want to fetch, you should use `submodule update
> This option is only valid for the update command.
> Don't fetch new objects from the remote site.
>
> +--checkout::
> + This option is only valid for the update command.
> + Checkout the commit recorded in the superproject on a detached HEAD
> + in the submodule. This is the default behavior, the main use of
> + this option is to override `submodule.$name.update` when set to
> + `merge`, `rebase` or `none`.
> + If the key `submodule.$name.update` is either not explicitly set or
> + set to `checkout`, this option is implicit.
> +
> --merge::
> This option is only valid for the update command.
> Merge the commit recorded in the superproject into the current branch
> diff --git a/git-submodule.sh b/git-submodule.sh
> index 4a30087..65cf963 100755
> --- a/git-submodule.sh
> +++ b/git-submodule.sh
> @@ -9,7 +9,7 @@ USAGE="[--quiet] add [-b <branch>] [-f|--force] [--name <name>] [--reference <re
> or: $dashless [--quiet] status [--cached] [--recursive] [--] [<path>...]
> or: $dashless [--quiet] init [--] [<path>...]
> or: $dashless [--quiet] deinit [-f|--force] [--] <path>...
> - or: $dashless [--quiet] update [--init] [--remote] [-N|--no-fetch] [-f|--force] [--rebase] [--reference <repository>] [--merge] [--recursive] [--] [<path>...]
> + or: $dashless [--quiet] update [--init] [--remote] [-N|--no-fetch] [-f|--force] [--checkout|--merge|--rebase] [--reference <repository>] [--recursive] [--] [<path>...]
> or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
> or: $dashless [--quiet] foreach [--recursive] <command>
> or: $dashless [--quiet] sync [--recursive] [--] [<path>...]"
next prev parent reply other threads:[~2014-02-28 21:39 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-02-25 11:03 git submodule manpage does not document --checkout Matthijs Kooijman
2014-02-27 22:01 ` [PATCH] submodule update: document the '--checkout' option Jens Lehmann
2014-02-28 21:39 ` Junio C Hamano [this message]
2014-02-28 22:41 ` [PATCH v2] submodule update: consistently " Jens Lehmann
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqbnxqudbf.fsf@gitster.dls.corp.google.com \
--to=gitster@pobox$(echo .)com \
--cc=Jens.Lehmann@web$(echo .)de \
--cc=git@vger$(echo .)kernel.org \
--cc=hvoigt@hvoigt$(echo .)net \
--cc=matthijs@stdin$(echo .)nl \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox