Skip to content

Commit 0d07e98

Browse files
committed
Merge branch 'wk/doc-in-linux-3.x-era'
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
2 parents 534f0e0 + 283efb0 commit 0d07e98

File tree

6 files changed

+47
-41
lines changed

6 files changed

+47
-41
lines changed

Documentation/git-clone.txt

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -239,8 +239,8 @@ Examples
239239
* Clone from upstream:
240240
+
241241
------------
242-
$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
243-
$ cd my2.6
242+
$ git clone git://git.kernel.org/pub/scm/.../linux.git my-linux
243+
$ cd my-linux
244244
$ make
245245
------------
246246

@@ -257,10 +257,10 @@ $ git show-branch
257257
* Clone from upstream while borrowing from an existing local directory:
258258
+
259259
------------
260-
$ git clone --reference my2.6 \
261-
git://git.kernel.org/pub/scm/.../linux-2.7 \
262-
my2.7
263-
$ cd my2.7
260+
$ git clone --reference /git/linux.git \
261+
git://git.kernel.org/pub/scm/.../linux.git \
262+
my-linux
263+
$ cd my-linux
264264
------------
265265

266266

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

273273

274-
* Create a repository on the kernel.org machine that borrows from Linus:
275-
+
276-
------------
277-
$ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \
278-
/pub/scm/.../me/subsys-2.6.git
279-
------------
280-
281274
GIT
282275
---
283276
Part of the linkgit:git[1] suite

Documentation/git-fast-export.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Limitations
141141
-----------
142142

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

147147
GIT

Documentation/git-remote.txt

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -187,18 +187,25 @@ Examples
187187
$ git remote
188188
origin
189189
$ git branch -r
190-
origin/master
191-
$ git remote add linux-nfs git://linux-nfs.org/pub/linux/nfs-2.6.git
190+
origin/HEAD -> origin/master
191+
origin/master
192+
$ git remote add staging git://git.kernel.org/.../gregkh/staging.git
192193
$ git remote
193-
linux-nfs
194194
origin
195-
$ git fetch
196-
* refs/remotes/linux-nfs/master: storing branch 'master' ...
197-
commit: bf81b46
195+
staging
196+
$ git fetch staging
197+
...
198+
From git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging
199+
* [new branch] master -> staging/master
200+
* [new branch] staging-linus -> staging/staging-linus
201+
* [new branch] staging-next -> staging/staging-next
198202
$ git branch -r
199-
origin/master
200-
linux-nfs/master
201-
$ git checkout -b nfs linux-nfs/master
203+
origin/HEAD -> origin/master
204+
origin/master
205+
staging/master
206+
staging/staging-linus
207+
staging/staging-next
208+
$ git checkout -b staging staging/master
202209
...
203210
------------
204211

Documentation/technical/racy-git.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,9 @@ them, and give the same timestamp to the index file:
135135
$ git ls-files | git update-index --stdin
136136
$ touch -r .datestamp .git/index
137137

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

142142
$ /usr/bin/time git diff-files
143143
1.68user 0.54system 0:02.22elapsed 100%CPU (0avgtext+0avgdata 0maxresident)k

Documentation/user-manual.txt

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
6666
The initial clone may be time-consuming for a large project, but you
6767
will only need to clone once.
6868

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

433433
-------------------------------------------------
434-
$ git remote add linux-nfs git://linux-nfs.org/pub/nfs-2.6.git
435-
$ git fetch linux-nfs
436-
* refs/remotes/linux-nfs/master: storing branch 'master' ...
437-
commit: bf81b46
434+
$ git remote add staging git://git.kernel.org/.../gregkh/staging.git
435+
$ git fetch staging
436+
...
437+
From git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging
438+
* [new branch] master -> staging/master
439+
* [new branch] staging-linus -> staging/staging-linus
440+
* [new branch] staging-next -> staging/staging-next
438441
-------------------------------------------------
439442

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

443446
-------------------------------------------------
444447
$ git branch -r
445-
linux-nfs/master
446-
origin/master
448+
origin/HEAD -> origin/master
449+
origin/master
450+
staging/master
451+
staging/staging-linus
452+
staging/staging-next
447453
-------------------------------------------------
448454

449455
If you run `git fetch <remote>` later, the remote-tracking branches
@@ -455,9 +461,9 @@ a new stanza:
455461
-------------------------------------------------
456462
$ cat .git/config
457463
...
458-
[remote "linux-nfs"]
459-
url = git://linux-nfs.org/pub/nfs-2.6.git
460-
fetch = +refs/heads/*:refs/remotes/linux-nfs/*
464+
[remote "staging"]
465+
url = git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging.git
466+
fetch = +refs/heads/*:refs/remotes/staging/*
461467
...
462468
-------------------------------------------------
463469

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

21582164
-------------------------------------------------
2159-
$ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git work
2165+
$ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git work
21602166
$ cd work
21612167
-------------------------------------------------
21622168

@@ -2198,7 +2204,7 @@ make it easy to push both branches to your public tree. (See
21982204
-------------------------------------------------
21992205
$ cat >> .git/config <<EOF
22002206
[remote "mytree"]
2201-
url = master.kernel.org:/pub/scm/linux/kernel/git/aegl/linux-2.6.git
2207+
url = master.kernel.org:/pub/scm/linux/kernel/git/aegl/linux.git
22022208
push = release
22032209
push = test
22042210
EOF

t/perf/README

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ You can set the following variables (also in your config.mak):
6666
GIT_PERF_LARGE_REPO
6767
Repositories to copy for the performance tests. The normal
6868
repo should be at least git.git size. The large repo should
69-
probably be about linux-2.6.git size for optimal results.
69+
probably be about linux.git size for optimal results.
7070
Both default to the git.git you are running from.
7171

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

0 commit comments

Comments
 (0)