summaryrefslogtreecommitdiff
path: root/Documentation/howto/new-command.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2013-02-05 16:13:32 -0800
committerJunio C Hamano <gitster@pobox.com>2013-02-05 16:13:32 -0800
commite34c7e2b51c02a761a034b877b852dc0dbccf101 (patch)
tree2c80451e27d6fda5c0745270fee17da9e7bc2d1e /Documentation/howto/new-command.txt
parent6d81ce0543c2fb7177c08491ba31a69aa54b7930 (diff)
parentafeef30c34116ddc4a091d497f5ac8f4cdde7c65 (diff)
downloadgit-e34c7e2b51c02a761a034b877b852dc0dbccf101.tar.gz
Merge branch 'ta/doc-no-small-caps'
Update documentation to change "GIT" which was a poor-man's small caps to "Git". The latter was the intended spelling. Also change "git" spelled in all-lowercase to "Git" when it refers to the system as the whole or the concept it embodies, as opposed to the command the end users would type. * ta/doc-no-small-caps: Documentation: StGit is the right spelling, not StGIT Documentation: describe the "repository" in repository-layout Documentation: add a description for 'gitfile' to glossary Documentation: do not use undefined terms git-dir and git-file Documentation: the name of the system is 'Git', not 'git' Documentation: avoid poor-man's small caps GIT
Diffstat (limited to 'Documentation/howto/new-command.txt')
-rw-r--r--Documentation/howto/new-command.txt20
1 files changed, 10 insertions, 10 deletions
diff --git a/Documentation/howto/new-command.txt b/Documentation/howto/new-command.txt
index 36502f6718..2abc3a0a0e 100644
--- a/Documentation/howto/new-command.txt
+++ b/Documentation/howto/new-command.txt
@@ -1,25 +1,25 @@
From: Eric S. Raymond <esr@thyrsus.com>
Abstract: This is how-to documentation for people who want to add extension
- commands to git. It should be read alongside api-builtin.txt.
+ commands to Git. It should be read alongside api-builtin.txt.
Content-type: text/asciidoc
How to integrate new subcommands
================================
This is how-to documentation for people who want to add extension
-commands to git. It should be read alongside api-builtin.txt.
+commands to Git. It should be read alongside api-builtin.txt.
Runtime environment
-------------------
-git subcommands are standalone executables that live in the git exec
+Git subcommands are standalone executables that live in the Git exec
path, normally /usr/lib/git-core. The git executable itself is a
thin wrapper that knows where the subcommands live, and runs them by
passing command-line arguments to them.
-(If "git foo" is not found in the git exec path, the wrapper
+(If "git foo" is not found in the Git exec path, the wrapper
will look in the rest of your $PATH for it. Thus, it's possible
-to write local git extensions that don't live in system space.)
+to write local Git extensions that don't live in system space.)
Implementation languages
------------------------
@@ -30,13 +30,13 @@ Perl.
While we strongly encourage coding in portable C for portability,
these specific scripting languages are also acceptable. We won't
accept more without a very strong technical case, as we don't want
-to broaden the git suite's required dependencies. Import utilities,
+to broaden the Git suite's required dependencies. Import utilities,
surgical tools, remote helpers and other code at the edges of the
-git suite are more lenient and we allow Python (and even Tcl/tk),
+Git suite are more lenient and we allow Python (and even Tcl/tk),
but they should not be used for core functions.
This may change in the future. Especially Python is not allowed in
-core because we need better Python integration in the git Windows
+core because we need better Python integration in the Git Windows
installer before we can be confident people in that environment
won't experience an unacceptably large loss of capability.
@@ -54,7 +54,7 @@ functions available to built-in commands written in C.
What every extension command needs
----------------------------------
-You must have a man page, written in asciidoc (this is what git help
+You must have a man page, written in asciidoc (this is what Git help
followed by your subcommand name will display). Be aware that there is
a local asciidoc configuration and macros which you should use. It's
often helpful to start by cloning an existing page and replacing the
@@ -74,7 +74,7 @@ Integrating a command
---------------------
Here are the things you need to do when you want to merge a new
-subcommand into the git tree.
+subcommand into the Git tree.
1. Don't forget to sign off your patch!