Documentation: avoid poor-man's small caps GIT
authorThomas Ackermann <th.acker@arcor.de>
Mon, 21 Jan 2013 19:16:20 +0000 (20:16 +0100)
committerJunio C Hamano <gitster@pobox.com>
Fri, 1 Feb 2013 21:53:25 +0000 (13:53 -0800)
In the earlier days, we used to spell the name of the system as GIT,
to simulate as if it were typeset with capital G and IT in small
caps.  Later we stopped doing so at around 1.6.5 days.

Let's stop doing so throughout the documentation.  The name to refer
to the whole system (and the concept it embodies) is "Git"; the
command end-users type is "git".  And document this in the coding
guideline.

Signed-off-by: Thomas Ackermann <th.acker@arcor.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
28 files changed:
Documentation/CodingGuidelines
Documentation/SubmittingPatches
Documentation/asciidoc.conf
Documentation/everyday.txt
Documentation/git-clone.txt
Documentation/git-cvsexportcommit.txt
Documentation/git-cvsserver.txt
Documentation/git-daemon.txt
Documentation/git-mv.txt
Documentation/git-send-email.txt
Documentation/git-tools.txt
Documentation/git-update-ref.txt
Documentation/git.txt
Documentation/gitcore-tutorial.txt
Documentation/gitglossary.txt
Documentation/gittutorial.txt
Documentation/gitweb.txt
Documentation/gitworkflows.txt
Documentation/glossary-content.txt
Documentation/howto-index.sh
Documentation/howto/rebase-from-internal-branch.txt
Documentation/howto/revert-branch-rebase.txt
Documentation/howto/setup-git-server-over-http.txt
Documentation/technical/api-index-skel.txt
Documentation/technical/index-format.txt
Documentation/technical/pack-format.txt
Documentation/user-manual.txt
README

index 69f7e9b76c3f9b87b7951fb0df6a9720edadeb3e..423ea666f53182950426b4272551800be91f5595 100644 (file)
@@ -230,3 +230,8 @@ Writing Documentation:
    valid usage.  "*" has its own pair of brackets, because it can
    (optionally) be specified only when one or more of the letters is
    also provided.
+
+  A note on notation:
+   Use 'git' (all lowercase) when talking about commands i.e. something
+   the user would type into a shell and use 'Git' (uppercase first letter)
+   when talking about the version control system and its properties.
index 90133d8c3b2ea7ea8af55a2bac0876b10aff8f3e..e83118896f0932c9f485cfb8518995d60ddd166a 100644 (file)
@@ -206,7 +206,7 @@ patch.
 
 To improve tracking of who did what, we've borrowed the
 "sign-off" procedure from the Linux kernel project on patches
-that are being emailed around.  Although core GIT is a lot
+that are being emailed around.  Although core Git is a lot
 smaller project it is a good discipline to follow it.
 
 The sign-off is a simple line at the end of the explanation for
index 1273a85c8a45c225a24574937c35565774e87196..2c16c536ba830ec12bbf335d09f689d23e325197 100644 (file)
@@ -4,7 +4,7 @@
 #
 # Note, {0} is the manpage section, while {target} is the command.
 #
-# Show GIT link as: <command>(<section>); if section is defined, else just show
+# Show Git link as: <command>(<section>); if section is defined, else just show
 # the command.
 
 [macros]
index 048337b40f8ebdaf4adda90a243f8d89c0aa8a00..6acfd33df603101bf4e7110ab306903f28f13358 100644 (file)
@@ -1,4 +1,4 @@
-Everyday GIT With 20 Commands Or So
+Everyday Git With 20 Commands Or So
 ===================================
 
 <<Individual Developer (Standalone)>> commands are essential for
@@ -229,7 +229,7 @@ commands in addition to the ones needed by participants.
 Examples
 ~~~~~~~~
 
-My typical GIT day.::
+My typical Git day.::
 +
 ------------
 $ git status <1>
index 7fefdb0384307d0029eb6016bdf37735e84ebdd8..597048b3068c88701d190301b50879dceb6b4cd6 100644 (file)
@@ -125,7 +125,7 @@ objects from the source repository into a pack in the cloned repository.
        No checkout of HEAD is performed after the clone is complete.
 
 --bare::
-       Make a 'bare' GIT repository.  That is, instead of
+       Make a 'bare' Git repository.  That is, instead of
        creating `<directory>` and placing the administrative
        files in `<directory>/.git`, make the `<directory>`
        itself the `$GIT_DIR`. This obviously implies the `-n`
index 7f79cec3f8e9f90f61e461521eed2ca23fba69d1..a671e22c3d034dddbdb2ccf8ffc35f1aef3ee3ca 100644 (file)
@@ -15,7 +15,7 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-Exports a commit from GIT to a CVS checkout, making it easier
+Exports a commit from Git to a CVS checkout, making it easier
 to merge patches from a git repository into a CVS repository.
 
 Specify the name of a CVS checkout using the -w switch or execute it
index 88d814af0e050eb3b31f5763cbf12f03a5f6cbc3..36d069bd65ab953319988e20207dc8f0f145be07 100644 (file)
@@ -72,9 +72,9 @@ plugin. Most functionality works fine with both of these clients.
 LIMITATIONS
 -----------
 
-CVS clients cannot tag, branch or perform GIT merges.
+CVS clients cannot tag, branch or perform Git merges.
 
-'git-cvsserver' maps GIT branches to CVS modules. This is very different
+'git-cvsserver' maps Git branches to CVS modules. This is very different
 from what most CVS users would expect since in CVS modules usually represent
 one or more directories.
 
@@ -130,7 +130,7 @@ Then provide your password via the pserver method, for example:
 ------
    cvs -d:pserver:someuser:somepassword <at> server/path/repo.git co <HEAD_name>
 ------
-No special setup is needed for SSH access, other than having GIT tools
+No special setup is needed for SSH access, other than having Git tools
 in the PATH. If you have clients that do not accept the CVS_SERVER
 environment variable, you can rename 'git-cvsserver' to `cvs`.
 
@@ -197,7 +197,7 @@ allowing access over SSH.
    shell is bash, .bashrc may be a reasonable alternative.
 
 5. Clients should now be able to check out the project. Use the CVS 'module'
-   name to indicate what GIT 'head' you want to check out.  This also sets the
+   name to indicate what Git 'head' you want to check out.  This also sets the
    name of your newly checked-out directory, unless you tell it otherwise with
    `-d <dir_name>`.  For example, this checks out 'master' branch to the
    `project-master` directory:
index 7e5098a95e48bbe0a82630e2ca5d4cebec6c3112..80de4f62666bc98be240e8595e27810b5911678a 100644 (file)
@@ -51,7 +51,7 @@ OPTIONS
 
 --base-path=<path>::
        Remap all the path requests as relative to the given path.
-       This is sort of "GIT root" - if you run 'git daemon' with
+       This is sort of "Git root" - if you run 'git daemon' with
        '--base-path=/srv/git' on example.com, then if you later try to pull
        'git://example.com/hello.git', 'git daemon' will interpret the path
        as '/srv/git/hello.git'.
@@ -73,7 +73,7 @@ OPTIONS
        whitelist.
 
 --export-all::
-       Allow pulling from all directories that look like GIT repositories
+       Allow pulling from all directories that look like Git repositories
        (have the 'objects' and 'refs' subdirectories), even if they
        do not have the 'git-daemon-export-ok' file.
 
index e3c84486141685e2f128f64f46d24c36cc45e97f..e93fcb49fdca2d5e7987e10b5234c3d216fb47d6 100644 (file)
@@ -34,7 +34,7 @@ OPTIONS
 -k::
         Skip move or rename actions which would lead to an error
        condition. An error happens when a source is neither existing nor
-        controlled by GIT, or when it would overwrite an existing
+       controlled by Git, or when it would overwrite an existing
         file unless '-f' is given.
 -n::
 --dry-run::
index eeb561cf147bcd40a220c76599ceeb714a7c7bf7..44a1f7c4e8efbc78813de7c3ba13816e68c984cd 100644 (file)
@@ -67,7 +67,7 @@ The --cc option must be repeated for each user you want on the cc list.
 When '--compose' is used, git send-email will use the From, Subject, and
 In-Reply-To headers specified in the message. If the body of the message
 (what you type after the headers and a blank line) only contains blank
-(or GIT: prefixed) lines the summary won't be sent, but From, Subject,
+(or Git: prefixed) lines the summary won't be sent, but From, Subject,
 and In-Reply-To headers will be used unless they are removed.
 +
 Missing From or In-Reply-To headers will be prompted for.
index a96403cb8cb720dbf094b06a0dc0b430147298fc..2f51b830eaaf8f8ed5ac45b01cc39c8f9eef98cc 100644 (file)
@@ -19,24 +19,24 @@ Alternative/Augmentative Porcelains
 
    Cogito is a version control system layered on top of the git tree history
    storage system. It aims at seamless user interface and ease of use,
-   providing generally smoother user experience than the "raw" Core GIT
+   providing generally smoother user experience than the "raw" Core Git
    itself and indeed many other version control systems.
 
    Cogito is no longer maintained as most of its functionality
-   is now in core GIT.
+   is now in core Git.
 
 
    - *pg* (http://www.spearce.org/category/projects/scm/pg/)
 
-   pg is a shell script wrapper around GIT to help the user manage a set of
+   pg is a shell script wrapper around Git to help the user manage a set of
    patches to files. pg is somewhat like quilt or StGIT, but it does have a
    slightly different feature set.
 
 
    - *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
+   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.
 
 
@@ -45,7 +45,7 @@ History Viewers
 
    - *gitk* (shipped with git-core)
 
-   gitk is a simple Tk GUI for browsing history of GIT repositories easily.
+   gitk is a simple Tk GUI for browsing history of Git repositories easily.
 
 
    - *gitview*  (contrib/)
@@ -55,7 +55,7 @@ History Viewers
 
    - *gitweb* (shipped with git-core)
 
-   GITweb provides full-fledged web interface for GIT repositories.
+   Gitweb provides full-fledged web interface for Git repositories.
 
 
    - *qgit* (http://digilander.libero.it/mcostalba/)
index d377a352433cb38536f42c5b3fc6b80ae2b11f7f..0df13ff6f4231779a5f0663900f34447ff2c1276 100644 (file)
@@ -73,7 +73,7 @@ in ref value.  Log lines are formatted as:
 Where "oldsha1" is the 40 character hexadecimal value previously
 stored in <ref>, "newsha1" is the 40 character hexadecimal value of
 <newvalue> and "committer" is the committer's name, email address
-and date in the standard GIT committer ident format.
+and date in the standard Git committer ident format.
 
 Optionally with -m:
 
index 555250dfa0272f890b6d427ff61b4ea42ba0b814..1aac71ea086e1159c3ab78857484134464fd728b 100644 (file)
@@ -890,7 +890,7 @@ See also the link:howto-index.html[howto] documents for some useful
 examples.
 
 The internals are documented in the
-link:technical/api-index.html[GIT API documentation].
+link:technical/api-index.html[Git API documentation].
 
 Users migrating from CVS may also want to
 read linkgit:gitcvs-migration[7].
index 5325c5a7d5cab3f74c3866319a60d35e4299da2e..6a701dddbf33357f0d0150474dcc3ee22f038b22 100644 (file)
@@ -16,8 +16,8 @@ This tutorial explains how to use the "core" git commands to set up and
 work with a git repository.
 
 If you just need to use git as a revision control system you may prefer
-to start with "A Tutorial Introduction to GIT" (linkgit:gittutorial[7]) or
-link:user-manual.html[the GIT User Manual].
+to start with "A Tutorial Introduction to Git" (linkgit:gittutorial[7]) or
+link:user-manual.html[the Git User Manual].
 
 However, an understanding of these low-level tools can be helpful if
 you want to understand git's internals.
index d77a45aed678522344d58498f1ee20ca14e0895e..6d7b1957449bccb00ea7b4c1157b4a9948503755 100644 (file)
@@ -3,7 +3,7 @@ gitglossary(7)
 
 NAME
 ----
-gitglossary - A GIT Glossary
+gitglossary - A Git Glossary
 
 SYNOPSIS
 --------
index f1cb6f3be67fbb03583a35601791f0db839fbe1b..9dd45c40cbfc135e4f836d736e678ece3a9c2b28 100644 (file)
@@ -656,7 +656,7 @@ digressions that may be interesting at this point are:
   * linkgit:gitworkflows[7]: Gives an overview of recommended
     workflows.
 
-  * link:everyday.html[Everyday GIT with 20 Commands Or So]
+  * link:everyday.html[Everyday Git with 20 Commands Or So]
 
   * linkgit:gitcvs-migration[7]: Git for CVS users.
 
index 168e8bfed644c5f22bfb5e45801884128e306e4a..d364c3a2f98b510ef28e5955bf2843ac42143e21 100644 (file)
@@ -504,7 +504,7 @@ repositories, you can configure Apache like this:
 
 The above configuration expects your public repositories to live under
 '/pub/git' and will serve them as `http://git.domain.org/dir-under-pub-git`,
-both as cloneable GIT URL and as browseable gitweb interface.  If you then
+both as cloneable Git URL and as browseable gitweb interface.  If you then
 start your linkgit:git-daemon[1] with `--base-path=/pub/git --export-all`
 then you can even use the `git://` URL with exactly the same path.
 
index 8b8c6ae5d3f3a3a12b875b106a3bbb5642c8e172..e2e7d65c087cb0fbc12cff62fec5a66b35163f42 100644 (file)
@@ -242,7 +242,7 @@ tag to the tip of 'master' indicating the release version:
 .Release tagging
 [caption="Recipe: "]
 =====================================
-`git tag -s -m "GIT X.Y.Z" vX.Y.Z master`
+`git tag -s -m "Git X.Y.Z" vX.Y.Z master`
 =====================================
 
 You need to push the new tag to a public git server (see
index f928b57f90b0950e9297cff160741683754a454d..7c28aef5de1869a437efe358afea2871919fe587 100644 (file)
@@ -52,7 +52,7 @@
 [[def_cherry-picking]]cherry-picking::
        In <<def_SCM,SCM>> jargon, "cherry pick" means to choose a subset of
        changes out of a series of changes (typically commits) and record them
-       as a new series of changes on top of a different codebase. In GIT, this is
+       as a new series of changes on top of a different codebase. In Git, this is
        performed by the "git cherry-pick" command to extract the change introduced
        by an existing <<def_commit,commit>> and to record it based on the tip
        of the current <<def_branch,branch>> as a new commit.
index 34aa30c5b9ffc617e1519878317c2ae83bed6a6a..8e82e52e9c202c925e8c0cf7bb9fbcb99d3bd827 100755 (executable)
@@ -1,7 +1,7 @@
 #!/bin/sh
 
 cat <<\EOF
-GIT Howto Index
+Git Howto Index
 ===============
 
 Here is a collection of mailing list postings made by various
index 4627ee47f2ce86761344e0a57aed2cada94b6b9c..19ab604f1f859fa3a40e8bd0da2675548056a2c5 100644 (file)
@@ -4,7 +4,7 @@ Cc:     Petr Baudis <pasky@suse.cz>, Linus Torvalds <torvalds@osdl.org>
 Subject: Re: sending changesets from the middle of a git tree
 Date:  Sun, 14 Aug 2005 18:37:39 -0700
 Abstract: In this article, JC talks about how he rebases the
- public "pu" branch using the core GIT tools when he updates
+ public "pu" branch using the core Git tools when he updates
  the "master" branch, and how "rebase" works.  Also discussed
  is how this applies to individual developers who sends patches
  upstream.
@@ -31,7 +31,7 @@ up.  With its basing philosophical ancestry on quilt, this is
 the kind of task StGIT is designed to do.
 
 I just have done a simpler one, this time using only the core
-GIT tools.
+Git tools.
 
 I had a handful of commits that were ahead of master in pu, and I
 wanted to add some documentation bypassing my usual habit of
@@ -96,7 +96,7 @@ you ran fsck-cache, which is normal.  After testing "pu", you
 can run "git prune" to get rid of those original three commits.
 
 While I am talking about "git rebase", I should talk about how
-to do cherrypicking using only the core GIT tools.
+to do cherrypicking using only the core Git tools.
 
 Let's go back to the earlier picture, with different labels.
 
index a59ced8d046eeece06c2b621c21efb088932bf3a..84dd839db43560d5d459f403904ebb3769521064 100644 (file)
@@ -12,10 +12,10 @@ How to revert an existing commit
 ================================
 
 One of the changes I pulled into the 'master' branch turns out to
-break building GIT with GCC 2.95.  While they were well intentioned
+break building Git with GCC 2.95.  While they were well intentioned
 portability fixes, keeping things working with gcc-2.95 was also
 important.  Here is what I did to revert the change in the 'master'
-branch and to adjust the 'pu' branch, using core GIT tools and
+branch and to adjust the 'pu' branch, using core Git tools and
 barebone Porcelain.
 
 First, prepare a throw-away branch in case I screw things up.
index a695f01f0e41aca5285c54d70196386ced64e1cb..e49d7852b302f7c64f186d4a95bc1cdc9e04bf8f 100644 (file)
@@ -53,10 +53,10 @@ In effect, this means you're going to be root, or that you're using a
 preconfigured WebDAV server.
 
 
-Step 1: setup a bare GIT repository
+Step 1: setup a bare Git repository
 -----------------------------------
 
-At the time of writing, git-http-push cannot remotely create a GIT
+At the time of writing, git-http-push cannot remotely create a Git
 repository. So we have to do that at the server side with git. Another
 option is to generate an empty bare repository at the client and copy
 it to the server with a WebDAV client (which is the only option if Git
index 730cfacf783ef26b408f22c13599420db46e28b4..eda8c195c19629dfe836b36d9baaa21ec06199d6 100644 (file)
@@ -1,7 +1,7 @@
-GIT API Documents
+Git API Documents
 =================
 
-GIT has grown a set of internal API over time.  This collection
+Git has grown a set of internal API over time.  This collection
 documents them.
 
 ////////////////////////////////////////////////////////////////
index 73241548381fcb0b3c0dbd2cb09f9526a64e637d..6a05ee2363a459cee7a4a24988ed0370d007b63d 100644 (file)
@@ -1,4 +1,4 @@
-GIT index format
+Git index format
 ================
 
 == The git index file has the following format
@@ -21,9 +21,9 @@ GIT index format
    - Extensions
 
      Extensions are identified by signature. Optional extensions can
-     be ignored if GIT does not understand them.
+     be ignored if Git does not understand them.
 
-     GIT currently supports cached tree and resolve undo extensions.
+     Git currently supports cached tree and resolve undo extensions.
 
      4-byte extension signature. If the first byte is 'A'..'Z' the
      extension is optional and can be ignored.
index a7871fb865d9c41f26011d6fd06c531538c2379e..0e37ec9de51bd4ecb99cecce1958c6cea9bea715 100644 (file)
@@ -1,4 +1,4 @@
-GIT pack format
+Git pack format
 ===============
 
 == pack-*.pack files have the following format:
@@ -9,7 +9,7 @@ GIT pack format
          The signature is: {'P', 'A', 'C', 'K'}
 
      4-byte version number (network byte order):
-         GIT currently accepts version number 2 or 3 but
+        Git currently accepts version number 2 or 3 but
          generates version 2 only.
 
      4-byte number of objects contained in the pack (network byte order)
index 1b377dc20736320fb442255c88310d62078b21e0..c93e1a8914b7c0e1140e147065160129645c70be 100644 (file)
@@ -2299,7 +2299,7 @@ Here are some of the scripts that simplify all this even further.
 
 -------------------------------------------------
 ==== update script ====
-# Update a branch in my GIT tree.  If the branch to be updated
+# Update a branch in my Git tree.  If the branch to be updated
 # is origin, then pull from kernel.org.  Otherwise merge
 # origin/master branch into test|release branch
 
@@ -2357,7 +2357,7 @@ esac
 
 -------------------------------------------------
 ==== status script ====
-# report on status of my ia64 GIT tree
+# report on status of my ia64 Git tree
 
 gb=$(tput setab 2)
 rb=$(tput setab 1)
diff --git a/README b/README
index 49713ea08e6aa107d9e164de6c06a0b8fc5125f4..f7fc0dec28757da649925a02a1d0530cfb1cf5bc 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 ////////////////////////////////////////////////////////////////
 
-       GIT - the stupid content tracker
+       Git - the stupid content tracker
 
 ////////////////////////////////////////////////////////////////