From 1de2e442af45acf52ad45f9ac86d4c19f6475590 Mon Sep 17 00:00:00 2001 From: "Stephen P. Smith" Date: Mon, 28 Dec 2015 13:16:44 -0700 Subject: user-manual: remove temporary branch entry from todo list In the section on "How to check out a different version of a project" the "new" branch is used as a temporary branch. A detached HEAD was not used since it was a new feature introduced just a couple weeks prior. The section could be changed to use and explain a detached HEAD, except that would increase the learning curve early in the manual. Detached HEADs are discussed a couple sections later under "Examining an old version without creating a new branch". Let's declare that it is a bad idea to rewrite the example that uses a temporary branch to do the sightseeing on a detached HEAD. Signed-off-by: Stephen P. Smith Signed-off-by: Junio C Hamano --- Documentation/user-manual.txt | 3 --- 1 file changed, 3 deletions(-) (limited to 'Documentation') diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 46aa6bc1a..a56a20603 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -4636,9 +4636,6 @@ Scan email archives for other stuff left out Scan man pages to see if any assume more background than this manual provides. -Simplify beginning by suggesting disconnected head instead of -temporary branch creation? - Add more good examples. Entire sections of just cookbook examples might be a good idea; maybe make an "advanced examples" section a standard end-of-chapter section? -- cgit v1.2.1 From bac58749bb2cd04720a4d5a1f58ebc428869f9a2 Mon Sep 17 00:00:00 2001 From: "Stephen P. Smith" Date: Tue, 29 Dec 2015 11:54:35 -0700 Subject: glossary: define the term shallow clone There are several places in the documentation that the term shallow clone is used. Defining the term enables its use elsewhere with a known definition. Signed-off-by: Stephen P. Smith Signed-off-by: Junio C Hamano --- Documentation/glossary-content.txt | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'Documentation') diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt index 4e0b97182..c408d7258 100644 --- a/Documentation/glossary-content.txt +++ b/Documentation/glossary-content.txt @@ -504,6 +504,11 @@ The most notable example is `HEAD`. "Secure Hash Algorithm 1"; a cryptographic hash function. In the context of Git used as a synonym for <>. +[[def_shallow_clone]]shallow clone:: + Mostly a synonym to <> + but the phrase makes it more explicit that it was created by + running `git clone --depth=...` command. + [[def_shallow_repository]]shallow repository:: A shallow <> has an incomplete history some of whose <> have <> cauterized away (in other -- cgit v1.2.1 From 9cfde9ee8f6dc82365f1e977935960f34108076b Mon Sep 17 00:00:00 2001 From: "Stephen P. Smith" Date: Tue, 29 Dec 2015 17:03:50 -0700 Subject: user-manual: add section documenting shallow clones Signed-off-by: Stephen P. Smith Signed-off-by: Junio C Hamano --- Documentation/user-manual.txt | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) (limited to 'Documentation') diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index a56a20603..456457b04 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -2128,6 +2128,26 @@ The gitweb cgi script provides users an easy way to browse your project's files and history without having to install Git; see the file gitweb/INSTALL in the Git source tree for instructions on setting it up. +[[how-to-get-a-git-repository-with-minimal-history]] +How to get a Git repository with minimal history +------------------------------------------------ + +A <>, with its truncated +history, is useful when one is interested only in recent history +of a project and getting full history from the upstream is +expensive. + +A <> is created by specifying +the linkgit:git-clone[1] `--depth` switch. The depth can later be +changed with the linkgit:git-fetch[1] `--depth` switch, or full +history restored with `--unshallow`. + +Merging inside a <> will work as long +as a merge base is in the recent history. +Otherwise, it will be like merging unrelated histories and may +have to result in huge conflicts. This limitation may make such +a repository unsuitable to be used in merge based workflows. + [[sharing-development-examples]] Examples -------- @@ -4642,9 +4662,6 @@ standard end-of-chapter section? Include cross-references to the glossary, where appropriate. -Document shallow clones? See draft 1.5.0 release notes for some -documentation. - Add a section on working with other version control systems, including CVS, Subversion, and just imports of series of release tarballs. -- cgit v1.2.1 From 99487cf228ecba869d2f87f1b55f281fdd1342db Mon Sep 17 00:00:00 2001 From: "Stephen P. Smith" Date: Wed, 30 Dec 2015 16:25:20 -0700 Subject: user-manual: add addition gitweb information Rework the section on gitweb to add information about the cgi script and the instaweb command. Signed-off-by: Stephen P. Smith Signed-off-by: Junio C Hamano --- Documentation/user-manual.txt | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) (limited to 'Documentation') diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 456457b04..2a7d804aa 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -2125,8 +2125,17 @@ Allowing web browsing of a repository ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The gitweb cgi script provides users an easy way to browse your -project's files and history without having to install Git; see the file -gitweb/INSTALL in the Git source tree for instructions on setting it up. +project's revisions, file contents and logs without having to install +Git. Features like RSS/Atom feeds and blame/annotation details may +optionally be enabled. + +The linkgit:git-instaweb[1] command provides a simple way to start +browsing the repository using gitweb. The default server when using +instaweb is lighttpd. + +See the file gitweb/INSTALL in the Git source tree and +linkgit:gitweb[1] for instructions on details setting up a permament +installation with a CGI or Perl capable server. [[how-to-get-a-git-repository-with-minimal-history]] How to get a Git repository with minimal history @@ -4665,8 +4674,6 @@ Include cross-references to the glossary, where appropriate. Add a section on working with other version control systems, including CVS, Subversion, and just imports of series of release tarballs. -More details on gitweb? - Write a chapter on using plumbing and writing scripts. Alternates, clone -reference, etc. -- cgit v1.2.1