{"thread":{"id":"7306","subject":"[PATCH] user-manual: Use def_ instead of ref_ for glossary references.","startedAt":"2007-03-19T03:17:56Z","lastAt":"2007-03-19T13:56:28Z","messageCount":9,"participants":["J. Bruce Fields","Junio C Hamano","Johannes Schindelin"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"37448","messageId":"522.111988584761$1174274339@news.gmane.org","threadId":"7306","inReplyTo":"117427428145-git-send-email-","subject":"[PATCH] user-manual: run xsltproc without --nonet option","fromName":"J. Bruce Fields","fromEmail":"bfields@citi.umich.edu","sentAt":"2007-03-19T03:17:56Z","receivedAt":"2007-03-19T03:17:56Z","isPatch":true,"sender":{"key":"bfields@citi.umich.edu","avatar":null},"body":"From: J. Bruce Fields <bfields@citi.umich.edu>\n\nThe --nonet option prevents xsltproc from going to the network to find\nanything.  But it always tries to find them locally first, so for a\nuser with the necessary docbook stylesheets installed the build will\nwork just fine without xsltproc attempting to use the network; all\n--nonet does is make it fail rather than falling back on that.  That\ndoesn't seem particularly helpful.\n\nSigned-off-by: \"J. Bruce Fields\" <bfields@citi.umich.edu>\n---\n Documentation/Makefile |    2 +-\n 1 files changed, 1 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex 7c1c9e1..48d41c5 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -106,7 +106,7 @@ user-manual.xml: user-manual.txt user-manual.conf\n \t$(ASCIIDOC) -b docbook -d book $<\n \n XSLT = http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl\n-XSLTOPTS = --nonet --xinclude --stringparam html.stylesheet docbook-xsl.css\n+XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css\n \n user-manual.html: user-manual.xml\n \txsltproc $(XSLTOPTS) -o $@ $(XSLT) $<\n-- \n1.5.0.3.31.ge47c\n"},{"id":"37451","messageId":"39141.0089251169$1174274341@news.gmane.org","threadId":"7306","inReplyTo":"1174274281887-git-send-email-","subject":"[PATCH] user-manual.txt: fix a tiny typo.","fromName":"J. Bruce Fields","fromEmail":"bfields@citi.umich.edu","sentAt":"2007-03-19T03:17:57Z","receivedAt":"2007-03-19T03:17:57Z","isPatch":true,"sender":{"key":"bfields@citi.umich.edu","avatar":null},"body":"From: Jim Meyering <jim@meyering.net>\n\n\"file patch\" was doubtless intended to be \"file path\",\nbut \"directory name\" is clearer.\n\nSigned-off-by: Jim Meyering <jim@meyering.net>\nSigned-off-by: \"J. Bruce Fields\" <bfields@citi.umich.edu>\n---\n Documentation/user-manual.txt |    2 +-\n 1 files changed, 1 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt\nindex 0919574..773f65e 100644\n--- a/Documentation/user-manual.txt\n+++ b/Documentation/user-manual.txt\n@@ -1698,7 +1698,7 @@ If you and maintainer both have accounts on the same machine, then\n then you can just pull changes from each other's repositories\n directly; note that all of the commands (gitlink:git-clone[1],\n git-fetch[1], git-pull[1], etc.) that accept a URL as an argument\n-will also accept a local file patch; so, for example, you can\n+will also accept a local directory name; so, for example, you can\n use\n \n -------------------------------------------------\n-- \n1.5.0.3.31.ge47c\n"},{"id":"37447","messageId":"39327.3101807155$1174274338@news.gmane.org","threadId":"7306","inReplyTo":"11742742813855-git-send-email-","subject":"[PATCH] user-manual: Use def_ instead of ref_ for glossary references.","fromName":"J. Bruce Fields","fromEmail":"bfields@citi.umich.edu","sentAt":"2007-03-19T03:17:58Z","receivedAt":"2007-03-19T03:17:58Z","isPatch":true,"sender":{"key":"bfields@citi.umich.edu","avatar":null},"body":"From: J. Bruce Fields <bfields@citi.umich.edu>\n\nI'd like to start using references to the glossary in the user manual.\nThe \"ref_\" prefix for these references seems a little generic; so\nreplace with \"def_\".\n\nSigned-off-by: \"J. Bruce Fields\" <bfields@citi.umich.edu>\n---\n Documentation/sort_glossary.pl |    4 ++--\n 1 files changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/sort_glossary.pl b/Documentation/sort_glossary.pl\nindex 05dc7b2..4ae6290 100644\n--- a/Documentation/sort_glossary.pl\n+++ b/Documentation/sort_glossary.pl\n@@ -50,8 +50,8 @@ This list is sorted alphabetically:\n @keys=sort {uc($a) cmp uc($b)} keys %terms;\n $pattern='(\\b(?<!link:git-)'.join('\\b|\\b(?<!-)',reverse @keys).'\\b)';\n foreach $key (@keys) {\n-\t$terms{$key}=~s/$pattern/sprintf \"<<ref_\".no_spaces($1).\",$1>>\";/eg;\n-\tprint '[[ref_'.no_spaces($key).']]'.$key.\"::\\n\"\n+\t$terms{$key}=~s/$pattern/sprintf \"<<def_\".no_spaces($1).\",$1>>\";/eg;\n+\tprint '[[def_'.no_spaces($key).']]'.$key.\"::\\n\"\n \t\t.format_tab_80($terms{$key}).\"\\n\";\n }\n \n-- \n1.5.0.3.31.ge47c\n"},{"id":"37453","messageId":"40732.0443111987$1174274348@news.gmane.org","threadId":"7306","inReplyTo":"1174274281258-git-send-email-","subject":"[PATCH] glossary: stop generating automatically","fromName":"J. Bruce Fields","fromEmail":"bfields@citi.umich.edu","sentAt":"2007-03-19T03:17:59Z","receivedAt":"2007-03-19T03:17:59Z","isPatch":true,"sender":{"key":"bfields@citi.umich.edu","avatar":null},"body":"From: J. Bruce Fields <bfields@citi.umich.edu>\n\nThe sort_glossary.pl script sorts the glossary, checks for duplicates,\nand automatically adds cross-references.\n\nBut it's not so hard to do all that by hand, and sometimes the automatic\ncross-references are a little wrong; so let's run the script one last\ntime and check in its output.\n\nNote: to make the output fit better into the user manual I also deleted\nthe acknowledgements at the end, which was maybe a little rude; feel\nfree to object and I can find a different solution.\n\nCc: Johannes Schindelin <Johannes.Schindelin@gmx.de>\nSigned-off-by: \"J. Bruce Fields\" <bfields@citi.umich.edu>\n---\n Documentation/Makefile         |    8 +-\n Documentation/glossary.txt     |  740 +++++++++++++++++++++-------------------\n Documentation/sort_glossary.pl |   69 ----\n Documentation/user-manual.txt  |    3 -\n 4 files changed, 392 insertions(+), 428 deletions(-)\n delete mode 100644 Documentation/sort_glossary.pl\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex 48d41c5..7db3fb9 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -16,8 +16,9 @@ ARTICLES += repository-layout\n ARTICLES += hooks\n ARTICLES += everyday\n ARTICLES += git-tools\n+ARTICLES += glossary\n # with their own formatting rules.\n-SP_ARTICLES = glossary howto/revert-branch-rebase user-manual\n+SP_ARTICLES = howto/revert-branch-rebase user-manual\n \n DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))\n \n@@ -111,11 +112,6 @@ XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css\n user-manual.html: user-manual.xml\n \txsltproc $(XSLTOPTS) -o $@ $(XSLT) $<\n \n-glossary.html : glossary.txt sort_glossary.pl\n-\tcat $< | \\\n-\tperl sort_glossary.pl | \\\n-\t$(ASCIIDOC) -b xhtml11 - > glossary.html\n-\n howto-index.txt: howto-index.sh $(wildcard howto/*.txt)\n \trm -f $@+ $@\n \tsh ./howto-index.sh $(wildcard howto/*.txt) >$@+\ndiff --git a/Documentation/glossary.txt b/Documentation/glossary.txt\nindex 9f44624..82e17db 100644\n--- a/Documentation/glossary.txt\n+++ b/Documentation/glossary.txt\n@@ -1,365 +1,405 @@\n-alternate object database::\n-\tVia the alternates mechanism, a repository can inherit part of its\n-\tobject database from another object database, which is called\n-\t\"alternate\".\n-\n-bare repository::\n-\tA bare repository is normally an appropriately named\n-\tdirectory with a `.git` suffix that does not have a\n-\tlocally checked-out copy of any of the files under revision\n-\tcontrol.  That is, all of the `git` administrative and\n-\tcontrol files that would normally be present in the\n-\thidden `.git` sub-directory are directly present in\n-\tthe `repository.git` directory instead, and no other files\n-\tare present and checked out.  Usually publishers of public\n-\trepositories make bare repositories available.\n-\n-blob object::\n-\tUntyped object, e.g. the contents of a file.\n-\n-branch::\n-\tA non-cyclical graph of revisions, i.e. the complete history of\n-\ta particular revision, which is called the branch head. The\n-\tbranch heads are stored in `$GIT_DIR/refs/heads/`.\n-\n-cache::\n-\tObsolete for: index.\n-\n-chain::\n-\tA list of objects, where each object in the list contains a\n-\treference to its successor (for example, the successor of a commit\n-\tcould be one of its parents).\n-\n-changeset::\n-\tBitKeeper/cvsps speak for \"commit\". Since git does not store\n-\tchanges, but states, it really does not make sense to use\n-\tthe term \"changesets\" with git.\n-\n-checkout::\n-\tThe action of updating the working tree to a revision which was\n-\tstored in the object database.\n-\n-cherry-picking::\n-\tIn SCM jargon, \"cherry pick\" means to choose a subset of\n-\tchanges out of a series of changes (typically commits)\n-\tand record them as a new series of changes on top of\n-\tdifferent codebase.  In GIT, this is performed by\n-\t\"git cherry-pick\" command to extract the change\n-\tintroduced by an existing commit and to record it based\n-\ton the tip of the current branch as a new commit.\n-\n-clean::\n-\tA working tree is clean, if it corresponds to the revision\n-\treferenced by the current head.  Also see \"dirty\".\n-\n-commit::\n-\tAs a verb: The action of storing the current state of the index in the\n-\tobject database. The result is a revision.\n-\tAs a noun: Short hand for commit object.\n-\n-commit object::\n-\tAn object which contains the information about a particular\n-\trevision, such as parents, committer, author, date and the\n-\ttree object which corresponds to the top directory of the\n-\tstored revision.\n-\n-core git::\n-\tFundamental data structures and utilities of git. Exposes only\n-\tlimited source code management tools.\n-\n-DAG::\n-\tDirected acyclic graph. The commit objects form a directed acyclic\n-\tgraph, because they have parents (directed), and the graph of commit\n-\tobjects is acyclic (there is no chain which begins and ends with the\n-\tsame object).\n-\n-dangling object::\n-\tAn unreachable object which is not reachable even from other\n-\tunreachable objects; a dangling object has no references to it\n-\tfrom any reference or object in the repository.\n-\n-dircache::\n+GIT Glossary\n+============\n+\n+[[def_alternate_object_database]]alternate object database::\n+\tVia the alternates mechanism, a <<def_repository,repository>> can\n+\tinherit part of its <<def_object_database,object database>> from another\n+\t<<def_object_database,object database>>, which is called \"alternate\".\n+\n+[[def_bare_repository]]bare repository::\n+\tA <<def_bare_repository,bare repository>> is normally an appropriately\n+\tnamed <<def_directory,directory>> with a `.git` suffix that does not\n+\thave a locally checked-out copy of any of the files under\n+\t<<def_revision,revision>> control. That is, all of the `git`\n+\tadministrative and control files that would normally be present in the\n+\thidden `.git` sub-directory are directly present in the\n+\t`<<def_repository,repository>>.git` <<def_directory,directory>> instead,\n+\tand no other files are present and checked out. Usually publishers of\n+\tpublic repositories make bare repositories available.\n+\n+[[def_blob_object]]blob object::\n+\tUntyped <<def_object,object>>, e.g. the contents of a file.\n+\n+[[def_branch]]branch::\n+\tA non-cyclical graph of revisions, i.e. the complete history of a\n+\tparticular <<def_revision,revision>>, which is called the\n+\t<<def_branch,branch>> <<def_head,head>>. The <<def_branch,branch>> heads\n+\tare stored in `$GIT_DIR/refs/heads/`.\n+\n+[[def_cache]]cache::\n+\tObsolete for: <<def_index,index>>.\n+\n+[[def_chain]]chain::\n+\tA list of objects, where each <<def_object,object>> in the list contains\n+\ta reference to its successor (for example, the successor of a\n+\t<<def_commit,commit>> could be one of its parents).\n+\n+[[def_changeset]]changeset::\n+\tBitKeeper/cvsps speak for \"<<def_commit,commit>>\". Since git does not\n+\tstore changes, but states, it really does not make sense to use the term\n+\t\"changesets\" with git.\n+\n+[[def_checkout]]checkout::\n+\tThe action of updating the <<def_working_tree,working tree>> to a\n+\t<<def_revision,revision>> which was stored in the\n+\t<<def_object_database,object database>>.\n+\n+[[def_cherry-picking]]cherry-picking::\n+\tIn <<def_SCM,SCM>> jargon, \"cherry pick\" means to choose a subset of\n+\tchanges out of a series of changes (typically commits) and record them\n+\tas a new series of changes on top of different codebase. In GIT, this is\n+\tperformed by \"git cherry-pick\" command to extract the change introduced\n+\tby an existing <<def_commit,commit>> and to record it based on the tip\n+\tof the current <<def_branch,branch>> as a new <<def_commit,commit>>.\n+\n+[[def_clean]]clean::\n+\tA <<def_working_tree,working tree>> is <<def_clean,clean>>, if it\n+\tcorresponds to the <<def_revision,revision>> referenced by the current\n+\t<<def_head,head>>. Also see \"<<def_dirty,dirty>>\".\n+\n+[[def_commit]]commit::\n+\tAs a verb: The action of storing the current state of the\n+\t<<def_index,index>> in the <<def_object_database,object database>>. The\n+\tresult is a <<def_revision,revision>>. As a noun: Short hand for\n+\t<<def_commit_object,commit object>>.\n+\n+[[def_commit_object]]commit object::\n+\tAn <<def_object,object>> which contains the information about a\n+\tparticular <<def_revision,revision>>, such as parents, committer,\n+\tauthor, date and the <<def_tree_object,tree object>> which corresponds\n+\tto the top <<def_directory,directory>> of the stored\n+\t<<def_revision,revision>>.\n+\n+[[def_core_git]]core git::\n+\tFundamental data structures and utilities of git. Exposes only limited\n+\tsource code management tools.\n+\n+[[def_DAG]]DAG::\n+\tDirected acyclic graph. The <<def_commit,commit>> objects form a\n+\tdirected acyclic graph, because they have parents (directed), and the\n+\tgraph of <<def_commit,commit>> objects is acyclic (there is no\n+\t<<def_chain,chain>> which begins and ends with the same\n+\t<<def_object,object>>).\n+\n+[[def_dangling_object]]dangling object::\n+\tAn <<def_unreachable_object,unreachable object>> which is not\n+\t<<def_reachable,reachable>> even from other unreachable objects; a\n+\t<<def_dangling_object,dangling object>> has no references to it from any\n+\treference or <<def_object,object>> in the <<def_repository,repository>>.\n+\n+[[def_dircache]]dircache::\n \tYou are *waaaaay* behind.\n \n-dirty::\n-\tA working tree is said to be dirty if it contains modifications\n-\twhich have not been committed to the current branch.\n-\n-directory::\n+[[def_directory]]directory::\n \tThe list you get with \"ls\" :-)\n \n-ent::\n-\tFavorite synonym to \"tree-ish\" by some total geeks. See\n+[[def_dirty]]dirty::\n+\tA <<def_working_tree,working tree>> is said to be <<def_dirty,dirty>> if\n+\tit contains modifications which have not been committed to the current\n+\t<<def_branch,branch>>.\n+\n+[[def_ent]]ent::\n+\tFavorite synonym to \"<<def_tree-ish,tree-ish>>\" by some total geeks. See\n \t`http://en.wikipedia.org/wiki/Ent_(Middle-earth)` for an in-depth\n-\texplanation.  Avoid this term, not to confuse people.\n-\n-fast forward::\n-\tA fast-forward is a special type of merge where you have\n-\ta revision and you are \"merging\" another branch's changes\n-\tthat happen to be a descendant of what you have.\n-\tIn such these cases, you do not make a new merge commit but\n-\tinstead just update to his revision. This will happen\n-\tfrequently on a tracking branch of a remote repository.\n-\n-fetch::\n-\tFetching a branch means to get the branch's head ref from a\n-\tremote repository, to find out which objects are missing from\n-\tthe local object database, and to get them, too.\n-\n-file system::\n-\tLinus Torvalds originally designed git to be a user space file\n-\tsystem, i.e. the infrastructure to hold files and directories.\n-\tThat ensured the efficiency and speed of git.\n-\n-git archive::\n-\tSynonym for repository (for arch people).\n-\n-grafts::\n-\tGrafts enables two otherwise different lines of development to be\n-\tjoined together by recording fake ancestry information for commits.\n-\tThis way you can make git pretend the set of parents a commit\n-\thas is different from what was recorded when the commit was created.\n-\tConfigured via the `.git/info/grafts` file.\n-\n-hash::\n-\tIn git's context, synonym to object name.\n-\n-head::\n-\tThe top of a branch. It contains a ref to the corresponding\n-\tcommit object.\n-\n-head ref::\n-\tA ref pointing to a head. Often, this is abbreviated to \"head\".\n-\tHead refs are stored in `$GIT_DIR/refs/heads/`.\n-\n-hook::\n-\tDuring the normal execution of several git commands,\n-\tcall-outs are made to optional scripts that allow\n-\ta developer to add functionality or checking.\n-\tTypically, the hooks allow for a command to be pre-verified\n-\tand potentially aborted, and allow for a post-notification\n-\tafter the operation is done.\n-\tThe hook scripts are found in the `$GIT_DIR/hooks/` directory,\n-\tand are enabled by simply making them executable.\n-\n-index::\n-\tA collection of files with stat information, whose contents are\n-\tstored as objects. The index is a stored version of your working\n-\ttree. Truth be told, it can also contain a second, and even a third\n-\tversion of a working tree, which are used when merging.\n-\n-index entry::\n-\tThe information regarding a particular file, stored in the index.\n-\tAn index entry can be unmerged, if a merge was started, but not\n-\tyet finished (i.e. if the index contains multiple versions of\n-\tthat file).\n-\n-master::\n-\tThe default development branch. Whenever you create a git\n-\trepository, a branch named \"master\" is created, and becomes\n-\tthe active branch. In most cases, this contains the local\n+\texplanation. Avoid this term, not to confuse people.\n+\n+[[def_fast_forward]]fast forward::\n+\tA fast-forward is a special type of <<def_merge,merge>> where you have a\n+\t<<def_revision,revision>> and you are \"merging\" another\n+\t<<def_branch,branch>>'s changes that happen to be a descendant of what\n+\tyou have. In such these cases, you do not make a new <<def_merge,merge>>\n+\t<<def_commit,commit>> but instead just update to his\n+\t<<def_revision,revision>>. This will happen frequently on a\n+\t<<def_tracking_branch,tracking branch>> of a remote\n+\t<<def_repository,repository>>.\n+\n+[[def_fetch]]fetch::\n+\tFetching a <<def_branch,branch>> means to get the\n+\t<<def_branch,branch>>'s <<def_head_ref,head ref>> from a remote\n+\t<<def_repository,repository>>, to find out which objects are missing\n+\tfrom the local <<def_object_database,object database>>, and to get them,\n+\ttoo.\n+\n+[[def_file_system]]file system::\n+\tLinus Torvalds originally designed git to be a user space file system,\n+\ti.e. the infrastructure to hold files and directories. That ensured the\n+\tefficiency and speed of git.\n+\n+[[def_git_archive]]git archive::\n+\tSynonym for <<def_repository,repository>> (for arch people).\n+\n+[[def_grafts]]grafts::\n+\tGrafts enables two otherwise different lines of development to be joined\n+\ttogether by recording fake ancestry information for commits. This way\n+\tyou can make git pretend the set of parents a <<def_commit,commit>> has\n+\tis different from what was recorded when the <<def_commit,commit>> was\n+\tcreated. Configured via the `.git/info/<<def_grafts,grafts>>` file.\n+\n+[[def_hash]]hash::\n+\tIn git's context, synonym to <<def_object_name,object name>>.\n+\n+[[def_head]]head::\n+\tThe top of a <<def_branch,branch>>. It contains a <<def_ref,ref>> to the\n+\tcorresponding <<def_commit_object,commit object>>.\n+\n+[[def_head_ref]]head ref::\n+\tA <<def_ref,ref>> pointing to a <<def_head,head>>. Often, this is\n+\tabbreviated to \"<<def_head,head>>\". Head refs are stored in\n+\t`$GIT_DIR/refs/heads/`.\n+\n+[[def_hook]]hook::\n+\tDuring the normal execution of several git commands, call-outs are made\n+\tto optional scripts that allow a developer to add functionality or\n+\tchecking. Typically, the hooks allow for a command to be pre-verified\n+\tand potentially aborted, and allow for a post-notification after the\n+\toperation is done. The <<def_hook,hook>> scripts are found in the\n+\t`$GIT_DIR/hooks/` <<def_directory,directory>>, and are enabled by simply\n+\tmaking them executable.\n+\n+[[def_index]]index::\n+\tA collection of files with stat information, whose contents are stored\n+\tas objects. The <<def_index,index>> is a stored version of your working\n+\t<<def_tree,tree>>. Truth be told, it can also contain a second, and even\n+\ta third version of a <<def_working_tree,working tree>>, which are used\n+\twhen merging.\n+\n+[[def_index_entry]]index entry::\n+\tThe information regarding a particular file, stored in the\n+\t<<def_index,index>>. An <<def_index_entry,index entry>> can be unmerged,\n+\tif a <<def_merge,merge>> was started, but not yet finished (i.e. if the\n+\t<<def_index,index>> contains multiple versions of that file).\n+\n+[[def_master]]master::\n+\tThe default development <<def_branch,branch>>. Whenever you create a git\n+\t<<def_repository,repository>>, a <<def_branch,branch>> named\n+\t\"<<def_master,master>>\" is created, and becomes the active\n+\t<<def_branch,branch>>. In most cases, this contains the local\n \tdevelopment, though that is purely conventional and not required.\n \n-merge::\n-\tTo merge branches means to try to accumulate the changes since a\n-\tcommon ancestor and apply them to the first branch. An automatic\n-\tmerge uses heuristics to accomplish that. Evidently, an automatic\n-\tmerge can fail.\n-\n-object::\n-\tThe unit of storage in git. It is uniquely identified by\n-\tthe SHA1 of its contents. Consequently, an object can not\n-\tbe changed.\n-\n-object database::\n-\tStores a set of \"objects\", and an individual object is identified\n-\tby its object name. The objects usually live in `$GIT_DIR/objects/`.\n-\n-object identifier::\n-\tSynonym for object name.\n-\n-object name::\n-\tThe unique identifier of an object. The hash of the object's contents\n-\tusing the Secure Hash Algorithm 1 and usually represented by the 40\n-\tcharacter hexadecimal encoding of the hash of the object (possibly\n-\tfollowed by a white space).\n-\n-object type::\n-\tOne of the identifiers \"commit\",\"tree\",\"tag\" and \"blob\" describing\n-\tthe type of an object.\n-\n-octopus::\n-\tTo merge more than two branches. Also denotes an intelligent\n-\tpredator.\n-\n-origin::\n-\tThe default upstream repository. Most projects have at\n-\tleast one upstream project which they track. By default\n-\t'origin' is used for that purpose.  New upstream updates\n+[[def_merge]]merge::\n+\tTo <<def_merge,merge>> branches means to try to accumulate the changes\n+\tsince a common ancestor and apply them to the first\n+\t<<def_branch,branch>>. An automatic <<def_merge,merge>> uses heuristics\n+\tto accomplish that. Evidently, an automatic <<def_merge,merge>> can\n+\tfail.\n+\n+[[def_object]]object::\n+\tThe unit of storage in git. It is uniquely identified by the\n+\t<<def_SHA1,SHA1>> of its contents. Consequently, an\n+\t<<def_object,object>> can not be changed.\n+\n+[[def_object_database]]object database::\n+\tStores a set of \"objects\", and an individual <<def_object,object>> is\n+\tidentified by its <<def_object_name,object name>>. The objects usually\n+\tlive in `$GIT_DIR/objects/`.\n+\n+[[def_object_identifier]]object identifier::\n+\tSynonym for <<def_object_name,object name>>.\n+\n+[[def_object_name]]object name::\n+\tThe unique identifier of an <<def_object,object>>. The <<def_hash,hash>>\n+\tof the <<def_object,object>>'s contents using the Secure Hash Algorithm\n+\t1 and usually represented by the 40 character hexadecimal encoding of\n+\tthe <<def_hash,hash>> of the <<def_object,object>> (possibly followed by\n+\ta white space).\n+\n+[[def_object_type]]object type::\n+\tOne of the identifiers\n+\t\"<<def_commit,commit>>\",\"<<def_tree,tree>>\",\"<<def_tag,tag>>\" and \"blob\"\n+\tdescribing the type of an <<def_object,object>>.\n+\n+[[def_octopus]]octopus::\n+\tTo <<def_merge,merge>> more than two branches. Also denotes an\n+\tintelligent predator.\n+\n+[[def_origin]]origin::\n+\tThe default upstream <<def_repository,repository>>. Most projects have\n+\tat least one upstream project which they track. By default\n+\t'<<def_origin,origin>>' is used for that purpose. New upstream updates\n \twill be fetched into remote tracking branches named\n-\torigin/name-of-upstream-branch, which you can see using\n-\t\"git branch -r\".\n+\t<<def_origin,origin>>/name-of-upstream-branch, which you can see using\n+\t\"git <<def_branch,branch>> -r\".\n \n-pack::\n-\tA set of objects which have been compressed into one file (to save\n-\tspace or to transmit them efficiently).\n+[[def_pack]]pack::\n+\tA set of objects which have been compressed into one file (to save space\n+\tor to transmit them efficiently).\n \n-pack index::\n+[[def_pack_index]]pack index::\n \tThe list of identifiers, and other information, of the objects in a\n-\tpack, to assist in efficiently accessing the contents of a pack.\n-\n-parent::\n-\tA commit object contains a (possibly empty) list of the logical\n-\tpredecessor(s) in the line of development, i.e. its parents.\n-\n-pickaxe::\n-\tThe term pickaxe refers to an option to the diffcore routines\n-\tthat help select changes that add or delete a given text string.\n-\tWith the --pickaxe-all option, it can be used to view the\n-\tfull changeset that introduced or removed, say, a particular\n-\tline of text.  See gitlink:git-diff[1].\n-\n-plumbing::\n-\tCute name for core git.\n-\n-porcelain::\n-\tCute name for programs and program suites depending on core git,\n-\tpresenting a high level access to core git. Porcelains expose\n-\tmore of a SCM interface than the plumbing.\n-\n-pull::\n-\tPulling a branch means to fetch it and merge it.\n-\n-push::\n-\tPushing a branch means to get the branch's head ref from a remote\n-\trepository, find out if it is an ancestor to the branch's local\n-\thead ref is a direct, and in that case, putting all objects, which\n-\tare reachable from the local head ref, and which are missing from\n-\tthe remote repository, into the remote object database, and updating\n-\tthe remote head ref. If the remote head is not an ancestor to the\n-\tlocal head, the push fails.\n-\n-reachable::\n-\tAll of the ancestors of a given commit are said to be reachable from\n-\tthat commit.  More generally, one object is reachable from another if\n-\twe can reach the one from the other by a chain that follows tags to\n-\twhatever they tag, commits to their parents or trees, and trees to the\n-\ttrees or blobs that they contain.\n-\n-rebase::\n-\tTo clean a branch by starting from the head of the main line of\n-\tdevelopment (\"master\"), and reapply the (possibly cherry-picked)\n-\tchanges from that branch.\n-\n-ref::\n-\tA 40-byte hex representation of a SHA1 or a name that denotes\n-\ta particular object. These may be stored in `$GIT_DIR/refs/`.\n-\n-refspec::\n-\tA refspec is used by fetch and push to describe the mapping\n-\tbetween remote ref and local ref.  They are combined with\n-\ta colon in the format <src>:<dst>, preceded by an optional\n-\tplus sign, +.  For example:\n-\t`git fetch $URL refs/heads/master:refs/heads/origin`\n-\tmeans \"grab the master branch head from the $URL and store\n-\tit as my origin branch head\".\n-\tAnd `git push $URL refs/heads/master:refs/heads/to-upstream`\n-\tmeans \"publish my master branch head as to-upstream branch\n-\tat $URL\".   See also gitlink:git-push[1]\n-\n-repository::\n-\tA collection of refs together with an object database containing\n-\tall objects, which are reachable from the refs, possibly accompanied\n-\tby meta data from one or more porcelains. A repository can\n-\tshare an object database with other repositories.\n-\n-resolve::\n-\tThe action of fixing up manually what a failed automatic merge\n-\tleft behind.\n-\n-revision::\n-\tA particular state of files and directories which was stored in\n-\tthe object database. It is referenced by a commit object.\n-\n-rewind::\n-\tTo throw away part of the development, i.e. to assign the head to\n-\tan earlier revision.\n-\n-SCM::\n+\t<<def_pack,pack>>, to assist in efficiently accessing the contents of a\n+\t<<def_pack,pack>>.\n+\n+[[def_parent]]parent::\n+\tA <<def_commit_object,commit object>> contains a (possibly empty) list\n+\tof the logical predecessor(s) in the line of development, i.e. its\n+\tparents.\n+\n+[[def_pickaxe]]pickaxe::\n+\tThe term <<def_pickaxe,pickaxe>> refers to an option to the diffcore\n+\troutines that help select changes that add or delete a given text\n+\tstring. With the --pickaxe-all option, it can be used to view the full\n+\t<<def_changeset,changeset>> that introduced or removed, say, a\n+\tparticular line of text. See gitlink:git-diff[1].\n+\n+[[def_plumbing]]plumbing::\n+\tCute name for <<def_core_git,core git>>.\n+\n+[[def_porcelain]]porcelain::\n+\tCute name for programs and program suites depending on\n+\t<<def_core_git,core git>>, presenting a high level access to\n+\t<<def_core_git,core git>>. Porcelains expose more of a <<def_SCM,SCM>>\n+\tinterface than the <<def_plumbing,plumbing>>.\n+\n+[[def_pull]]pull::\n+\tPulling a <<def_branch,branch>> means to <<def_fetch,fetch>> it and\n+\t<<def_merge,merge>> it.\n+\n+[[def_push]]push::\n+\tPushing a <<def_branch,branch>> means to get the <<def_branch,branch>>'s\n+\t<<def_head_ref,head ref>> from a remote <<def_repository,repository>>,\n+\tfind out if it is an ancestor to the <<def_branch,branch>>'s local\n+\t<<def_head_ref,head ref>> is a direct, and in that case, putting all\n+\tobjects, which are <<def_reachable,reachable>> from the local\n+\t<<def_head_ref,head ref>>, and which are missing from the remote\n+\t<<def_repository,repository>>, into the remote\n+\t<<def_object_database,object database>>, and updating the remote\n+\t<<def_head_ref,head ref>>. If the remote <<def_head,head>> is not an\n+\tancestor to the local <<def_head,head>>, the <<def_push,push>> fails.\n+\n+[[def_reachable]]reachable::\n+\tAll of the ancestors of a given <<def_commit,commit>> are said to be\n+\t<<def_reachable,reachable>> from that <<def_commit,commit>>. More\n+\tgenerally, one <<def_object,object>> is <<def_reachable,reachable>> from\n+\tanother if we can reach the one from the other by a <<def_chain,chain>>\n+\tthat follows tags to whatever they <<def_tag,tag>>, commits to their\n+\tparents or trees, and trees to the trees or blobs that they contain.\n+\n+[[def_rebase]]rebase::\n+\tTo <<def_clean,clean>> a <<def_branch,branch>> by starting from the\n+\t<<def_head,head>> of the main line of development\n+\t(\"<<def_master,master>>\"), and reapply the (possibly cherry-picked)\n+\tchanges from that <<def_branch,branch>>.\n+\n+[[def_ref]]ref::\n+\tA 40-byte hex representation of a <<def_SHA1,SHA1>> or a name that\n+\tdenotes a particular <<def_object,object>>. These may be stored in\n+\t`$GIT_DIR/refs/`.\n+\n+[[def_refspec]]refspec::\n+\tA <<def_refspec,refspec>> is used by <<def_fetch,fetch>> and\n+\t<<def_push,push>> to describe the mapping between remote <<def_ref,ref>>\n+\tand local <<def_ref,ref>>. They are combined with a colon in the format\n+\t<src>:<dst>, preceded by an optional plus sign, +. For example: `git\n+\t<<def_fetch,fetch>> $URL\n+\trefs/heads/<<def_master,master>>:refs/heads/<<def_origin,origin>>` means\n+\t\"grab the <<def_master,master>> <<def_branch,branch>> <<def_head,head>>\n+\tfrom the $URL and store it as my <<def_origin,origin>>\n+\t<<def_branch,branch>> <<def_head,head>>\". And `git <<def_push,push>>\n+\t$URL refs/heads/<<def_master,master>>:refs/heads/to-upstream` means\n+\t\"publish my <<def_master,master>> <<def_branch,branch>>\n+\t<<def_head,head>> as to-upstream <<def_branch,branch>> at $URL\". See\n+\talso gitlink:git-push[1]\n+\n+[[def_repository]]repository::\n+\tA collection of refs together with an <<def_object_database,object\n+\tdatabase>> containing all objects, which are <<def_reachable,reachable>>\n+\tfrom the refs, possibly accompanied by meta data from one or more\n+\tporcelains. A <<def_repository,repository>> can share an\n+\t<<def_object_database,object database>> with other repositories.\n+\n+[[def_resolve]]resolve::\n+\tThe action of fixing up manually what a failed automatic\n+\t<<def_merge,merge>> left behind.\n+\n+[[def_revision]]revision::\n+\tA particular state of files and directories which was stored in the\n+\t<<def_object_database,object database>>. It is referenced by a\n+\t<<def_commit_object,commit object>>.\n+\n+[[def_rewind]]rewind::\n+\tTo throw away part of the development, i.e. to assign the\n+\t<<def_head,head>> to an earlier <<def_revision,revision>>.\n+\n+[[def_SCM]]SCM::\n \tSource code management (tool).\n \n-SHA1::\n-\tSynonym for object name.\n-\n-shallow repository::\n-\tA shallow repository has an incomplete history some of\n-\twhose commits have parents cauterized away (in other\n-\twords, git is told to pretend that these commits do not\n-\thave the parents, even though they are recorded in the\n-\tcommit object).  This is sometimes useful when you are\n-\tinterested only in the recent history of a project even\n-\tthough the real history recorded in the upstream is\n-\tmuch larger.  A shallow repository is created by giving\n-\t`--depth` option to gitlink:git-clone[1], and its\n+[[def_SHA1]]SHA1::\n+\tSynonym for <<def_object_name,object name>>.\n+\n+[[def_shallow_repository]]shallow repository::\n+\tA <<def_shallow_repository,shallow repository>> has an incomplete\n+\thistory some of whose commits have parents cauterized away (in other\n+\twords, git is told to pretend that these commits do not have the\n+\tparents, even though they are recorded in the <<def_commit_object,commit\n+\tobject>>). This is sometimes useful when you are interested only in the\n+\trecent history of a project even though the real history recorded in the\n+\tupstream is much larger. A <<def_shallow_repository,shallow repository>>\n+\tis created by giving `--depth` option to gitlink:git-clone[1], and its\n \thistory can be later deepened with gitlink:git-fetch[1].\n \n-symref::\n-\tSymbolic reference: instead of containing the SHA1 id itself, it\n-\tis of the format 'ref: refs/some/thing' and when referenced, it\n-\trecursively dereferences to this reference. 'HEAD' is a prime\n-\texample of a symref. Symbolic references are manipulated with\n-\tthe gitlink:git-symbolic-ref[1] command.\n-\n-topic branch::\n-\tA regular git branch that is used by a developer to\n-\tidentify a conceptual line of development.  Since branches\n-\tare very easy and inexpensive, it is often desirable to\n-\thave several small branches that each contain very well\n-\tdefined concepts or small incremental yet related changes.\n-\n-tracking branch::\n-\tA regular git branch that is used to follow changes from\n-\tanother repository.  A tracking branch should not contain\n-\tdirect modifications or have local commits made to it.\n-\tA tracking branch can usually be identified as the\n-\tright-hand-side ref in a Pull: refspec.\n-\n-tree object::\n-\tAn object containing a list of file names and modes along with refs\n-\tto the associated blob and/or tree objects. A tree is equivalent\n-\tto a directory.\n-\n-tree::\n-\tEither a working tree, or a tree object together with the\n-\tdependent blob and tree objects (i.e. a stored representation\n-\tof a working tree).\n-\n-tree-ish::\n-\tA ref pointing to either a commit object, a tree object, or a\n-\ttag object pointing to a tag or commit or tree object.\n-\n-tag object::\n-\tAn object containing a ref pointing to another object, which can\n-\tcontain a message just like a commit object. It can also\n-\tcontain a (PGP) signature, in which case it is called a \"signed\n-\ttag object\".\n-\n-tag::\n-\tA ref pointing to a tag or commit object. In contrast to a head,\n-\ta tag is not changed by a commit. Tags (not tag objects) are\n-\tstored in `$GIT_DIR/refs/tags/`. A git tag has nothing to do with\n-\ta Lisp tag (which is called object type in git's context).\n-\tA tag is most typically used to mark a particular point in the\n-\tcommit ancestry chain.\n-\n-unmerged index::\n-\tAn index which contains unmerged index entries.\n-\n-unreachable object::\n-\tAn object which is not reachable from a branch, tag, or any\n-\tother reference.\n-\n-working tree::\n-\tThe set of files and directories currently being worked on,\n-\ti.e. you can work in your working tree without using git at all.\n-\n+[[def_symref]]symref::\n+\tSymbolic reference: instead of containing the <<def_SHA1,SHA1>> id\n+\titself, it is of the format '<<def_ref,ref>>: refs/some/thing' and when\n+\treferenced, it recursively dereferences to this reference. 'HEAD' is a\n+\tprime example of a <<def_symref,symref>>. Symbolic references are\n+\tmanipulated with the gitlink:git-symbolic-ref[1] command.\n+\n+[[def_tag]]tag::\n+\tA <<def_ref,ref>> pointing to a <<def_tag,tag>> or\n+\t<<def_commit_object,commit object>>. In contrast to a <<def_head,head>>,\n+\ta <<def_tag,tag>> is not changed by a <<def_commit,commit>>. Tags (not\n+\t<<def_tag,tag>> objects) are stored in `$GIT_DIR/refs/tags/`. A git\n+\t<<def_tag,tag>> has nothing to do with a Lisp <<def_tag,tag>> (which is\n+\tcalled <<def_object_type,object type>> in git's context). A\n+\t<<def_tag,tag>> is most typically used to mark a particular point in the\n+\t<<def_commit,commit>> ancestry <<def_chain,chain>>.\n+\n+[[def_tag_object]]tag object::\n+\tAn <<def_object,object>> containing a <<def_ref,ref>> pointing to\n+\tanother <<def_object,object>>, which can contain a message just like a\n+\t<<def_commit_object,commit object>>. It can also contain a (PGP)\n+\tsignature, in which case it is called a \"signed <<def_tag_object,tag\n+\tobject>>\".\n+\n+[[def_topic_branch]]topic branch::\n+\tA regular git <<def_branch,branch>> that is used by a developer to\n+\tidentify a conceptual line of development. Since branches are very easy\n+\tand inexpensive, it is often desirable to have several small branches\n+\tthat each contain very well defined concepts or small incremental yet\n+\trelated changes.\n+\n+[[def_tracking_branch]]tracking branch::\n+\tA regular git <<def_branch,branch>> that is used to follow changes from\n+\tanother <<def_repository,repository>>. A <<def_tracking_branch,tracking\n+\tbranch>> should not contain direct modifications or have local commits\n+\tmade to it. A <<def_tracking_branch,tracking branch>> can usually be\n+\tidentified as the right-hand-side <<def_ref,ref>> in a Pull:\n+\t<<def_refspec,refspec>>.\n+\n+[[def_tree]]tree::\n+\tEither a <<def_working_tree,working tree>>, or a <<def_tree_object,tree\n+\tobject>> together with the dependent blob and <<def_tree,tree>> objects\n+\t(i.e. a stored representation of a <<def_working_tree,working tree>>).\n+\n+[[def_tree_object]]tree object::\n+\tAn <<def_object,object>> containing a list of file names and modes along\n+\twith refs to the associated blob and/or <<def_tree,tree>> objects. A\n+\t<<def_tree,tree>> is equivalent to a <<def_directory,directory>>.\n+\n+[[def_tree-ish]]tree-ish::\n+\tA <<def_ref,ref>> pointing to either a <<def_commit_object,commit\n+\tobject>>, a <<def_tree_object,tree object>>, or a <<def_tag_object,tag\n+\tobject>> pointing to a <<def_tag,tag>> or <<def_commit,commit>> or\n+\t<<def_tree_object,tree object>>.\n+\n+[[def_unmerged_index]]unmerged index::\n+\tAn <<def_index,index>> which contains <<def_unmerged_index,unmerged\n+\tindex>> entries.\n+\n+[[def_unreachable_object]]unreachable object::\n+\tAn <<def_object,object>> which is not <<def_reachable,reachable>> from a\n+\t<<def_branch,branch>>, <<def_tag,tag>>, or any other reference.\n+\n+[[def_working_tree]]working tree::\n+\tThe set of files and directories currently being worked on, i.e. you can\n+\twork in your <<def_working_tree,working tree>> without using git at all.\ndiff --git a/Documentation/sort_glossary.pl b/Documentation/sort_glossary.pl\ndeleted file mode 100644\nindex 4ae6290..0000000\n--- a/Documentation/sort_glossary.pl\n+++ /dev/null\n@@ -1,69 +0,0 @@\n-#!/usr/bin/perl\n-\n-%terms=();\n-\n-while(<>) {\n-\tif(/^(\\S.*)::$/) {\n-\t\tmy $term=$1;\n-\t\tif(defined($terms{$term})) {\n-\t\t\tdie \"$1 defined twice\\n\";\n-\t\t}\n-\t\t$terms{$term}=\"\";\n-\t\tLOOP: while(<>) {\n-\t\t\tif(/^$/) {\n-\t\t\t\tlast LOOP;\n-\t\t\t}\n-\t\t\tif(/^\t\\S/) {\n-\t\t\t\t$terms{$term}.=$_;\n-\t\t\t} else {\n-\t\t\t\tdie \"Error 1: $_\";\n-\t\t\t}\n-\t\t}\n-\t}\n-}\n-\n-sub format_tab_80 ($) {\n-\tmy $text=$_[0];\n-\tmy $result=\"\";\n-\t$text=~s/\\s+/ /g;\n-\t$text=~s/^\\s+//;\n-\twhile($text=~/^(.{1,72})(|\\s+(\\S.*)?)$/) {\n-\t\t$result.=\"\t\".$1.\"\\n\";\n-\t\t$text=$3;\n-\t}\n-\treturn $result;\n-}\n-\n-sub no_spaces ($) {\n-\tmy $result=$_[0];\n-\t$result=~tr/ /_/;\n-\treturn $result;\n-}\n-\n-print 'GIT Glossary\n-============\n-\n-This list is sorted alphabetically:\n-\n-';\n-\n-@keys=sort {uc($a) cmp uc($b)} keys %terms;\n-$pattern='(\\b(?<!link:git-)'.join('\\b|\\b(?<!-)',reverse @keys).'\\b)';\n-foreach $key (@keys) {\n-\t$terms{$key}=~s/$pattern/sprintf \"<<def_\".no_spaces($1).\",$1>>\";/eg;\n-\tprint '[[def_'.no_spaces($key).']]'.$key.\"::\\n\"\n-\t\t.format_tab_80($terms{$key}).\"\\n\";\n-}\n-\n-print '\n-\n-Author\n-------\n-Written by Johannes Schindelin <Johannes.Schindelin@gmx.de> and\n-the git-list <git@vger.kernel.org>.\n-\n-GIT\n----\n-Part of the link:git.html[git] suite\n-';\n-\ndiff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt\nindex 773f65e..6df5e61 100644\n--- a/Documentation/user-manual.txt\n+++ b/Documentation/user-manual.txt\n@@ -3013,9 +3013,6 @@ confusing and scary messages, but it won't actually do anything bad. In\n contrast, running \"git prune\" while somebody is actively changing the \n repository is a *BAD* idea).\n \n-Glossary of git terms\n-=====================\n-\n include::glossary.txt[]\n \n Notes and todo list for this manual\n-- \n1.5.0.3.31.ge47c\n"},{"id":"37452","messageId":"14903.6772003912$1174274345@news.gmane.org","threadId":"7306","inReplyTo":"11742742811304-git-send-email-","subject":"[PATCH] glossary: clean up cross-references","fromName":"J. Bruce Fields","fromEmail":"bfields@citi.umich.edu","sentAt":"2007-03-19T03:18:00Z","receivedAt":"2007-03-19T03:18:00Z","isPatch":true,"sender":{"key":"bfields@citi.umich.edu","avatar":null},"body":"From: J. Bruce Fields <bfields@citi.umich.edu>\n\nManual clean-up of cross-references, and also clean up a few definitions (e.g.\ngit-rebase).\n\nSigned-off-by: \"J. Bruce Fields\" <bfields@citi.umich.edu>\n---\n Documentation/glossary.txt |   58 ++++++++++++++++++++++----------------------\n 1 files changed, 29 insertions(+), 29 deletions(-)\n\ndiff --git a/Documentation/glossary.txt b/Documentation/glossary.txt\nindex 82e17db..2465514 100644\n--- a/Documentation/glossary.txt\n+++ b/Documentation/glossary.txt\n@@ -13,7 +13,7 @@ GIT Glossary\n \t<<def_revision,revision>> control. That is, all of the `git`\n \tadministrative and control files that would normally be present in the\n \thidden `.git` sub-directory are directly present in the\n-\t`<<def_repository,repository>>.git` <<def_directory,directory>> instead,\n+\t`repository.git` directory instead,\n \tand no other files are present and checked out. Usually publishers of\n \tpublic repositories make bare repositories available.\n \n@@ -23,7 +23,7 @@ GIT Glossary\n [[def_branch]]branch::\n \tA non-cyclical graph of revisions, i.e. the complete history of a\n \tparticular <<def_revision,revision>>, which is called the\n-\t<<def_branch,branch>> <<def_head,head>>. The <<def_branch,branch>> heads\n+\tbranch <<def_head,head>>. The heads\n \tare stored in `$GIT_DIR/refs/heads/`.\n \n [[def_cache]]cache::\n@@ -133,7 +133,7 @@ GIT Glossary\n \ttogether by recording fake ancestry information for commits. This way\n \tyou can make git pretend the set of parents a <<def_commit,commit>> has\n \tis different from what was recorded when the <<def_commit,commit>> was\n-\tcreated. Configured via the `.git/info/<<def_grafts,grafts>>` file.\n+\tcreated. Configured via the `.git/info/grafts` file.\n \n [[def_hash]]hash::\n \tIn git's context, synonym to <<def_object_name,object name>>.\n@@ -205,7 +205,7 @@ GIT Glossary\n \n [[def_object_type]]object type::\n \tOne of the identifiers\n-\t\"<<def_commit,commit>>\",\"<<def_tree,tree>>\",\"<<def_tag,tag>>\" and \"blob\"\n+\t\"<<def_commit,commit>>\",\"<<def_tree,tree>>\",\"<<def_tag,tag>>\" or \"<<def_blob_object,blob>>\"\n \tdescribing the type of an <<def_object,object>>.\n \n [[def_octopus]]octopus::\n@@ -217,7 +217,7 @@ GIT Glossary\n \tat least one upstream project which they track. By default\n \t'<<def_origin,origin>>' is used for that purpose. New upstream updates\n \twill be fetched into remote tracking branches named\n-\t<<def_origin,origin>>/name-of-upstream-branch, which you can see using\n+\torigin/name-of-upstream-branch, which you can see using\n \t\"git <<def_branch,branch>> -r\".\n \n [[def_pack]]pack::\n@@ -271,14 +271,15 @@ GIT Glossary\n \t<<def_reachable,reachable>> from that <<def_commit,commit>>. More\n \tgenerally, one <<def_object,object>> is <<def_reachable,reachable>> from\n \tanother if we can reach the one from the other by a <<def_chain,chain>>\n-\tthat follows tags to whatever they <<def_tag,tag>>, commits to their\n-\tparents or trees, and trees to the trees or blobs that they contain.\n+\tthat follows <<def_tag,tags>> to whatever they tag,\n+\t<<def_commit_object,commits>> to their parents or trees, and\n+\t<<def_tree_object,trees>> to the trees or <<def_blob_object,blobs>>\n+\tthat they contain.\n \n [[def_rebase]]rebase::\n-\tTo <<def_clean,clean>> a <<def_branch,branch>> by starting from the\n-\t<<def_head,head>> of the main line of development\n-\t(\"<<def_master,master>>\"), and reapply the (possibly cherry-picked)\n-\tchanges from that <<def_branch,branch>>.\n+\tTo reapply a series of changes from a <<def_branch,branch>> to a\n+\tdifferent base, and reset the <<def_head,head>> of that branch\n+\tto the result.\n \n [[def_ref]]ref::\n \tA 40-byte hex representation of a <<def_SHA1,SHA1>> or a name that\n@@ -290,19 +291,18 @@ GIT Glossary\n \t<<def_push,push>> to describe the mapping between remote <<def_ref,ref>>\n \tand local <<def_ref,ref>>. They are combined with a colon in the format\n \t<src>:<dst>, preceded by an optional plus sign, +. For example: `git\n-\t<<def_fetch,fetch>> $URL\n-\trefs/heads/<<def_master,master>>:refs/heads/<<def_origin,origin>>` means\n-\t\"grab the <<def_master,master>> <<def_branch,branch>> <<def_head,head>>\n-\tfrom the $URL and store it as my <<def_origin,origin>>\n+\tfetch $URL refs/heads/master:refs/heads/origin` means\n+\t\"grab the master <<def_branch,branch>> <<def_head,head>>\n+\tfrom the $URL and store it as my origin\n \t<<def_branch,branch>> <<def_head,head>>\". And `git <<def_push,push>>\n-\t$URL refs/heads/<<def_master,master>>:refs/heads/to-upstream` means\n-\t\"publish my <<def_master,master>> <<def_branch,branch>>\n+\t$URL refs/heads/master:refs/heads/to-upstream` means\n+\t\"publish my master <<def_branch,branch>>\n \t<<def_head,head>> as to-upstream <<def_branch,branch>> at $URL\". See\n \talso gitlink:git-push[1]\n \n [[def_repository]]repository::\n \tA collection of refs together with an <<def_object_database,object\n-\tdatabase>> containing all objects, which are <<def_reachable,reachable>>\n+\tdatabase>> containing all objects which are <<def_reachable,reachable>>\n \tfrom the refs, possibly accompanied by meta data from one or more\n \tporcelains. A <<def_repository,repository>> can share an\n \t<<def_object_database,object database>> with other repositories.\n@@ -334,12 +334,12 @@ GIT Glossary\n \tobject>>). This is sometimes useful when you are interested only in the\n \trecent history of a project even though the real history recorded in the\n \tupstream is much larger. A <<def_shallow_repository,shallow repository>>\n-\tis created by giving `--depth` option to gitlink:git-clone[1], and its\n-\thistory can be later deepened with gitlink:git-fetch[1].\n+\tis created by giving the `--depth` option to gitlink:git-clone[1], and\n+\tits history can be later deepened with gitlink:git-fetch[1].\n \n [[def_symref]]symref::\n \tSymbolic reference: instead of containing the <<def_SHA1,SHA1>> id\n-\titself, it is of the format '<<def_ref,ref>>: refs/some/thing' and when\n+\titself, it is of the format 'ref: refs/some/thing' and when\n \treferenced, it recursively dereferences to this reference. 'HEAD' is a\n \tprime example of a <<def_symref,symref>>. Symbolic references are\n \tmanipulated with the gitlink:git-symbolic-ref[1] command.\n@@ -347,11 +347,11 @@ GIT Glossary\n [[def_tag]]tag::\n \tA <<def_ref,ref>> pointing to a <<def_tag,tag>> or\n \t<<def_commit_object,commit object>>. In contrast to a <<def_head,head>>,\n-\ta <<def_tag,tag>> is not changed by a <<def_commit,commit>>. Tags (not\n-\t<<def_tag,tag>> objects) are stored in `$GIT_DIR/refs/tags/`. A git\n-\t<<def_tag,tag>> has nothing to do with a Lisp <<def_tag,tag>> (which is\n-\tcalled <<def_object_type,object type>> in git's context). A\n-\t<<def_tag,tag>> is most typically used to mark a particular point in the\n+\ta tag is not changed by a <<def_commit,commit>>. Tags (not\n+\t<<def_tag_object,tag objects>>) are stored in `$GIT_DIR/refs/tags/`. A\n+\tgit tag has nothing to do with a Lisp tag (which would be\n+\tcalled an <<def_object_type,object type>> in git's context). A\n+\ttag is most typically used to mark a particular point in the\n \t<<def_commit,commit>> ancestry <<def_chain,chain>>.\n \n [[def_tag_object]]tag object::\n@@ -383,7 +383,7 @@ GIT Glossary\n \n [[def_tree_object]]tree object::\n \tAn <<def_object,object>> containing a list of file names and modes along\n-\twith refs to the associated blob and/or <<def_tree,tree>> objects. A\n+\twith refs to the associated blob and/or tree objects. A\n \t<<def_tree,tree>> is equivalent to a <<def_directory,directory>>.\n \n [[def_tree-ish]]tree-ish::\n@@ -393,8 +393,8 @@ GIT Glossary\n \t<<def_tree_object,tree object>>.\n \n [[def_unmerged_index]]unmerged index::\n-\tAn <<def_index,index>> which contains <<def_unmerged_index,unmerged\n-\tindex>> entries.\n+\tAn <<def_index,index>> which contains unmerged\n+\t<<def_index_entry,index entries>>.\n \n [[def_unreachable_object]]unreachable object::\n \tAn <<def_object,object>> which is not <<def_reachable,reachable>> from a\n-- \n1.5.0.3.31.ge47c\n"},{"id":"37449","messageId":"32944.991978775$1174274339@news.gmane.org","threadId":"7306","inReplyTo":"11742742812465-git-send-email-","subject":"[PATCH] user-manual: introduce \"branch\" and \"branch head\" differently","fromName":"J. Bruce Fields","fromEmail":"bfields@citi.umich.edu","sentAt":"2007-03-19T03:18:01Z","receivedAt":"2007-03-19T03:18:01Z","isPatch":true,"sender":{"key":"bfields@citi.umich.edu","avatar":null},"body":"From: J. Bruce Fields <bfields@citi.umich.edu>\n\nI was using \"branch\" to mean \"head\", but that's perhaps a little\nsloppy; so instead start by using the terms \"branch head\" and \"head\",\nwhile still quickly falling back on \"branch\", since that's what\npeople actually say more frequently.\n\nAlso include glossary references on the first uses of \"head\" and \"tag\".\n\nSigned-off-by: \"J. Bruce Fields\" <bfields@citi.umich.edu>\n---\n Documentation/user-manual.txt |   43 ++++++++++++++++++++---------------------\n 1 files changed, 21 insertions(+), 22 deletions(-)\n\ndiff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt\nindex 6df5e61..3ed9f84 100644\n--- a/Documentation/user-manual.txt\n+++ b/Documentation/user-manual.txt\n@@ -288,21 +288,22 @@ collection of files.  It stores the history as a compressed\n collection of interrelated snapshots (versions) of the project's\n contents.\n \n-A single git repository may contain multiple branches.  Each branch\n-is a bookmark referencing a particular point in the project history.\n-The gitlink:git-branch[1] command shows you the list of branches:\n+A single git repository may contain multiple branches.  It keeps track\n+of them by keeping a list of <<def_head,heads>> which reference the\n+latest version on each branch; the gitlink:git-branch[1] command shows\n+you the list of branch heads:\n \n ------------------------------------------------\n $ git branch\n * master\n ------------------------------------------------\n \n-A freshly cloned repository contains a single branch, named \"master\",\n-and the working directory contains the version of the project\n-referred to by the master branch.\n+A freshly cloned repository contains a single branch head, named\n+\"master\", and working directory is initialized to the state of\n+the project referred to by \"master\".\n \n-Most projects also use tags.  Tags, like branches, are references\n-into the project's history, and can be listed using the\n+Most projects also use <<def_tag,tags>>.  Tags, like heads, are\n+references into the project's history, and can be listed using the\n gitlink:git-tag[1] command:\n \n ------------------------------------------------\n@@ -320,9 +321,9 @@ v2.6.13\n ------------------------------------------------\n \n Tags are expected to always point at the same version of a project,\n-while branches are expected to advance as development progresses.\n+while heads are expected to advance as development progresses.\n \n-Create a new branch pointing to one of these versions and check it\n+Create a new branch head pointing to one of these versions and check it\n out using gitlink:git-checkout[1]:\n \n ------------------------------------------------\n@@ -346,10 +347,10 @@ the current branch to point at v2.6.17 instead, with\n $ git reset --hard v2.6.17\n ------------------------------------------------\n \n-Note that if the current branch was your only reference to a\n+Note that if the current branch head was your only reference to a\n particular point in history, then resetting that branch may leave you\n-with no way to find the history it used to point to; so use this\n-command carefully.\n+with no way to find the history it used to point to; so use this command\n+carefully.\n \n Understanding History: Commits\n ------------------------------\n@@ -452,17 +453,15 @@ be replaced with another letter or number.\n Understanding history: What is a branch?\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n-Though we've been using the word \"branch\" to mean a kind of reference\n-to a particular commit, the word branch is also commonly used to\n-refer to the line of commits leading up to that point.  In the\n-example above, git may think of the branch named \"A\" as just a\n-pointer to one particular commit, but we may refer informally to the\n-line of three commits leading up to that point as all being part of\n+When we need to be precise, we will use the word \"branch\" to mean a line\n+of development, and \"branch head\" (or just \"head\") to mean a reference\n+to the most recent commit on a branch.  In the example above, the branch\n+head named \"A\" is a pointer to one particular commit, but we refer to\n+the line of three commits leading up to that point as all being part of\n \"branch A\".\n \n-If we need to make it clear that we're just talking about the most\n-recent commit on the branch, we may refer to that commit as the\n-\"head\" of the branch.\n+However, when no confusion will result, we often just use the term\n+\"branch\" both for branches and for branch heads.\n \n Manipulating branches\n ---------------------\n-- \n1.5.0.3.31.ge47c\n"},{"id":"37464","messageId":"7vaby9n98u.fsf@assigned-by-dhcp.cox.net","threadId":"7306","inReplyTo":"11742742811304-git-send-email-","subject":"Re: [PATCH] glossary: stop generating automatically","fromName":"Junio C Hamano","fromEmail":"junkio@cox.net","sentAt":"2007-03-19T04:32:49Z","receivedAt":"2007-03-19T04:32:49Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"J. Bruce Fields\" <bfields@citi.umich.edu> writes:\n\n> From: J. Bruce Fields <bfields@citi.umich.edu>\n>\n> The sort_glossary.pl script sorts the glossary, checks for duplicates,\n> and automatically adds cross-references.\n>\n> But it's not so hard to do all that by hand, and sometimes the automatic\n> cross-references are a little wrong; so let's run the script one last\n> time and check in its output.\n\nThis initially raised my eyebrow but after looking at the next\npatch, I tend to agree why automated stuff needs to be lot\nbetter, or we forget about automation and maintain that by\nhand.\n\nDscho, preference?\n"},{"id":"37497","messageId":"Pine.LNX.4.63.0703191443420.22628@wbgn013.biozentrum.uni-wuerzburg.de","threadId":"7306","inReplyTo":"11742742811304-git-send-email-","subject":"Re: [PATCH] glossary: stop generating automatically","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2007-03-19T13:50:51Z","receivedAt":"2007-03-19T13:50:51Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Hi,\n\nOn Sun, 18 Mar 2007, J. Bruce Fields wrote:\n\n> Note: to make the output fit better into the user manual I also deleted \n> the acknowledgements at the end, which was maybe a little rude; feel \n> free to object and I can find a different solution.\n\nFine with me.\n\nCiao,\nDscho\n"},{"id":"37499","messageId":"Pine.LNX.4.63.0703191455550.22628@wbgn013.biozentrum.uni-wuerzburg.de","threadId":"7306","inReplyTo":"7vaby9n98u.fsf@assigned-by-dhcp.cox.net","subject":"Re: [PATCH] glossary: stop generating automatically","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2007-03-19T13:56:28Z","receivedAt":"2007-03-19T13:56:28Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Hi,\n\nOn Sun, 18 Mar 2007, Junio C Hamano wrote:\n\n> \"J. Bruce Fields\" <bfields@citi.umich.edu> writes:\n> \n> > From: J. Bruce Fields <bfields@citi.umich.edu>\n> >\n> > The sort_glossary.pl script sorts the glossary, checks for duplicates,\n> > and automatically adds cross-references.\n> >\n> > But it's not so hard to do all that by hand, and sometimes the automatic\n> > cross-references are a little wrong; so let's run the script one last\n> > time and check in its output.\n> \n> This initially raised my eyebrow but after looking at the next\n> patch, I tend to agree why automated stuff needs to be lot\n> better, or we forget about automation and maintain that by\n> hand.\n> \n> Dscho, preference?\n\nNone at the moment. I am deeply involved in a project, and have next to no \ncycles to spend on Git, let alone documentation :-(\n\nCiao,\nDscho\n"}]}