threads / patch / 10017

patchRemove 'submodules' from the TODO section of the User Manual.

Subject: [PATCH] Remove 'submodules' from the TODO section of the User Manual.

## tl;dr

13 messages between Sep 25, 2007 and Sep 26, 2007. Diffs are folded; open one to read it.

replies: 12people: 3as markdown or json

Miklos Vajna· Sep 25, 2007, 19:11 UTC · lore
A chapter about this topic has been added recently.
Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---

i forgot to include this change in my previous patch, so here is the correction.

 Documentation/user-manual.txt |    2 --
 1 files changed, 0 insertions(+), 2 deletions(-)
Show changes to Documentation/user-manual.txt +0 −2
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index a085ca1..e4b04d0 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -4277,5 +4277,3 @@ Write a chapter on using plumbing and writing scripts.
 Alternates, clone -reference, etc.
 
 git unpack-objects -r for recovery
-
-submodules
-- 
1.5.3.2.80.g077d6f-dirty
J. Bruce Fields· Sep 25, 2007, 19:23 UTC · re: Miklos Vajna · lore

Re: [PATCH] Remove 'submodules' from the TODO section of the User Manual.

On Tue, Sep 25, 2007 at 09:11:59PM +0200, Miklos Vajna wrote:
> A chapter about this topic has been added recently.

Thanks, but it looks like Michael Smith already included this in his latest patch:

	http://marc.info/?l=git&m=119072428615724&w=2
--b.
Miklos Vajna· Sep 25, 2007, 19:47 UTC · re: J. Bruce Fields · lore

Re: [PATCH] Remove 'submodules' from the TODO section of the User Manual.

On Tue, Sep 25, 2007 at 03:23:15PM -0400, "J. Bruce Fields" <bfields@fieldses.org> wrote:
> Thanks, but it looks like Michael Smith already included this in his
> latest patch:
> 
> 	http://marc.info/?l=git&m=119072428615724&w=2
ah, my bad. i missed that. sorry for the noise :)
- VMiklos
J. Bruce Fields· Sep 25, 2007, 19:49 UTC · re: Miklos Vajna · lore

Re: [PATCH] Remove 'submodules' from the TODO section of the User Manual.

On Tue, Sep 25, 2007 at 09:47:45PM +0200, Miklos Vajna wrote:
Show 7 quoted lines
> On Tue, Sep 25, 2007 at 03:23:15PM -0400, "J. Bruce Fields" <bfields@fieldses.org> wrote:
> > Thanks, but it looks like Michael Smith already included this in his
> > latest patch:
> > 
> > 	http://marc.info/?l=git&m=119072428615724&w=2
> 
> ah, my bad. i missed that. sorry for the noise :)
No problem.

And there's a ton of other stuff on that todo list if you're looking to make more "noise"--patches always welcomed....

--b.
Miklos Vajna· Sep 25, 2007, 19:57 UTC · re: J. Bruce Fields · lore

Re: [PATCH] Remove 'submodules' from the TODO section of the User Manual.

On Tue, Sep 25, 2007 at 03:49:36PM -0400, "J. Bruce Fields" <bfields@fieldses.org> wrote:
> And there's a ton of other stuff on that todo list if you're looking to
> make more "noise"--patches always welcomed....
i was this in the todo:

"Add a section on working with other version control systems, including CVS, Subversion, and just imports of series of release tarballs."

to questions:
1) does this include documentation about git-svn? i mean a howto similar
to the submodules chapter.
2) does it worth to document a typical usage of tailor? we used it a lot
when converting from darcs to git and once you figure out the right
options, it's really easy to use it. but maybe it's unrelated.
thanks,
- VMiklos
J. Bruce Fields· Sep 25, 2007, 20:02 UTC · re: Miklos Vajna · lore

Re: [PATCH] Remove 'submodules' from the TODO section of the User Manual.

On Tue, Sep 25, 2007 at 09:57:31PM +0200, Miklos Vajna wrote:
Show 9 quoted lines
> i was this in the todo:
> 
> "Add a section on working with other version control systems, including
> CVS, Subversion, and just imports of series of release tarballs."
> 
> to questions:
> 
> 1) does this include documentation about git-svn? i mean a howto similar
> to the submodules chapter.

Could be. Though when I used it I thought the git-svn manpage was actually very good, so I'd be tempted to just point to that.

> 2) does it worth to document a typical usage of tailor? we used it a lot
> when converting from darcs to git and once you figure out the right
> options, it's really easy to use it. but maybe it's unrelated.

I think we should try to keep the git documentation mostly confined to tools that are distributed with git itself. So it might be worth a few words just to mention the existance of tailor and how it compares to other tools, but I'd leave it at that.

--b.
J. Bruce Fields· Sep 25, 2007, 20:13 UTC · re: J. Bruce Fields · lore

Re: [PATCH] Remove 'submodules' from the TODO section of the User Manual.

On Tue, Sep 25, 2007 at 04:02:52PM -0400, bfields wrote:
> I think we should try to keep the git documentation mostly confined to
> tools that are distributed with git itself.  So it might be worth a few
> words just to mention the existance of tailor and how it compares to
> other tools, but I'd leave it at that.

So in fact it might be that what's needed isn't any new documentation on the available tools with their features and limitations.

I know that when I recently had to deal with a svn tree the hardest part was figuring out where to start (git-svn? git-svnimport?). I seem to recall threads here suggesting this is a general problem.

One exception--the "series of tarballs" thing--I think it's cool that you can just unpack a bunch of tarballs and string them together into a git history. It gives a good sense of how git works, and I don't think it's documented explicitly anywhere. I think that might be kinda fun to write up. But I haven't tried.

--b.
J. Bruce Fields· Sep 25, 2007, 20:16 UTC · re: J. Bruce Fields · lore

Re: [PATCH] Remove 'submodules' from the TODO section of the User Manual.

On Tue, Sep 25, 2007 at 04:13:06PM -0400, J. Bruce Fields wrote:
Show 8 quoted lines
> On Tue, Sep 25, 2007 at 04:02:52PM -0400, bfields wrote:
> > I think we should try to keep the git documentation mostly confined to
> > tools that are distributed with git itself.  So it might be worth a few
> > words just to mention the existance of tailor and how it compares to
> > other tools, but I'd leave it at that.
> 
> So in fact it might be that what's needed isn't any new documentation on
> the available tools with their features and limitations.

(Uh, I meant to say: "isn't any new documentation on individual tools, but rather a list of the available tools with their features and limitations.")

Show 16 quoted lines
> 
> I know that when I recently had to deal with a svn tree the hardest part
> was figuring out where to start (git-svn?  git-svnimport?).  I seem to
> recall threads here suggesting this is a general problem.
> 
> One exception--the "series of tarballs" thing--I think it's cool that
> you can just unpack a bunch of tarballs and string them together into a
> git history.  It gives a good sense of how git works, and I don't think
> it's documented explicitly anywhere.  I think that might be kinda fun to
> write up.  But I haven't tried.
> 
> --b.
> -
> To unsubscribe from this list: send the line "unsubscribe git" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
Miklos Vajna· Sep 25, 2007, 22:37 UTC · re: J. Bruce Fields · lore

[PATCH] User Manual: document import-tars.perl

Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---
On Tue, Sep 25, 2007 at 04:13:06PM -0400, "J. Bruce Fields" <bfields@fieldses.org> wrote:
Show 5 quoted lines
> One exception--the "series of tarballs" thing--I think it's cool that
> you can just unpack a bunch of tarballs and string them together into a
> git history.  It gives a good sense of how git works, and I don't think
> it's documented explicitly anywhere.  I think that might be kinda fun to
> write up.  But I haven't tried.
something like this?
VMiklos
 Documentation/user-manual.txt |   13 +++++++++++++
 1 files changed, 13 insertions(+), 0 deletions(-)
Show changes to Documentation/user-manual.txt +13 −0
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index a085ca1..f722932 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -978,6 +978,19 @@ $ git add . # include everything below ./ in the first commit:
 $ git commit
 -------------------------------------------------
 
+If you already have a series of tarballs (typically previous releases without
+using a version control system):
+
+-------------------------------------------------
+$ mkdir project
+$ cd project
+$ git init
+$ perl import-tars.perl /path/to/tarballs/*.tar.bz2
+$ git checkout import-tars
+-------------------------------------------------
+
+You can find `import-tars.perl` in the `contrib/fast-import/` directory.
+
 [[how-to-make-a-commit]]
 How to make a commit
 --------------------
-- 
1.5.3.2.80.g077d6f-dirty
J. Bruce Fields· Sep 26, 2007, 18:14 UTC · re: Miklos Vajna · lore

Re: [PATCH] User Manual: document import-tars.perl

On Wed, Sep 26, 2007 at 12:37:04AM +0200, Miklos Vajna wrote:
Show 11 quoted lines
> Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
> ---
> 
> On Tue, Sep 25, 2007 at 04:13:06PM -0400, "J. Bruce Fields" <bfields@fieldses.org> wrote:
> > One exception--the "series of tarballs" thing--I think it's cool that
> > you can just unpack a bunch of tarballs and string them together into a
> > git history.  It gives a good sense of how git works, and I don't think
> > it's documented explicitly anywhere.  I think that might be kinda fun to
> > write up.  But I haven't tried.
> 
> something like this?
Neat-o, I'd missed (or forgotten about) import-tars.perl.

But I'd prefer to keep this first explanation of how to initialize and commit to a new project pretty streamlined, and I don't think this is really necessary here. So let's save this up until we have enough material for a separate chapter or section on interacting with other scm's.

--b.
Show 33 quoted lines
> 
> VMiklos
> 
>  Documentation/user-manual.txt |   13 +++++++++++++
>  1 files changed, 13 insertions(+), 0 deletions(-)
> 
> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
> index a085ca1..f722932 100644
> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -978,6 +978,19 @@ $ git add . # include everything below ./ in the first commit:
>  $ git commit
>  -------------------------------------------------
>  
> +If you already have a series of tarballs (typically previous releases without
> +using a version control system):
> +
> +-------------------------------------------------
> +$ mkdir project
> +$ cd project
> +$ git init
> +$ perl import-tars.perl /path/to/tarballs/*.tar.bz2
> +$ git checkout import-tars
> +-------------------------------------------------
> +
> +You can find `import-tars.perl` in the `contrib/fast-import/` directory.
> +
>  [[how-to-make-a-commit]]
>  How to make a commit
>  --------------------
> -- 
> 1.5.3.2.80.g077d6f-dirty
> 
Miklos Vajna· Sep 26, 2007, 18:22 UTC · re: J. Bruce Fields · lore

Re: [PATCH] User Manual: document import-tars.perl

On Wed, Sep 26, 2007 at 02:14:51PM -0400, "J. Bruce Fields" <bfields@fieldses.org> wrote:
Show 7 quoted lines
> Neat-o, I'd missed (or forgotten about) import-tars.perl.
> 
> But I'd prefer to keep this first explanation of how to initialize and
> commit to a new project pretty streamlined, and I don't think this is
> really necessary here.  So let's save this up until we have enough
> material for a separate chapter or section on interacting with other
> scm's.
okay, now it's saved by gmane :)
- VMiklos
J. Bruce Fields· Sep 26, 2007, 20:37 UTC · re: Miklos Vajna · lore

Re: [PATCH] User Manual: document import-tars.perl

On Wed, Sep 26, 2007 at 08:22:04PM +0200, Miklos Vajna wrote:
Show 10 quoted lines
> On Wed, Sep 26, 2007 at 02:14:51PM -0400, "J. Bruce Fields" <bfields@fieldses.org> wrote:
> > Neat-o, I'd missed (or forgotten about) import-tars.perl.
> > 
> > But I'd prefer to keep this first explanation of how to initialize and
> > commit to a new project pretty streamlined, and I don't think this is
> > really necessary here.  So let's save this up until we have enough
> > material for a separate chapter or section on interacting with other
> > scm's.
> 
> okay, now it's saved by gmane :)

Also in my git tree--I took yours and Johannes' suggestions, put them in a blender, and added a brief skeleton of a new chapter at:

	git://linux-nfs.org/~bfields/git.git docwork-foreign-scms
--b.
Johannes Schindelin· Sep 26, 2007, 19:58 UTC · re: J. Bruce Fields · lore

Re: [PATCH] User Manual: document import-tars.perl

Hi,
On Wed, 26 Sep 2007, J. Bruce Fields wrote:
Show 14 quoted lines
> On Wed, Sep 26, 2007 at 12:37:04AM +0200, Miklos Vajna wrote:
> > Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
> > ---
> > 
> > On Tue, Sep 25, 2007 at 04:13:06PM -0400, "J. Bruce Fields" <bfields@fieldses.org> wrote:
> > > One exception--the "series of tarballs" thing--I think it's cool that
> > > you can just unpack a bunch of tarballs and string them together into a
> > > git history.  It gives a good sense of how git works, and I don't think
> > > it's documented explicitly anywhere.  I think that might be kinda fun to
> > > write up.  But I haven't tried.
> > 
> > something like this?
> 
> Neat-o, I'd missed (or forgotten about) import-tars.perl.
You should also mention
$ mkdir my-new-repo
$ cd my-new-repo
$ git init
$ for z in /blub/*.zip
  do
	rm -rf * 2> /dev/null &&
	unzip "$z" &&
	git add . &&
	git commit -m "$z" ||
	break
  done

import-tars.pl is much faster than this, of course, when it comes to tars, but it has no clue about other archive formats.

Ciao, Dscho

← back to recent threads