Skip to content

Commit

Permalink
Merge branch 'wk/doc-in-linux-3.x-era'
Browse files Browse the repository at this point in the history
Update documentation to match more recent realities.

* wk/doc-in-linux-3.x-era:
  Documentation: Update 'linux-2.6.git' -> 'linux.git'
  Documentation: Update the NFS remote examples to use the staging repo
  doc/clone: Pick more compelling paths for the --reference example
  doc/clone: Remove the '--bare -l -s' example
  • Loading branch information
Junio C Hamano committed Jul 1, 2013
2 parents 534f0e0 + 283efb0 commit 0d07e98
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 41 deletions.
19 changes: 6 additions & 13 deletions Documentation/git-clone.txt
Original file line number Diff line number Diff line change
Expand Up @@ -239,8 +239,8 @@ Examples
* Clone from upstream:
+
------------
$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
$ cd my2.6
$ git clone git://git.kernel.org/pub/scm/.../linux.git my-linux
$ cd my-linux
$ make
------------

Expand All @@ -257,10 +257,10 @@ $ git show-branch
* Clone from upstream while borrowing from an existing local directory:
+
------------
$ git clone --reference my2.6 \
git://git.kernel.org/pub/scm/.../linux-2.7 \
my2.7
$ cd my2.7
$ git clone --reference /git/linux.git \
git://git.kernel.org/pub/scm/.../linux.git \
my-linux
$ cd my-linux
------------


Expand All @@ -271,13 +271,6 @@ $ git clone --bare -l /home/proj/.git /pub/scm/proj.git
------------


* Create a repository on the kernel.org machine that borrows from Linus:
+
------------
$ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \
/pub/scm/.../me/subsys-2.6.git
------------

GIT
---
Part of the linkgit:git[1] suite
2 changes: 1 addition & 1 deletion Documentation/git-fast-export.txt
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Limitations
-----------

Since 'git fast-import' cannot tag trees, you will not be
able to export the linux-2.6.git repository completely, as it contains
able to export the linux.git repository completely, as it contains
a tag referencing a tree instead of a commit.

GIT
Expand Down
25 changes: 16 additions & 9 deletions Documentation/git-remote.txt
Original file line number Diff line number Diff line change
Expand Up @@ -187,18 +187,25 @@ Examples
$ git remote
origin
$ git branch -r
origin/master
$ git remote add linux-nfs git://linux-nfs.org/pub/linux/nfs-2.6.git
origin/HEAD -> origin/master
origin/master
$ git remote add staging git://git.kernel.org/.../gregkh/staging.git
$ git remote
linux-nfs
origin
$ git fetch
* refs/remotes/linux-nfs/master: storing branch 'master' ...
commit: bf81b46
staging
$ git fetch staging
...
From git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging
* [new branch] master -> staging/master
* [new branch] staging-linus -> staging/staging-linus
* [new branch] staging-next -> staging/staging-next
$ git branch -r
origin/master
linux-nfs/master
$ git checkout -b nfs linux-nfs/master
origin/HEAD -> origin/master
origin/master
staging/master
staging/staging-linus
staging/staging-next
$ git checkout -b staging staging/master
...
------------

Expand Down
6 changes: 3 additions & 3 deletions Documentation/technical/racy-git.txt
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,9 @@ them, and give the same timestamp to the index file:
$ git ls-files | git update-index --stdin
$ touch -r .datestamp .git/index

This will make all index entries racily clean. The linux-2.6
project, for example, there are over 20,000 files in the working
tree. On my Athlon 64 X2 3800+, after the above:
This will make all index entries racily clean. The linux project, for
example, there are over 20,000 files in the working tree. On my
Athlon 64 X2 3800+, after the above:

$ /usr/bin/time git diff-files
1.68user 0.54system 0:02.22elapsed 100%CPU (0avgtext+0avgdata 0maxresident)k
Expand Down
34 changes: 20 additions & 14 deletions Documentation/user-manual.txt
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
The initial clone may be time-consuming for a large project, but you
will only need to clone once.

The clone command creates a new directory named after the project (`git`
or `linux-2.6` in the examples above). After you cd into this
The clone command creates a new directory named after the project
(`git` or `linux` in the examples above). After you cd into this
directory, you will see that it contains a copy of the project files,
called the <<def_working_tree,working tree>>, together with a special
top-level directory named `.git`, which contains all the information
Expand Down Expand Up @@ -431,19 +431,25 @@ You can also track branches from repositories other than the one you
cloned from, using linkgit:git-remote[1]:

-------------------------------------------------
$ git remote add linux-nfs git://linux-nfs.org/pub/nfs-2.6.git
$ git fetch linux-nfs
* refs/remotes/linux-nfs/master: storing branch 'master' ...
commit: bf81b46
$ git remote add staging git://git.kernel.org/.../gregkh/staging.git
$ git fetch staging
...
From git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging
* [new branch] master -> staging/master
* [new branch] staging-linus -> staging/staging-linus
* [new branch] staging-next -> staging/staging-next
-------------------------------------------------

New remote-tracking branches will be stored under the shorthand name
that you gave `git remote add`, in this case `linux-nfs`:
that you gave `git remote add`, in this case `staging`:

-------------------------------------------------
$ git branch -r
linux-nfs/master
origin/master
origin/HEAD -> origin/master
origin/master
staging/master
staging/staging-linus
staging/staging-next
-------------------------------------------------

If you run `git fetch <remote>` later, the remote-tracking branches
Expand All @@ -455,9 +461,9 @@ a new stanza:
-------------------------------------------------
$ cat .git/config
...
[remote "linux-nfs"]
url = git://linux-nfs.org/pub/nfs-2.6.git
fetch = +refs/heads/*:refs/remotes/linux-nfs/*
[remote "staging"]
url = git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging.git
fetch = +refs/heads/*:refs/remotes/staging/*
...
-------------------------------------------------

Expand Down Expand Up @@ -2156,7 +2162,7 @@ To set this up, first create your work tree by cloning Linus's public
tree:

-------------------------------------------------
$ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git work
$ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git work
$ cd work
-------------------------------------------------

Expand Down Expand Up @@ -2198,7 +2204,7 @@ make it easy to push both branches to your public tree. (See
-------------------------------------------------
$ cat >> .git/config <<EOF
[remote "mytree"]
url = master.kernel.org:/pub/scm/linux/kernel/git/aegl/linux-2.6.git
url = master.kernel.org:/pub/scm/linux/kernel/git/aegl/linux.git
push = release
push = test
EOF
Expand Down
2 changes: 1 addition & 1 deletion t/perf/README
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ You can set the following variables (also in your config.mak):
GIT_PERF_LARGE_REPO
Repositories to copy for the performance tests. The normal
repo should be at least git.git size. The large repo should
probably be about linux-2.6.git size for optimal results.
probably be about linux.git size for optimal results.
Both default to the git.git you are running from.

You can also pass the options taken by ordinary git tests; the most
Expand Down

0 comments on commit 0d07e98

Please sign in to comment.