Eric Sunshine[PATCH v2 0/6] minor documentation improvements
This is a re-roll of [1] which makes minor improvements to documentation based upon observations of Michael Haggerty, Junio, and myself. This version addresses review comments by Michael[2] and includes follow-on patch 7/6 which arose[3] from my observation that it may be time to retire the manually-maintained list of 3rd party tools altogether. This version also drops v1 patch 1/6 since that patch[4] has already migrated to 'next'[5].
This is built atop [5] in 'next'. A v1 to v2 interdiff is included below.
[1]: http://thread.gmane.org/gmane.comp.version-control.git/274537 [2]: http://article.gmane.org/gmane.comp.version-control.git/274647 [3]: http://article.gmane.org/gmane.comp.version-control.git/274602 [4]: http://article.gmane.org/gmane.comp.version-control.git/274541 [5]: 5f5f553 (Documentation/git-worktree: fix broken 'linkgit' invocation, 2015-07-24)
Eric Sunshine (6): Documentation/config: mention "now" and "never" for 'expire' settings Documentation/git: drop outdated Cogito reference Documentation/git-tools: improve discoverability of Git wiki Documentation/git-tools: fix item text formatting Documentation/git-tools: drop references to defunct tools Documentation/git-tools: retire manually-maintained list
Documentation/config.txt | 16 ++++-- Documentation/git-tools.txt | 124 +++----------------------------------------- Documentation/git.txt | 2 +- 3 files changed, 20 insertions(+), 122 deletions(-)
-- 2.5.0.rc3.490.g8c70279 --- 8< --- diff --git a/Documentation/config.txt b/Documentation/config.txt index ba37a36..e09ee02 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -1227,21 +1227,23 @@ gc.pruneexpire:: When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. Override the grace period with this config variable. The value "now" may be used to disable this grace period and always prune - unreachable objects immediately; or "never" to suppress pruning. + unreachable objects immediately, or "never" may be used to + suppress pruning. gc.worktreePruneExpire:: When 'git gc' is run, it calls 'git worktree prune --expire 3.months.ago'. This config variable can be used to set a different grace period. The value "now" may be used to disable the grace - period and prune $GIT_DIR/worktrees immediately; or "never" to - suppress pruning. + period and prune $GIT_DIR/worktrees immediately, or "never" + may be used to suppress pruning. gc.reflogexpire:: gc.<pattern>.reflogexpire:: 'git reflog expire' removes reflog entries older than - this time; defaults to 90 days. The value "all" expires all - entries; and "false" disables expiration. With "<pattern>" (e.g. + this time; defaults to 90 days. The value "now" expires all + entries immediately, and "never" suppresses expiration + altogether. With "<pattern>" (e.g. "refs/stash") in the middle the setting applies only to the refs that match the <pattern>. @@ -1249,8 +1251,9 @@ gc.reflogexpireunreachable:: gc.<ref>.reflogexpireunreachable:: 'git reflog expire' removes reflog entries older than this time and are not reachable from the current tip; - defaults to 30 days. The value "all" expires all entries; and - "false" disables expiration. With "<pattern>" (e.g. "refs/stash") + defaults to 30 days. The value "now" expires all entries + immediately, and "never" suppresses expiration altogether. + With "<pattern>" (e.g. "refs/stash") in the middle, the setting applies only to the refs that match the <pattern>. diff --git a/Documentation/git-tools.txt b/Documentation/git-tools.txt index 48a3595..2f4ff50 100644 --- a/Documentation/git-tools.txt +++ b/Documentation/git-tools.txt @@ -1,84 +1,10 @@ -A short Git tools survey -======================== +Git Tools +========= +When Git was young, people looking for third-party Git-related tools came +to the Git project itself to find them, thus a list of such tools was +maintained here. These days, however, search engines fill that role much +more efficiently, so this manually-maintained list has been retired. -Introduction ------------- - -Apart from Git contrib/ area there are some others third-party tools -you may want to look at. -This document presents a brief summary of each tool and the corresponding -link. -For a more comprehensive list, see: +See also the `contrib/` area, and the Git wiki: http://git.or.cz/gitwiki/InterfacesFrontendsAndTools - - -Alternative/Augmentative Porcelains ------------------------------------ - -- *StGit* (http://www.procode.org/stgit/) -+ -Stacked Git provides a quilt-like patch management functionality in the -Git environment. You can easily manage your patches in the scope of Git -until they get merged upstream. - - -History Viewers ---------------- - -- *gitk* (shipped with git-core) -+ -gitk is a simple Tk GUI for browsing history of Git repositories easily. - - -- *gitview* (contrib/) -+ -gitview is a GTK based repository browser for Git - - -- *gitweb* (shipped with git-core) -+ -Gitweb provides full-fledged web interface for Git repositories. - - -- *qgit* (http://digilander.libero.it/mcostalba/) -+ -QGit is a git/StGit GUI viewer built on Qt/C++. QGit could be used -to browse history and directory tree, view annotated files, commit -changes cherry picking single files or applying patches. -Currently it is the fastest and most feature rich among the Git -viewers and commit tools. - -- *tig* (http://jonas.nitro.dk/tig/) -+ -tig by Jonas Fonseca is a simple Git repository browser -written using ncurses. Basically, it just acts as a front-end -for git-log and git-show/git-diff. Additionally, you can also -use it as a pager for Git commands. - - -Foreign SCM interface ---------------------- - -- *git-svn* (shipped with git-core) -+ -git-svn is a simple conduit for changesets between a single Subversion -branch and Git. - - -- *hg-to-git* (contrib/) -+ -hg-to-git converts a Mercurial repository into a Git one, and -preserves the full branch history in the process. hg-to-git can -also be used in an incremental way to keep the Git repository -in sync with the master Mercurial repository. - - -Others ------- - -- *git.el* (contrib/) -+ -This is an Emacs interface for Git. The user interface is modelled on -pcl-cvs. It has been developed on Emacs 21 and will probably need some -tweaking to work on XEmacs. --- 8< ---