Skip to content

Commit 7e3e80a

Browse files
committed
Merge branch 'ss/user-manual'
Drop a few old "todo" items by deciding that the change one of them suggests is not such a good idea, and doing the change the other one suggested to do. * ss/user-manual: user-manual: add addition gitweb information user-manual: add section documenting shallow clones glossary: define the term shallow clone user-manual: remove temporary branch entry from todo list
2 parents 5135d1c + 99487cf commit 7e3e80a

File tree

2 files changed

+36
-10
lines changed

2 files changed

+36
-10
lines changed

Documentation/glossary-content.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -531,6 +531,11 @@ The most notable example is `HEAD`.
531531
"Secure Hash Algorithm 1"; a cryptographic hash function.
532532
In the context of Git used as a synonym for <<def_object_name,object name>>.
533533

534+
[[def_shallow_clone]]shallow clone::
535+
Mostly a synonym to <<def_shallow_repository,shallow repository>>
536+
but the phrase makes it more explicit that it was created by
537+
running `git clone --depth=...` command.
538+
534539
[[def_shallow_repository]]shallow repository::
535540
A shallow <<def_repository,repository>> has an incomplete
536541
history some of whose <<def_commit,commits>> have <<def_parent,parents>> cauterized away (in other

Documentation/user-manual.txt

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2125,8 +2125,37 @@ Allowing web browsing of a repository
21252125
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21262126

21272127
The gitweb cgi script provides users an easy way to browse your
2128-
project's files and history without having to install Git; see the file
2129-
gitweb/INSTALL in the Git source tree for instructions on setting it up.
2128+
project's revisions, file contents and logs without having to install
2129+
Git. Features like RSS/Atom feeds and blame/annotation details may
2130+
optionally be enabled.
2131+
2132+
The linkgit:git-instaweb[1] command provides a simple way to start
2133+
browsing the repository using gitweb. The default server when using
2134+
instaweb is lighttpd.
2135+
2136+
See the file gitweb/INSTALL in the Git source tree and
2137+
linkgit:gitweb[1] for instructions on details setting up a permament
2138+
installation with a CGI or Perl capable server.
2139+
2140+
[[how-to-get-a-git-repository-with-minimal-history]]
2141+
How to get a Git repository with minimal history
2142+
------------------------------------------------
2143+
2144+
A <<def_shallow_clone,shallow clone>>, with its truncated
2145+
history, is useful when one is interested only in recent history
2146+
of a project and getting full history from the upstream is
2147+
expensive.
2148+
2149+
A <<def_shallow_clone,shallow clone>> is created by specifying
2150+
the linkgit:git-clone[1] `--depth` switch. The depth can later be
2151+
changed with the linkgit:git-fetch[1] `--depth` switch, or full
2152+
history restored with `--unshallow`.
2153+
2154+
Merging inside a <<def_shallow_clone,shallow clone>> will work as long
2155+
as a merge base is in the recent history.
2156+
Otherwise, it will be like merging unrelated histories and may
2157+
have to result in huge conflicts. This limitation may make such
2158+
a repository unsuitable to be used in merge based workflows.
21302159

21312160
[[sharing-development-examples]]
21322161
Examples
@@ -4636,23 +4665,15 @@ Scan email archives for other stuff left out
46364665
Scan man pages to see if any assume more background than this manual
46374666
provides.
46384667

4639-
Simplify beginning by suggesting disconnected head instead of
4640-
temporary branch creation?
4641-
46424668
Add more good examples. Entire sections of just cookbook examples
46434669
might be a good idea; maybe make an "advanced examples" section a
46444670
standard end-of-chapter section?
46454671

46464672
Include cross-references to the glossary, where appropriate.
46474673

4648-
Document shallow clones? See draft 1.5.0 release notes for some
4649-
documentation.
4650-
46514674
Add a section on working with other version control systems, including
46524675
CVS, Subversion, and just imports of series of release tarballs.
46534676

4654-
More details on gitweb?
4655-
46564677
Write a chapter on using plumbing and writing scripts.
46574678

46584679
Alternates, clone -reference, etc.

0 commit comments

Comments
 (0)