* [PATCH] Add --reference option to git submodule
@ 2009-04-28 6:52 Michael S. Tsirkin
2009-04-28 11:10 ` Michael J Gruber
0 siblings, 1 reply; 5+ messages in thread
From: Michael S. Tsirkin @ 2009-04-28 6:52 UTC (permalink / raw)
To: git; +Cc: Junio C Hamano
This adds --reference option to 'git submodule add' and
'git submodule update' commands, which is passed on to git clone.
This option is useful when the submodule is large, such as linux kernel.
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
---
I noticed that there's no easy way to specify a reference
for submodule repositories. Here's a patch to add this option.
Documentation/git-submodule.txt | 14 ++++++++++++--
git-submodule.sh | 31 ++++++++++++++++++++++++++++---
2 files changed, 40 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 3b8df44..0584cb7 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -9,10 +9,12 @@ git-submodule - Initialize, update or inspect submodules
SYNOPSIS
--------
[verse]
-'git submodule' [--quiet] add [-b branch] [--] <repository> <path>
+'git submodule' [--quiet] add [-b branch]
+ [--reference <repository>] [--] <repository> <path>
'git submodule' [--quiet] status [--cached] [--] [<path>...]
'git submodule' [--quiet] init [--] [<path>...]
-'git submodule' [--quiet] update [--init] [-N|--no-fetch] [--] [<path>...]
+'git submodule' [--quiet] update [--init] [-N|--no-fetch]
+ [--reference <repository>] [--] [<path>...]
'git submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...]
'git submodule' [--quiet] foreach <command>
'git submodule' [--quiet] sync [--] [<path>...]
@@ -177,6 +179,14 @@ OPTIONS
This option is only valid for the update command.
Don't fetch new objects from the remote site.
+--reference <repository>::
+ This option is only valid for add and update commands. These
+ commands sometimes need to clone a remote repository. In this case,
+ this option will be passed to linkgit:git-clone[1] command.
++
+*NOTE*: Do *not* use this option unless you have read the note
+for linkgit:git-clone[1] --reference and --shared options carefully.
+
<path>...::
Paths to submodule(s). When specified this will restrict the command
to only operate on the submodules found at the specified paths.
diff --git a/git-submodule.sh b/git-submodule.sh
index 8e234a4..32be246 100755
--- a/git-submodule.sh
+++ b/git-submodule.sh
@@ -15,6 +15,7 @@ require_work_tree
command=
branch=
quiet=
+reference=
cached=
nofetch=
@@ -91,6 +92,7 @@ module_clone()
{
path=$1
url=$2
+ reference="$3"
# If there already is a directory at the submodule path,
# expect it to be empty (since that is the default checkout
@@ -106,7 +108,12 @@ module_clone()
test -e "$path" &&
die "A file already exist at path '$path'"
- git-clone -n "$url" "$path" ||
+ if test "reference"
+ then
+ git-clone "$reference" -n "$url" "$path"
+ else
+ git-clone -n "$url" "$path"
+ fi ||
die "Clone of '$url' into submodule path '$path' failed"
}
@@ -131,6 +138,15 @@ cmd_add()
-q|--quiet)
quiet=1
;;
+ --reference)
+ case "$2" in '') usage ;; esac
+ reference="--reference=$2"
+ shift
+ ;;
+ --reference=*)
+ reference="$1"
+ shift
+ ;;
--)
shift
break
@@ -203,7 +219,7 @@ cmd_add()
git config submodule."$path".url "$url"
else
- module_clone "$path" "$realrepo" || exit
+ module_clone "$path" "$realrepo" "$reference" || exit
(
unset GIT_DIR
cd "$path" &&
@@ -321,6 +337,15 @@ cmd_update()
shift
nofetch=1
;;
+ --reference)
+ case "$2" in '') usage ;; esac
+ reference="$2"
+ shift 2
+ ;;
+ --reference=*)
+ reference="$1"
+ shift
+ ;;
--)
shift
break
@@ -351,7 +376,7 @@ cmd_update()
if ! test -d "$path"/.git -o -f "$path"/.git
then
- module_clone "$path" "$url" || exit
+ module_clone "$path" "$url" "$reference"|| exit
subsha1=
else
subsha1=$(unset GIT_DIR; cd "$path" &&
--
1.6.3.rc3.dirty
^ permalink raw reply related [flat|nested] 5+ messages in thread* Re: [PATCH] Add --reference option to git submodule
2009-04-28 6:52 [PATCH] Add --reference option to git submodule Michael S. Tsirkin
@ 2009-04-28 11:10 ` Michael J Gruber
2009-04-28 11:25 ` Michael S. Tsirkin
2009-04-28 11:27 ` Michael S. Tsirkin
0 siblings, 2 replies; 5+ messages in thread
From: Michael J Gruber @ 2009-04-28 11:10 UTC (permalink / raw)
To: Michael S. Tsirkin; +Cc: git, Junio C Hamano
Michael S. Tsirkin venit, vidit, dixit 28.04.2009 08:52:
> This adds --reference option to 'git submodule add' and
> 'git submodule update' commands, which is passed on to git clone.
> This option is useful when the submodule is large, such as linux kernel.
>
> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
> ---
>
> I noticed that there's no easy way to specify a reference
> for submodule repositories. Here's a patch to add this option.
Certainly useful. Just a few suggestions:
>
> Documentation/git-submodule.txt | 14 ++++++++++++--
> git-submodule.sh | 31 ++++++++++++++++++++++++++++---
> 2 files changed, 40 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
> index 3b8df44..0584cb7 100644
> --- a/Documentation/git-submodule.txt
> +++ b/Documentation/git-submodule.txt
> @@ -9,10 +9,12 @@ git-submodule - Initialize, update or inspect submodules
> SYNOPSIS
> --------
> [verse]
> -'git submodule' [--quiet] add [-b branch] [--] <repository> <path>
> +'git submodule' [--quiet] add [-b branch]
> + [--reference <repository>] [--] <repository> <path>
> 'git submodule' [--quiet] status [--cached] [--] [<path>...]
> 'git submodule' [--quiet] init [--] [<path>...]
> -'git submodule' [--quiet] update [--init] [-N|--no-fetch] [--] [<path>...]
> +'git submodule' [--quiet] update [--init] [-N|--no-fetch]
> + [--reference <repository>] [--] [<path>...]
> 'git submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...]
> 'git submodule' [--quiet] foreach <command>
> 'git submodule' [--quiet] sync [--] [<path>...]
> @@ -177,6 +179,14 @@ OPTIONS
> This option is only valid for the update command.
> Don't fetch new objects from the remote site.
>
> +--reference <repository>::
> + This option is only valid for add and update commands. These
This option applies only to add...
> + commands sometimes need to clone a remote repository. In this case,
> + this option will be passed to linkgit:git-clone[1] command.
...to the...
> ++
> +*NOTE*: Do *not* use this option unless you have read the note
> +for linkgit:git-clone[1] --reference and --shared options carefully.
...clone[1]\'s --reference...
> +
> <path>...::
> Paths to submodule(s). When specified this will restrict the command
Either "Path(s) to submodule(s)" or "Paths to submodules". I prefer the
latter.
> to only operate on the submodules found at the specified paths.
..to operate on... paths only.
> diff --git a/git-submodule.sh b/git-submodule.sh
> index 8e234a4..32be246 100755
> --- a/git-submodule.sh
> +++ b/git-submodule.sh
> @@ -15,6 +15,7 @@ require_work_tree
> command=
> branch=
> quiet=
> +reference=
> cached=
> nofetch=
>
> @@ -91,6 +92,7 @@ module_clone()
> {
> path=$1
> url=$2
> + reference="$3"
>
> # If there already is a directory at the submodule path,
> # expect it to be empty (since that is the default checkout
> @@ -106,7 +108,12 @@ module_clone()
> test -e "$path" &&
> die "A file already exist at path '$path'"
>
> - git-clone -n "$url" "$path" ||
> + if test "reference"
I'm sure you want to test $reference here. I'm not sure how portable
testing for non-empty without -n is.
> + then
> + git-clone "$reference" -n "$url" "$path"
> + else
> + git-clone -n "$url" "$path"
> + fi ||
> die "Clone of '$url' into submodule path '$path' failed"
> }
>
> @@ -131,6 +138,15 @@ cmd_add()
> -q|--quiet)
> quiet=1
> ;;
> + --reference)
> + case "$2" in '') usage ;; esac
> + reference="--reference=$2"
> + shift
> + ;;
> + --reference=*)
> + reference="$1"
> + shift
> + ;;
> --)
> shift
> break
> @@ -203,7 +219,7 @@ cmd_add()
> git config submodule."$path".url "$url"
> else
>
> - module_clone "$path" "$realrepo" || exit
> + module_clone "$path" "$realrepo" "$reference" || exit
> (
> unset GIT_DIR
> cd "$path" &&
> @@ -321,6 +337,15 @@ cmd_update()
> shift
> nofetch=1
> ;;
> + --reference)
> + case "$2" in '') usage ;; esac
> + reference="$2"
> + shift 2
> + ;;
> + --reference=*)
> + reference="$1"
> + shift
> + ;;
> --)
> shift
> break
> @@ -351,7 +376,7 @@ cmd_update()
>
> if ! test -d "$path"/.git -o -f "$path"/.git
> then
> - module_clone "$path" "$url" || exit
> + module_clone "$path" "$url" "$reference"|| exit
> subsha1=
> else
> subsha1=$(unset GIT_DIR; cd "$path" &&
Cheers,
Michael
^ permalink raw reply [flat|nested] 5+ messages in thread* Re: [PATCH] Add --reference option to git submodule
2009-04-28 11:10 ` Michael J Gruber
@ 2009-04-28 11:25 ` Michael S. Tsirkin
2009-04-28 13:12 ` Michael J Gruber
2009-04-28 11:27 ` Michael S. Tsirkin
1 sibling, 1 reply; 5+ messages in thread
From: Michael S. Tsirkin @ 2009-04-28 11:25 UTC (permalink / raw)
To: Michael J Gruber; +Cc: git, Junio C Hamano
On Tue, Apr 28, 2009 at 01:10:17PM +0200, Michael J Gruber wrote:
> > +
> > <path>...::
> > Paths to submodule(s). When specified this will restrict the command
>
> Either "Path(s) to submodule(s)" or "Paths to submodules". I prefer the
> latter.
>
> > to only operate on the submodules found at the specified paths.
>
> ..to operate on... paths only.
>
I didn't touch these lines, so ... patch?
--
MST
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] Add --reference option to git submodule
2009-04-28 11:25 ` Michael S. Tsirkin
@ 2009-04-28 13:12 ` Michael J Gruber
0 siblings, 0 replies; 5+ messages in thread
From: Michael J Gruber @ 2009-04-28 13:12 UTC (permalink / raw)
To: Michael S. Tsirkin; +Cc: git, Junio C Hamano
Michael S. Tsirkin venit, vidit, dixit 28.04.2009 13:25:
> On Tue, Apr 28, 2009 at 01:10:17PM +0200, Michael J Gruber wrote:
>>> +
>>> <path>...::
>>> Paths to submodule(s). When specified this will restrict the command
>>
>> Either "Path(s) to submodule(s)" or "Paths to submodules". I prefer the
>> latter.
>>
>>> to only operate on the submodules found at the specified paths.
>>
>> ..to operate on... paths only.
>>
>
> I didn't touch these lines, so ... patch?
>
You're right, they were only context (I got hyperactive it seems). It's
better to leave that for an overall style spring clean.
Michael
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] Add --reference option to git submodule
2009-04-28 11:10 ` Michael J Gruber
2009-04-28 11:25 ` Michael S. Tsirkin
@ 2009-04-28 11:27 ` Michael S. Tsirkin
1 sibling, 0 replies; 5+ messages in thread
From: Michael S. Tsirkin @ 2009-04-28 11:27 UTC (permalink / raw)
To: Michael J Gruber; +Cc: git, Junio C Hamano
On Tue, Apr 28, 2009 at 01:10:17PM +0200, Michael J Gruber wrote:
> > @@ -177,6 +179,14 @@ OPTIONS
> > This option is only valid for the update command.
> > Don't fetch new objects from the remote site.
> >
> > +--reference <repository>::
> > + This option is only valid for add and update commands. These
>
> This option applies only to add...
The rest of the documentation has 'is only valid' language.
I guess we need to be consistent? Rewrite these as well?
--
MST
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2009-04-28 13:12 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-04-28 6:52 [PATCH] Add --reference option to git submodule Michael S. Tsirkin
2009-04-28 11:10 ` Michael J Gruber
2009-04-28 11:25 ` Michael S. Tsirkin
2009-04-28 13:12 ` Michael J Gruber
2009-04-28 11:27 ` Michael S. Tsirkin
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).