* [PATCH 0/7] Some superficial documentation changes
@ 2008-06-30 21:56 Jonathan Nieder
2008-06-30 22:01 ` [PATCH 1/7] Documentation: fix links to tutorials and other new manual pages Jonathan Nieder
` (6 more replies)
0 siblings, 7 replies; 40+ messages in thread
From: Jonathan Nieder @ 2008-06-30 21:56 UTC (permalink / raw)
To: git; +Cc: Junio C Hamano, Christian Couder, Nguyen Thai Ngoc Duy,
Jon Loeliger
This patch series is an updated version of a patch I sent this morning.
The purpose of the patches is to make the absence of git- commands not
so jarring while reading the manual. It does this by holding fast to a
distinction between programs (like git-clone) and command lines (like
"git clone <repo>").
Issues:
- It is a huge patch touching most of the manpages, not made by any
automated process
- Sometimes it is not clear whether a mention of git-diff, say, is
referring to the `git-diff` program or the command line `git diff`
(without any options). So we guess.
- Most non-git man pages use 'italics' for the names of programs, but I
stuck to `teletype text` because that is what seems to be most common
in the Git docs. If people want to change this, I can send a separate
patch to that end.
- There are not enough cross-references (the "see also" sections are
too often absent).
But at least I was able to check that patch 6/7 (which redistributes the
dashes in the world) doesn't touch anything but spaces and hyphens.
Hopefully that should make this easier to review.
Enjoy...
Documentation: fix links to tutorials and other new manual pages
whitespace fix in Documentation/git-repack.txt
Documentation: complicate example of "man git-blah"
git-daemon(1): don't assume git-daemon in /usr/bin
Documentation: prepare to be consistent about "git-" versus "git "
Documentation: be consistent about "git-" versus "git "
Documentation formatting and cleanup
Documentation/diff-options.txt | 2 +-
Documentation/git-add.txt | 4 +-
Documentation/git-am.txt | 4 +-
Documentation/git-annotate.txt | 2 +-
Documentation/git-apply.txt | 14 ++--
Documentation/git-archimport.txt | 8 +-
Documentation/git-archive.txt | 8 +-
Documentation/git-bisect.txt | 8 +-
Documentation/git-blame.txt | 6 +-
Documentation/git-branch.txt | 16 ++--
Documentation/git-bundle.txt | 41 ++++----
Documentation/git-cat-file.txt | 4 +-
Documentation/git-check-attr.txt | 2 +-
Documentation/git-check-ref-format.txt | 4 +-
Documentation/git-checkout-index.txt | 22 ++--
Documentation/git-checkout.txt | 12 +-
Documentation/git-cherry-pick.txt | 4 +-
Documentation/git-cherry.txt | 10 +-
Documentation/git-citool.txt | 4 +-
Documentation/git-clean.txt | 6 +-
Documentation/git-clone.txt | 14 ++--
Documentation/git-commit-tree.txt | 4 +-
Documentation/git-commit.txt | 28 +++---
Documentation/git-config.txt | 38 ++++----
Documentation/git-count-objects.txt | 4 +-
Documentation/git-cvsexportcommit.txt | 13 ++-
Documentation/git-cvsimport.txt | 20 ++--
Documentation/git-cvsserver.txt | 45 +++++-----
Documentation/git-daemon.txt | 34 ++++----
Documentation/git-describe.txt | 14 ++--
Documentation/git-diff-files.txt | 4 +-
Documentation/git-diff-index.txt | 34 ++++----
Documentation/git-diff-tree.txt | 18 ++--
Documentation/git-diff.txt | 18 ++--
Documentation/git-fast-export.txt | 10 +-
Documentation/git-fast-import.txt | 24 +++---
Documentation/git-fetch-pack.txt | 18 ++--
Documentation/git-fetch.txt | 4 +-
Documentation/git-filter-branch.txt | 14 ++--
Documentation/git-fmt-merge-msg.txt | 4 +-
Documentation/git-for-each-ref.txt | 8 +-
Documentation/git-format-patch.txt | 6 +-
Documentation/git-fsck-objects.txt | 2 +-
Documentation/git-fsck.txt | 10 +-
Documentation/git-gc.txt | 16 ++--
Documentation/git-get-tar-commit-id.txt | 8 +-
Documentation/git-grep.txt | 4 +-
Documentation/git-gui.txt | 24 +++---
Documentation/git-hash-object.txt | 4 +-
Documentation/git-help.txt | 6 +-
Documentation/git-http-fetch.txt | 4 +-
Documentation/git-http-push.txt | 2 +-
Documentation/git-imap-send.txt | 6 +-
Documentation/git-index-pack.txt | 12 +-
Documentation/git-init-db.txt | 2 +-
Documentation/git-init.txt | 6 +-
Documentation/git-instaweb.txt | 8 +-
Documentation/git-log.txt | 6 +-
Documentation/git-lost-found.txt | 2 +-
Documentation/git-ls-files.txt | 10 +-
Documentation/git-ls-remote.txt | 4 +-
Documentation/git-ls-tree.txt | 2 +-
Documentation/git-mailinfo.txt | 8 +-
Documentation/git-mailsplit.txt | 2 +-
Documentation/git-merge-base.txt | 10 +-
Documentation/git-merge-file.txt | 14 ++--
Documentation/git-merge-index.txt | 20 ++--
Documentation/git-merge-one-file.txt | 4 +-
Documentation/git-merge-tree.txt | 2 +-
Documentation/git-merge.txt | 24 +++--
Documentation/git-mergetool.txt | 18 ++--
Documentation/git-mktag.txt | 2 +-
Documentation/git-mktree.txt | 2 +-
Documentation/git-mv.txt | 6 +-
Documentation/git-name-rev.txt | 8 +-
Documentation/git-pack-objects.txt | 10 +-
Documentation/git-pack-redundant.txt | 10 +-
Documentation/git-pack-refs.txt | 4 +-
Documentation/git-patch-id.txt | 4 +-
Documentation/git-peek-remote.txt | 6 +-
Documentation/git-prune-packed.txt | 2 +-
Documentation/git-prune.txt | 14 ++--
Documentation/git-pull.txt | 5 +-
Documentation/git-push.txt | 4 +-
Documentation/git-quiltimport.txt | 2 +-
Documentation/git-read-tree.txt | 46 +++++-----
Documentation/git-rebase.txt | 38 ++++----
Documentation/git-receive-pack.txt | 24 +++---
Documentation/git-relink.txt | 2 +-
Documentation/git-remote.txt | 12 +-
Documentation/git-repack.txt | 15 ++--
Documentation/git-repo-config.txt | 2 +-
Documentation/git-request-pull.txt | 2 +-
Documentation/git-rerere.txt | 14 ++--
Documentation/git-reset.txt | 2 +-
Documentation/git-rev-list.txt | 16 ++--
Documentation/git-rev-parse.txt | 18 ++--
Documentation/git-revert.txt | 2 +-
Documentation/git-rm.txt | 10 +-
Documentation/git-send-email.txt | 2 +-
Documentation/git-send-pack.txt | 16 ++--
Documentation/git-shell.txt | 2 +-
Documentation/git-shortlog.txt | 6 +-
Documentation/git-show-branch.txt | 8 +-
Documentation/git-show-index.txt | 6 +-
Documentation/git-show-ref.txt | 10 +-
Documentation/git-show.txt | 8 +-
Documentation/git-stash.txt | 22 ++--
Documentation/git-status.txt | 6 +-
Documentation/git-stripspace.txt | 2 +-
Documentation/git-submodule.txt | 14 ++--
Documentation/git-svn.txt | 153 +++++++++++++++---------------
Documentation/git-symbolic-ref.txt | 4 +-
Documentation/git-tag.txt | 18 ++--
Documentation/git-tar-tree.txt | 6 +-
Documentation/git-unpack-file.txt | 2 +-
Documentation/git-unpack-objects.txt | 4 +-
Documentation/git-update-index.txt | 26 +++---
Documentation/git-update-ref.txt | 10 +-
Documentation/git-update-server-info.txt | 4 +-
Documentation/git-upload-archive.txt | 4 +-
Documentation/git-upload-pack.txt | 8 +-
Documentation/git-var.txt | 4 +-
Documentation/git-verify-pack.txt | 6 +-
Documentation/git-verify-tag.txt | 4 +-
Documentation/git-web--browse.txt | 10 +-
Documentation/git-whatchanged.txt | 10 +-
Documentation/git-write-tree.txt | 2 +-
Documentation/git.txt | 30 +++---
Documentation/gitattributes.txt | 18 ++--
Documentation/gitcore-tutorial.txt | 127 ++++++++++++-------------
Documentation/gitcvs-migration.txt | 24 +++---
Documentation/gitdiffcore.txt | 34 ++++----
Documentation/githooks.txt | 10 +-
Documentation/gitignore.txt | 8 +-
Documentation/gitk.txt | 3 +-
Documentation/gitrepository-layout.txt | 24 +++---
Documentation/gittutorial-2.txt | 40 ++++----
Documentation/gittutorial.txt | 66 +++++++-------
Documentation/user-manual.txt | 85 ++++++++---------
140 files changed, 961 insertions(+), 964 deletions(-)
^ permalink raw reply [flat|nested] 40+ messages in thread* [PATCH 1/7] Documentation: fix links to tutorials and other new manual pages 2008-06-30 21:56 [PATCH 0/7] Some superficial documentation changes Jonathan Nieder @ 2008-06-30 22:01 ` Jonathan Nieder 2008-06-30 23:30 ` Christian Couder 2008-06-30 22:05 ` [PATCH 2/7] whitespace fix in Documentation/git-repack.txt Jonathan Nieder ` (5 subsequent siblings) 6 siblings, 1 reply; 40+ messages in thread From: Jonathan Nieder @ 2008-06-30 22:01 UTC (permalink / raw) To: git; +Cc: Junio C Hamano, Christian Couder, Jon Loeliger With the conversion of HTML documentation to man pages tutorial.html -> gittutorial (7) tutorial-2.html -> gittutorial-2 (7) cvs-migration.html -> gitcvs-migration (7) diffcore.html -> gitdiffcore (7) repository-layout.html -> gitrepository-layout (5) hooks.html -> githooks (5) glossary.html -> gitglossary (7) core-tutorial.html -> gitcore-tutorial (7) and the automatic update of references to these pages, a little debris was left behind. We clear it away. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/diff-options.txt | 2 +- Documentation/git-add.txt | 2 +- Documentation/git-commit.txt | 4 ++-- Documentation/git-update-server-info.txt | 2 +- Documentation/git.txt | 20 ++++++++++---------- Documentation/gitcore-tutorial.txt | 9 ++++----- Documentation/gitcvs-migration.txt | 12 ++++++------ Documentation/gitrepository-layout.txt | 2 +- Documentation/gittutorial-2.txt | 12 +++++------- Documentation/gittutorial.txt | 8 ++++---- Documentation/user-manual.txt | 7 +++---- 11 files changed, 38 insertions(+), 42 deletions(-) diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt index 5721548..cba90fd 100644 --- a/Documentation/diff-options.txt +++ b/Documentation/diff-options.txt @@ -241,4 +241,4 @@ endif::git-format-patch[] Do not show any source or destination prefix. For more detailed explanation on these common options, see also -linkgit:gitdiffcore[7][diffcore documentation]. +linkgit:gitdiffcore[7]. diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt index b8e3fa6..2b0ccb3 100644 --- a/Documentation/git-add.txt +++ b/Documentation/git-add.txt @@ -107,7 +107,7 @@ Configuration The optional configuration variable 'core.excludesfile' indicates a path to a file containing patterns of file names to exclude from git-add, similar to $GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to -those in info/exclude. See linkgit:gitrepository-layout[5][repository layout]. +those in info/exclude. See linkgit:gitrepository-layout[5]. EXAMPLES diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index d0fe192..656d4db 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -97,7 +97,7 @@ OPTIONS -n:: --no-verify:: This option bypasses the pre-commit and commit-msg hooks. - See also linkgit:githooks[5][hooks]. + See also linkgit:githooks[5]. --allow-empty:: Usually recording a commit that has the exact same tree as its @@ -316,7 +316,7 @@ order). HOOKS ----- This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`, -and `post-commit` hooks. See linkgit:githooks[5][hooks] for more +and `post-commit` hooks. See linkgit:githooks[5] for more information. diff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt index d21be41..0102410 100644 --- a/Documentation/git-update-server-info.txt +++ b/Documentation/git-update-server-info.txt @@ -31,7 +31,7 @@ OUTPUT ------ Currently the command updates the following files. Please see -linkgit:gitrepository-layout[5][repository-layout] for description of +linkgit:gitrepository-layout[5] for description of what they are for: * objects/info/packs diff --git a/Documentation/git.txt b/Documentation/git.txt index a791ce7..27eebfb 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -20,11 +20,11 @@ Git is a fast, scalable, distributed revision control system with an unusually rich command set that provides both high-level operations and full access to internals. -See this linkgit:gittutorial[7][tutorial] to get started, then see +See linkgit:gittutorial[7] to get started, then see link:everyday.html[Everyday Git] for a useful minimum set of commands, and "man git-commandname" for documentation of each command. CVS users may -also want to read linkgit:gitcvs-migration[7][CVS migration]. See -link:user-manual.html[Git User's Manual] for a more in-depth +also want to read linkgit:gitcvs-migration[7]. See +the link:user-manual.html[Git User's Manual] for a more in-depth introduction. The COMMAND is either a name of a Git command (see below) or an alias @@ -182,13 +182,14 @@ See the references above to get started using git. The following is probably more detail than necessary for a first-time user. The link:user-manual.html#git-concepts[git concepts chapter of the -user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial] both provide +user-manual] and linkgit:gitcore-tutorial[7] both provide introductions to the underlying git architecture. See also the link:howto-index.html[howto] documents for some useful examples. -The internals are documented link:technical/api-index.html[here]. +The internals are documented in the +link:technical/api-index.html[GIT API documentation]. GIT COMMANDS ------------ @@ -372,10 +373,9 @@ For a more complete list of ways to spell object names, see File/Directory Structure ------------------------ -Please see the linkgit:gitrepository-layout[5][repository layout] -document. +Please see the linkgit:gitrepository-layout[5] document. -Read linkgit:githooks[5][hooks] for more details about each hook. +Read linkgit:githooks[5] for more details about each hook. Higher level SCMs may provide and manage additional information in the `$GIT_DIR`. @@ -383,7 +383,7 @@ Higher level SCMs may provide and manage additional information in the Terminology ----------- -Please see the linkgit:gitglossary[7][glossary] document. +Please see linkgit:gitglossary[7]. Environment Variables @@ -535,7 +535,7 @@ Discussion[[Discussion]] More detail on the following is available from the link:user-manual.html#git-concepts[git concepts chapter of the -user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial]. +user-manual] and linkgit:gitcore-tutorial[7]. A git project normally consists of a working directory with a ".git" subdirectory at the top level. The .git directory contains, among other diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt index cb4ec40..6bb32a8 100644 --- a/Documentation/gitcore-tutorial.txt +++ b/Documentation/gitcore-tutorial.txt @@ -16,8 +16,8 @@ This tutorial explains how to use the "core" git programs 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 linkgit:gittutorial[7][a tutorial introduction to git] 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. @@ -108,8 +108,7 @@ references in these `refs` subdirectories when you actually start populating your tree. [NOTE] -An advanced user may want to take a look at the -linkgit:gitrepository-layout[5][repository layout] document +An advanced user may want to take a look at linkgit:gitrepository-layout[5] after finishing this tutorial. You have now created your first git repository. Of course, since it's @@ -1589,7 +1588,7 @@ suggested in the previous section may be new to you. You do not have to worry. git supports "shared public repository" style of cooperation you are probably more familiar with as well. -See linkgit:gitcvs-migration[7][git for CVS users] for the details. +See linkgit:gitcvs-migration[7] for the details. Bundling your work together --------------------------- diff --git a/Documentation/gitcvs-migration.txt b/Documentation/gitcvs-migration.txt index 1db3f52..d652658 100644 --- a/Documentation/gitcvs-migration.txt +++ b/Documentation/gitcvs-migration.txt @@ -18,9 +18,9 @@ important than any other. However, you can emulate the CVS model by designating a single shared repository which people can synchronize with; this document explains how to do that. -Some basic familiarity with git is required. This -linkgit:gittutorial[7][tutorial introduction to git] and the -linkgit:gitglossary[7][git glossary] should be sufficient. +Some basic familiarity with git is required. Having gone through +linkgit:gittutorial[7] and +linkgit:gitglossary[7] should be sufficient. Developing against a shared repository -------------------------------------- @@ -81,8 +81,8 @@ Setting Up a Shared Repository ------------------------------ We assume you have already created a git repository for your project, -possibly created from scratch or from a tarball (see the -linkgit:gittutorial[7][tutorial]), or imported from an already existing CVS +possibly created from scratch or from a tarball (see +linkgit:gittutorial[7]), or imported from an already existing CVS repository (see the next section). Assume your existing repo is at /home/alice/myproject. Create a new "bare" @@ -148,7 +148,7 @@ Advanced Shared Repository Management Git allows you to specify scripts called "hooks" to be run at certain points. You can use these, for example, to send all commits to the shared -repository to a mailing list. See linkgit:githooks[5][Hooks used by git]. +repository to a mailing list. See linkgit:githooks[5]. You can enforce finer grained permissions using update hooks. See link:howto/update-hook-example.txt[Controlling access to branches using diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt index 03c52ff..b75508a 100644 --- a/Documentation/gitrepository-layout.txt +++ b/Documentation/gitrepository-layout.txt @@ -135,7 +135,7 @@ hooks:: commands. A handful of sample hooks are installed when `git init` is run, but all of them are disabled by default. To enable, they need to be made executable. - Read linkgit:githooks[5][hooks] for more details about + Read linkgit:githooks[5] for more details about each hook. index:: diff --git a/Documentation/gittutorial-2.txt b/Documentation/gittutorial-2.txt index 31e8a23..2c54670 100644 --- a/Documentation/gittutorial-2.txt +++ b/Documentation/gittutorial-2.txt @@ -12,8 +12,7 @@ git * DESCRIPTION ----------- -You should work through linkgit:gittutorial[7][A tutorial introduction to -git] before reading this tutorial. +You should work through linkgit:gittutorial[7] before reading this tutorial. The goal of this tutorial is to introduce two fundamental pieces of git's architecture--the object database and the index file--and to @@ -390,7 +389,7 @@ in the index file is identical to the one in the working directory. In addition to being the staging area for new commits, the index file is also populated from the object database when checking out a branch, and is used to hold the trees involved in a merge operation. -See the linkgit:gitcore-tutorial[7][core tutorial] and the relevant man +See linkgit:gitcore-tutorial[7] and the relevant man pages for details. What next? @@ -399,20 +398,19 @@ What next? At this point you should know everything necessary to read the man pages for any of the git commands; one good place to start would be with the commands mentioned in link:everyday.html[Everyday git]. You -should be able to find any unknown jargon in the -linkgit:gitglossary[7][Glossary]. +should be able to find any unknown jargon in linkgit:gitglossary[7]. The link:user-manual.html[Git User's Manual] provides a more comprehensive introduction to git. -The linkgit:gitcvs-migration[7][CVS migration] document explains how to +linkgit:gitcvs-migration[7] explains how to import a CVS repository into git, and shows how to use git in a CVS-like way. For some interesting examples of git use, see the link:howto-index.html[howtos]. -For git developers, the linkgit:gitcore-tutorial[7][Core tutorial] goes +For git developers, linkgit:gitcore-tutorial[7] goes into detail on the lower-level git mechanisms involved in, for example, creating a new commit. diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt index d465aab..3d16e3d 100644 --- a/Documentation/gittutorial.txt +++ b/Documentation/gittutorial.txt @@ -392,7 +392,7 @@ see linkgit:git-pull[1] for details. Git can also be used in a CVS-like mode, with a central repository that various users push changes to; see linkgit:git-push[1] and -linkgit:gitcvs-migration[7][git for CVS users]. +linkgit:gitcvs-migration[7]. Exploring history ----------------- @@ -571,9 +571,9 @@ is based: used to create commits, check out working directories, and hold the various trees involved in a merge. -linkgit:gittutorial-2[7][Part two of this tutorial] explains the object +Part two of this tutorial explains the object database, the index file, and a few other odds and ends that you'll -need to make the most of git. +need to make the most of git. You can find it at linkgit:gittutorial-2[7]. If you don't want to continue with that right away, a few other digressions that may be interesting at this point are: @@ -592,7 +592,7 @@ digressions that may be interesting at this point are: * link:everyday.html[Everyday GIT with 20 Commands Or So] - * linkgit:gitcvs-migration[7][git for CVS users]. + * linkgit:gitcvs-migration[7]: Git for CVS users. SEE ALSO -------- diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 64a820b..ca4363f 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1879,8 +1879,7 @@ $ chmod a+x hooks/post-update ------------------------------------------------- (For an explanation of the last two lines, see -linkgit:git-update-server-info[1], and the documentation -linkgit:githooks[5][Hooks used by git].) +linkgit:git-update-server-info[1] and linkgit:githooks[5].) Advertise the URL of proj.git. Anybody else should then be able to clone or pull from that URL, for example with a command line like: @@ -1992,7 +1991,7 @@ the right to push to the same repository. In that case, the correct solution is to retry the push after first updating your work by either a pull or a fetch followed by a rebase; see the <<setting-up-a-shared-repository,next section>> and -linkgit:gitcvs-migration[7][git for CVS users] for more. +linkgit:gitcvs-migration[7] for more. [[setting-up-a-shared-repository]] Setting up a shared repository @@ -2001,7 +2000,7 @@ Setting up a shared repository Another way to collaborate is by using a model similar to that commonly used in CVS, where several developers with special rights all push to and pull from a single shared repository. See -linkgit:gitcvs-migration[7][git for CVS users] for instructions on how to +linkgit:gitcvs-migration[7] for instructions on how to set this up. However, while there is nothing wrong with git's support for shared -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* Re: [PATCH 1/7] Documentation: fix links to tutorials and other new manual pages 2008-06-30 22:01 ` [PATCH 1/7] Documentation: fix links to tutorials and other new manual pages Jonathan Nieder @ 2008-06-30 23:30 ` Christian Couder 0 siblings, 0 replies; 40+ messages in thread From: Christian Couder @ 2008-06-30 23:30 UTC (permalink / raw) To: Jonathan Nieder; +Cc: git, Junio C Hamano, Jon Loeliger Le mardi 1 juillet 2008, Jonathan Nieder a écrit : > With the conversion of HTML documentation to man pages > > tutorial.html -> gittutorial (7) > tutorial-2.html -> gittutorial-2 (7) > cvs-migration.html -> gitcvs-migration (7) > diffcore.html -> gitdiffcore (7) > repository-layout.html -> gitrepository-layout (5) > hooks.html -> githooks (5) > glossary.html -> gitglossary (7) > core-tutorial.html -> gitcore-tutorial (7) > > and the automatic update of references to these pages, > a little debris was left behind. We clear it away. I left them behind because I thought they might be usefull and in fact in some places you also leave them like this: > -to start with linkgit:gittutorial[7][a tutorial introduction to git] > +to start with "A Tutorial Introduction to GIT" (linkgit:gittutorial[7]) I understand that some people might prefer your version though. Thanks, Christian. ^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH 2/7] whitespace fix in Documentation/git-repack.txt 2008-06-30 21:56 [PATCH 0/7] Some superficial documentation changes Jonathan Nieder 2008-06-30 22:01 ` [PATCH 1/7] Documentation: fix links to tutorials and other new manual pages Jonathan Nieder @ 2008-06-30 22:05 ` Jonathan Nieder 2008-06-30 22:10 ` [PATCH 3/7] Documentation: complicate example of "man git-command" Jonathan Nieder ` (4 subsequent siblings) 6 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-06-30 22:05 UTC (permalink / raw) To: git; +Cc: Junio C Hamano Change leading spaces to tabs to match the rest of the file. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/git-repack.txt | 6 +++--- 1 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt index 04d6f1f..9011d06 100644 --- a/Documentation/git-repack.txt +++ b/Documentation/git-repack.txt @@ -55,15 +55,15 @@ OPTIONS Also runs linkgit:git-prune-packed[1]. -l:: - Pass the `--local` option to `git pack-objects`, see + Pass the `--local` option to `git pack-objects`, see linkgit:git-pack-objects[1]. -f:: - Pass the `--no-reuse-delta` option to `git pack-objects`, see + Pass the `--no-reuse-delta` option to `git pack-objects`, see linkgit:git-pack-objects[1]. -q:: - Pass the `-q` option to `git pack-objects`, see + Pass the `-q` option to `git pack-objects`, see linkgit:git-pack-objects[1]. -n:: -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 3/7] Documentation: complicate example of "man git-command" 2008-06-30 21:56 [PATCH 0/7] Some superficial documentation changes Jonathan Nieder 2008-06-30 22:01 ` [PATCH 1/7] Documentation: fix links to tutorials and other new manual pages Jonathan Nieder 2008-06-30 22:05 ` [PATCH 2/7] whitespace fix in Documentation/git-repack.txt Jonathan Nieder @ 2008-06-30 22:10 ` Jonathan Nieder 2008-06-30 23:39 ` Christian Couder 2008-07-01 16:23 ` J. Bruce Fields 2008-06-30 22:15 ` [PATCH 4/7] git-daemon(1): don't assume git-daemon is in /usr/bin Jonathan Nieder ` (3 subsequent siblings) 6 siblings, 2 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-06-30 22:10 UTC (permalink / raw) To: git Cc: Junio C Hamano, Christian Couder, Nguyen Thai Ngoc Duy, Jon Loeliger, J. Bruce Fields The manual page for the command invoked as "git clone" is named git-clone(1), and similarly for the rest of the git commands. Make sure our first example of this in tutorials makes it clear that it is the first two words of a command line that make up the command's name (that is: for example, the effect of "git svn dcommit" is described in git-svn(1)). Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- If I didn't make this change, consistency would mean saying "you can get documentation for a command such as `git-diff` with `man git-diff`", which might not be very enlightening. Documentation/gittutorial.txt | 4 ++-- Documentation/user-manual.txt | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt index 3d16e3d..b833167 100644 --- a/Documentation/gittutorial.txt +++ b/Documentation/gittutorial.txt @@ -20,10 +20,10 @@ for example, to test the latest version, you may prefer to start with the first two chapters of link:user-manual.html[The Git User's Manual]. First, note that you can get documentation for a command such as "git -diff" with: +log --graph" with: ------------------------------------------------ -$ man git-diff +$ man git-log ------------------------------------------------ It is a good idea to introduce yourself to git with your name and diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index ca4363f..36ab372 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -18,7 +18,7 @@ People needing to do actual development will also want to read Further chapters cover more specialized topics. Comprehensive reference documentation is available through the man -pages. For a command such as "git clone", just use +pages. For a command such as "git clone <repo>", just use ------------------------------------------------ $ man git-clone -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* Re: [PATCH 3/7] Documentation: complicate example of "man git-command" 2008-06-30 22:10 ` [PATCH 3/7] Documentation: complicate example of "man git-command" Jonathan Nieder @ 2008-06-30 23:39 ` Christian Couder 2008-07-01 16:23 ` J. Bruce Fields 1 sibling, 0 replies; 40+ messages in thread From: Christian Couder @ 2008-06-30 23:39 UTC (permalink / raw) To: Jonathan Nieder Cc: git, Junio C Hamano, Nguyen Thai Ngoc Duy, Jon Loeliger, J. Bruce Fields Le mardi 1 juillet 2008, Jonathan Nieder a écrit : > The manual page for the command invoked as "git clone" is named > git-clone(1), and similarly for the rest of the git commands. > Make sure our first example of this in tutorials makes it clear > that it is the first two words of a command line that make up the > command's name (that is: for example, the effect of "git svn > dcommit" is described in git-svn(1)). > > Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> > --- > If I didn't make this change, consistency would mean > saying "you can get documentation for a command such > as `git-diff` with `man git-diff`", which might not be > very enlightening. By the way, while at it, maybe we could talk about "git help <cmd/topic>" at the same time. Thanks, Christian. ^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH 3/7] Documentation: complicate example of "man git-command" 2008-06-30 22:10 ` [PATCH 3/7] Documentation: complicate example of "man git-command" Jonathan Nieder 2008-06-30 23:39 ` Christian Couder @ 2008-07-01 16:23 ` J. Bruce Fields 2008-07-01 23:54 ` Junio C Hamano 1 sibling, 1 reply; 40+ messages in thread From: J. Bruce Fields @ 2008-07-01 16:23 UTC (permalink / raw) To: Jonathan Nieder Cc: git, Junio C Hamano, Christian Couder, Nguyen Thai Ngoc Duy, Jon Loeliger On Mon, Jun 30, 2008 at 05:10:25PM -0500, Jonathan Nieder wrote: > The manual page for the command invoked as "git clone" is named > git-clone(1), and similarly for the rest of the git commands. > Make sure our first example of this in tutorials makes it clear > that it is the first two words of a command line that make up the > command's name (that is: for example, the effect of "git svn > dcommit" is described in git-svn(1)). Is this confusion really common? I can see how it might be possible in the case of a subcommand that itself has subcommands, but it seems less likely in the two examples you add below (where the third token is an option or a url). I like your "git svn" example better. Or "git remote" might be good. --b. > > Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> > --- > If I didn't make this change, consistency would mean > saying "you can get documentation for a command such > as `git-diff` with `man git-diff`", which might not be > very enlightening. > > Documentation/gittutorial.txt | 4 ++-- > Documentation/user-manual.txt | 2 +- > 2 files changed, 3 insertions(+), 3 deletions(-) > > diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt > index 3d16e3d..b833167 100644 > --- a/Documentation/gittutorial.txt > +++ b/Documentation/gittutorial.txt > @@ -20,10 +20,10 @@ for example, to test the latest version, you may prefer to start with > the first two chapters of link:user-manual.html[The Git User's Manual]. > > First, note that you can get documentation for a command such as "git > -diff" with: > +log --graph" with: > > ------------------------------------------------ > -$ man git-diff > +$ man git-log > ------------------------------------------------ > > It is a good idea to introduce yourself to git with your name and > diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt > index ca4363f..36ab372 100644 > --- a/Documentation/user-manual.txt > +++ b/Documentation/user-manual.txt > @@ -18,7 +18,7 @@ People needing to do actual development will also want to read > Further chapters cover more specialized topics. > > Comprehensive reference documentation is available through the man > -pages. For a command such as "git clone", just use > +pages. For a command such as "git clone <repo>", just use > > ------------------------------------------------ > $ man git-clone > -- > 1.5.5.GIT > > ^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH 3/7] Documentation: complicate example of "man git-command" 2008-07-01 16:23 ` J. Bruce Fields @ 2008-07-01 23:54 ` Junio C Hamano 2008-07-02 21:31 ` J. Bruce Fields 2008-07-03 6:06 ` Christian Couder 0 siblings, 2 replies; 40+ messages in thread From: Junio C Hamano @ 2008-07-01 23:54 UTC (permalink / raw) To: J. Bruce Fields Cc: Jonathan Nieder, git, Christian Couder, Nguyen Thai Ngoc Duy, Jon Loeliger "J. Bruce Fields" <bfields@fieldses.org> writes: > On Mon, Jun 30, 2008 at 05:10:25PM -0500, Jonathan Nieder wrote: >> The manual page for the command invoked as "git clone" is named >> git-clone(1), and similarly for the rest of the git commands. >> Make sure our first example of this in tutorials makes it clear >> that it is the first two words of a command line that make up the >> command's name (that is: for example, the effect of "git svn >> dcommit" is described in git-svn(1)). > > Is this confusion really common? > > I can see how it might be possible in the case of a subcommand that > itself has subcommands, but it seems less likely in the two examples you > add below (where the third token is an option or a url). I like your > "git svn" example better. Or "git remote" might be good. > > --b. While I agree with the above, are we ready to talk about "git-svn" or "git-remote" that early in the tutorial material? We would want to mention the typesetting convention early in the manuals (git(7), gittutorial(7) and user-manual.html) as well, so how about... Conventions used in this document --------------------------------- When talking about a git subcommand 'cmd', this documentation typesets the name of it like 'git-cmd', and that is the name you ask for its manual page. Examples are typeset like this: `$ git cmd` (`$` is your command prompt, do not actually type it to your shell). Note that a subcommand is specified as the first parameter to the 'git' program when you actually run it from the command line. E.g. a typical command description may go like this: To propagate the changes you made back to the original subversion repository, you would use 'git-svn dcommit' command. It does these things (long description here). Some examples: ------------ $ ... some example command sequence ... $ git svn dcommit ------------ For full details, type: ------------ $ man git-svn ------------ ^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH 3/7] Documentation: complicate example of "man git-command" 2008-07-01 23:54 ` Junio C Hamano @ 2008-07-02 21:31 ` J. Bruce Fields 2008-07-03 1:45 ` Jonathan Nieder 2008-07-03 6:06 ` Christian Couder 1 sibling, 1 reply; 40+ messages in thread From: J. Bruce Fields @ 2008-07-02 21:31 UTC (permalink / raw) To: Junio C Hamano Cc: Jonathan Nieder, git, Christian Couder, Nguyen Thai Ngoc Duy, Jon Loeliger On Tue, Jul 01, 2008 at 04:54:53PM -0700, Junio C Hamano wrote: > "J. Bruce Fields" <bfields@fieldses.org> writes: > > > On Mon, Jun 30, 2008 at 05:10:25PM -0500, Jonathan Nieder wrote: > >> The manual page for the command invoked as "git clone" is named > >> git-clone(1), and similarly for the rest of the git commands. > >> Make sure our first example of this in tutorials makes it clear > >> that it is the first two words of a command line that make up the > >> command's name (that is: for example, the effect of "git svn > >> dcommit" is described in git-svn(1)). > > > > Is this confusion really common? > > > > I can see how it might be possible in the case of a subcommand that > > itself has subcommands, but it seems less likely in the two examples you > > add below (where the third token is an option or a url). I like your > > "git svn" example better. Or "git remote" might be good. > > > > --b. > > While I agree with the above, are we ready to talk about "git-svn" > or "git-remote" that early in the tutorial material? No, but for the purposes of this example it's not necessary to be familiar with the command. (Though it might be less distracting to use something that'll be discussed early on.) > We would want to mention the typesetting convention early in the manuals > (git(7), gittutorial(7) and user-manual.html) as well, so how about... > > Conventions used in this document > --------------------------------- > > When talking about a git subcommand 'cmd', this documentation > typesets the name of it like 'git-cmd', and that is the name you > ask for its manual page. > > Examples are typeset like this: `$ git cmd` (`$` is your command > prompt, do not actually type it to your shell). Note that a > subcommand is specified as the first parameter to the 'git' > program when you actually run it from the command line. I'm not convinced this last sentence is necessary. > > E.g. a typical command description may go like this: > > To propagate the changes you made back to the original subversion > repository, you would use 'git-svn dcommit' command. It does > these things (long description here). Some examples: > > ------------ > $ ... some example command sequence ... > $ git svn dcommit > ------------ Typographical conventions shouldn't need so much explanation. I'm curious: Jonathan, was this the original patch the result of a real-life instance of confusion? What happened? --b. > > For full details, type: > > ------------ > $ man git-svn > ------------ ^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH 3/7] Documentation: complicate example of "man git-command" 2008-07-02 21:31 ` J. Bruce Fields @ 2008-07-03 1:45 ` Jonathan Nieder 2008-07-03 18:18 ` J. Bruce Fields 0 siblings, 1 reply; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 1:45 UTC (permalink / raw) To: J. Bruce Fields Cc: Junio C Hamano, git, Christian Couder, Nguyen Thai Ngoc Duy, Jon Loeliger J. Bruce Fields wrote: > On Tue, Jul 01, 2008 at 04:54:53PM -0700, Junio C Hamano wrote: > >> We would want to mention the typesetting convention early in the manuals >> (git(7), gittutorial(7) and user-manual.html) as well, so how about... >> >> Conventions used in this document >> --------------------------------- >> >> When talking about a git subcommand 'cmd', this documentation >> typesets the name of it like 'git-cmd', and that is the name you >> ask for its manual page. >> >> Examples are typeset like this: `$ git cmd` (`$` is your command >> prompt, do not actually type it to your shell). Note that a >> subcommand is specified as the first parameter to the 'git' >> program when you actually run it from the command line. > > I'm not convinced this last sentence is necessary. I agree, but I think it doesn't hurt. I think the point was to establish the word and concept "subcommand". > > [example showing typographical conventions] > > Typographical conventions shouldn't need so much explanation. Yes, I suppose. I'm used to printed manuals having a page on the meaning of different typefaces inside, but that's a bit of a different situation. > I'm curious: Jonathan, was this the original patch the result of a > real-life instance of confusion? What happened? No, I'm actually a bit ashamed to have sent the patch... I was just changing `git subcommand` to `git-subcommand` wherever it was the name of a command, rather than the command line to run it, that was in question. Consistency would have made the old example awkward, so I looked around for alternatives. Why worry about whether the man pages have no consistent rule about dashes? Since it is not obvious why the man pages use the dashed form when they do, I think a fraction of people will naturally use the dashed form by default. That means trouble once Git 1.6.0 comes out (e.g. see Ingo's recent post <http://thread.gmane.org/gmane.comp.version-control.git/87012/focus=87020>). Here's a patch implementing Junio's suggestion, because I do like it. Please let me know what you think (especially ideas for making it shorter). Thanks for all your thoughts so far. Sorry I took so long to get back. --- %< --- %< --- %< ---- Subject: gittutorial(7): add "Conventions used in this document" section The manual page for the git subcommand invoked as "git clone" is named git-clone(1), and similarly for the rest of the git subcommands. This patch should make the convention a little clearer when it is introduced at the beginning of gittutorial(7). Thanks to Junio C Hamano for the idea and wording. It remains to make an analogous change for user-manual.html and maybe git(1). Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/gittutorial.txt | 35 ++++++++++++++++++++++++++++++----- 1 files changed, 30 insertions(+), 5 deletions(-) diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt index 036a27c..51ad814 100644 --- a/Documentation/gittutorial.txt +++ b/Documentation/gittutorial.txt @@ -19,12 +19,37 @@ If you are instead primarily interested in using git to fetch a project, for example, to test the latest version, you may prefer to start with the first two chapters of link:user-manual.html[The Git User's Manual]. -First, note that you can get documentation for a command such as -`git log --graph` with: +Conventions used in this document +--------------------------------- ------------------------------------------------- -$ man git-log ------------------------------------------------- +When discussing a git subcommand 'cmd', this documentation +typesets the name of it like 'git-cmd', and that is the name you +ask for its manual page by. + +Examples are typeset like this: `$ git cmd`. (`$` is your command +prompt; do not actually type it to your shell.) A subcommand +is specified as the first parameter to the 'git' program +when you actually run it from the command line. + +So a typical command description may go like this: + +To propagate the changes you made back to the original subversion +repository, you would use the 'git-svn dcommit' command. It does +these things (long description here). Some examples: + +------------ +$ ... some example command sequence ... +$ git svn dcommit +------------ + +For full details, type: + +------------ +$ man git-svn +------------ + +Introducing yourself to git +--------------------------- It is a good idea to introduce yourself to git with your name and public email address before doing any operation. The easiest -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* Re: [PATCH 3/7] Documentation: complicate example of "man git-command" 2008-07-03 1:45 ` Jonathan Nieder @ 2008-07-03 18:18 ` J. Bruce Fields 0 siblings, 0 replies; 40+ messages in thread From: J. Bruce Fields @ 2008-07-03 18:18 UTC (permalink / raw) To: Jonathan Nieder Cc: Junio C Hamano, git, Christian Couder, Nguyen Thai Ngoc Duy, Jon Loeliger On Wed, Jul 02, 2008 at 08:45:59PM -0500, Jonathan Nieder wrote: > J. Bruce Fields wrote: > > > On Tue, Jul 01, 2008 at 04:54:53PM -0700, Junio C Hamano wrote: > > > >> We would want to mention the typesetting convention early in the manuals > >> (git(7), gittutorial(7) and user-manual.html) as well, so how about... > >> > >> Conventions used in this document > >> --------------------------------- > >> > >> When talking about a git subcommand 'cmd', this documentation > >> typesets the name of it like 'git-cmd', and that is the name you > >> ask for its manual page. > >> > >> Examples are typeset like this: `$ git cmd` (`$` is your command > >> prompt, do not actually type it to your shell). Note that a > >> subcommand is specified as the first parameter to the 'git' > >> program when you actually run it from the command line. > > > > I'm not convinced this last sentence is necessary. > > I agree, but I think it doesn't hurt. I think the point was to > establish the word and concept "subcommand". We don't need to define it. (The word "subcommand" is pretty intuitive, especially for anyone with some commandline experience, which we do assume throughout.) > > > [example showing typographical conventions] > > > > Typographical conventions shouldn't need so much explanation. > > Yes, I suppose. I'm used to printed manuals having a page on > the meaning of different typefaces inside, but that's a bit > of a different situation. Yes. > > I'm curious: Jonathan, was this the original patch the result of a > > real-life instance of confusion? What happened? > > No, I'm actually a bit ashamed to have sent the patch... I was just > changing `git subcommand` to `git-subcommand` wherever it was the name > of a command, rather than the command line to run it, that was in > question. Consistency would have made the old example awkward, so I > looked around for alternatives. That being the case, I'd rather leave the text as is; I'm uncomfortable adding new text to address something that isn't in practice a problem. --b. > > Why worry about whether the man pages have no consistent rule about > dashes? Since it is not obvious why the man pages use the dashed form > when they do, I think a fraction of people will naturally use the > dashed form by default. That means trouble once Git 1.6.0 comes out > (e.g. see Ingo's recent post > <http://thread.gmane.org/gmane.comp.version-control.git/87012/focus=87020>). > > Here's a patch implementing Junio's suggestion, because I do like it. > Please let me know what you think (especially ideas for making it > shorter). > > Thanks for all your thoughts so far. Sorry I took so long to get back. > > --- %< --- %< --- %< ---- > Subject: gittutorial(7): add "Conventions used in this document" section > > The manual page for the git subcommand invoked as "git clone" is > named git-clone(1), and similarly for the rest of the git > subcommands. This patch should make the convention a little > clearer when it is introduced at the beginning of gittutorial(7). > > Thanks to Junio C Hamano for the idea and wording. > > It remains to make an analogous change for user-manual.html > and maybe git(1). > > Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> > --- > Documentation/gittutorial.txt | 35 ++++++++++++++++++++++++++++++----- > 1 files changed, 30 insertions(+), 5 deletions(-) > > diff --git a/Documentation/gittutorial.txt > b/Documentation/gittutorial.txt > index 036a27c..51ad814 100644 > --- a/Documentation/gittutorial.txt > +++ b/Documentation/gittutorial.txt > @@ -19,12 +19,37 @@ If you are instead primarily interested in using > git to fetch a project, > for example, to test the latest version, you may prefer to start with > the first two chapters of link:user-manual.html[The Git User's Manual]. > > -First, note that you can get documentation for a command such as > -`git log --graph` with: > +Conventions used in this document > +--------------------------------- > > ------------------------------------------------- > -$ man git-log > ------------------------------------------------- > +When discussing a git subcommand 'cmd', this documentation > +typesets the name of it like 'git-cmd', and that is the name you > +ask for its manual page by. > + > +Examples are typeset like this: `$ git cmd`. (`$` is your command > +prompt; do not actually type it to your shell.) A subcommand > +is specified as the first parameter to the 'git' program > +when you actually run it from the command line. > + > +So a typical command description may go like this: > + > +To propagate the changes you made back to the original subversion > +repository, you would use the 'git-svn dcommit' command. It does > +these things (long description here). Some examples: > + > +------------ > +$ ... some example command sequence ... > +$ git svn dcommit > +------------ > + > +For full details, type: > + > +------------ > +$ man git-svn > +------------ > + > +Introducing yourself to git > +--------------------------- > > It is a good idea to introduce yourself to git with your name and > public email address before doing any operation. The easiest > -- > 1.5.5.GIT > ^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH 3/7] Documentation: complicate example of "man git-command" 2008-07-01 23:54 ` Junio C Hamano 2008-07-02 21:31 ` J. Bruce Fields @ 2008-07-03 6:06 ` Christian Couder 2008-07-03 7:44 ` Junio C Hamano 1 sibling, 1 reply; 40+ messages in thread From: Christian Couder @ 2008-07-03 6:06 UTC (permalink / raw) To: Junio C Hamano Cc: J. Bruce Fields, Jonathan Nieder, git, Nguyen Thai Ngoc Duy, Jon Loeliger Le mercredi 2 juillet 2008, Junio C Hamano a écrit : > > E.g. a typical command description may go like this: > > To propagate the changes you made back to the original subversion > repository, you would use 'git-svn dcommit' command. It does > these things (long description here). Some examples: We might kill 2 birds with a single stone by describing "git help" instead of "git svn" (that the user may never use). > ------------ > $ ... some example command sequence ... > $ git svn dcommit > ------------ > > For full details, type: > > ------------ > $ man git-svn > ------------ I saw that in another thread "git help" is also being ported to Windows and I wonder if we want the tutorial to be usable as is by people on Windows too. I mean what if people on Windows launch "git help tutorial"? Should they see nothing or a tutorial for *nix or a special version of the tutorial for Windows or a tutorial that works everywhere? I think the latter would be best but I wonder if it is possible. Anyway if we want to get there, perhaps we should use "git help svn" above instead of "man git-svn". (Yeah "git help help" might be confusing at first.) Thanks, Christian. ^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH 3/7] Documentation: complicate example of "man git-command" 2008-07-03 6:06 ` Christian Couder @ 2008-07-03 7:44 ` Junio C Hamano 0 siblings, 0 replies; 40+ messages in thread From: Junio C Hamano @ 2008-07-03 7:44 UTC (permalink / raw) To: Christian Couder Cc: J. Bruce Fields, Jonathan Nieder, git, Nguyen Thai Ngoc Duy, Jon Loeliger Christian Couder <chriscool@tuxfamily.org> writes: > Anyway if we want to get there, perhaps we should use "git help svn" above > instead of "man git-svn". (Yeah "git help help" might be confusing at > first.) I do not particularly like advocating "git help" too strongly like that. I prefer to keep the user perception of "git" to be just "one of the programs, nothing special". If you want to learn about "cat", you say "man cat". If you want to learn about git, you say "man git", and while you *can* say "git help", the point is you do *not* have to. You do not have to run "git" to learn about it. ^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH 4/7] git-daemon(1): don't assume git-daemon is in /usr/bin 2008-06-30 21:56 [PATCH 0/7] Some superficial documentation changes Jonathan Nieder ` (2 preceding siblings ...) 2008-06-30 22:10 ` [PATCH 3/7] Documentation: complicate example of "man git-command" Jonathan Nieder @ 2008-06-30 22:15 ` Jonathan Nieder 2008-06-30 22:17 ` [PATCH 5/7] Documentation: prepare to be consistent about "git-" versus "git " Jonathan Nieder ` (2 subsequent siblings) 6 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-06-30 22:15 UTC (permalink / raw) To: git; +Cc: Junio C Hamano, Christian Couder, Nguyen Thai Ngoc Duy, Jon Loeliger In the example inetd.conf lines in git-daemon(1), it was assumed that `git-daemon` resides in the user's /usr/bin. With this patch, we only assume `git` is in /usr/bin. The stronger assumption fails in the default installation nowadays. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/git-daemon.txt | 10 +++++----- 1 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt index 344f24e..b71eb94 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt @@ -206,8 +206,8 @@ git-daemon as inetd server:: /etc/inetd all on one line: + ------------------------------------------------ - git stream tcp nowait nobody /usr/bin/git-daemon - git-daemon --inetd --verbose --export-all + git stream tcp nowait nobody /usr/bin/git + git daemon --inetd --verbose --export-all /pub/foo /pub/bar ------------------------------------------------ @@ -219,8 +219,8 @@ git-daemon as inetd server for virtual hosts:: `/etc/inetd` all on one line: + ------------------------------------------------ - git stream tcp nowait nobody /usr/bin/git-daemon - git-daemon --inetd --verbose --export-all + git stream tcp nowait nobody /usr/bin/git + git daemon --inetd --verbose --export-all --interpolated-path=/pub/%H%D /pub/www.example.org/software /pub/www.example.com/software @@ -241,7 +241,7 @@ git-daemon as regular daemon for virtual hosts:: their IP addresses, start the daemon like this: + ------------------------------------------------ - git-daemon --verbose --export-all + git daemon --verbose --export-all --interpolated-path=/pub/%IP/%D /pub/192.168.1.200/software /pub/10.10.220.23/software -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 5/7] Documentation: prepare to be consistent about "git-" versus "git " 2008-06-30 21:56 [PATCH 0/7] Some superficial documentation changes Jonathan Nieder ` (3 preceding siblings ...) 2008-06-30 22:15 ` [PATCH 4/7] git-daemon(1): don't assume git-daemon is in /usr/bin Jonathan Nieder @ 2008-06-30 22:17 ` Jonathan Nieder 2008-06-30 22:29 ` [PATCH 6/7] Documentation: " Jonathan Nieder 2008-06-30 22:36 ` [RFC/PATCH 7/7] Documentation formatting and cleanup Jonathan Nieder 2008-07-01 8:42 ` [PATCH 0/7] Some superficial documentation changes Junio C Hamano 6 siblings, 1 reply; 40+ messages in thread From: Jonathan Nieder @ 2008-06-30 22:17 UTC (permalink / raw) To: git; +Cc: Junio C Hamano, Christian Couder, Nguyen Thai Ngoc Duy With the dashed forms of git commands not in $(bindir), we have to change many instances of "git-command" to "git command". Also, for consistency it is at times appropriate to make the opposite change. In some cases, the change is not so simple as changing one character. This patch gets rid of some of those cases by rewrapping lines. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/git-mailinfo.txt | 4 ++-- Documentation/git-tag.txt | 4 ++-- Documentation/gitrepository-layout.txt | 8 ++++---- Documentation/gittutorial.txt | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt index 183dc1d..6a73b73 100644 --- a/Documentation/git-mailinfo.txt +++ b/Documentation/git-mailinfo.txt @@ -29,8 +29,8 @@ OPTIONS among which (1) remove 'Re:' or 're:', (2) leading whitespaces, (3) '[' up to ']', typically '[PATCH]', and then prepends "[PATCH] ". This flag forbids this - munging, and is most useful when used to read back 'git - format-patch -k' output. + munging, and is most useful when used to read back + 'git format-patch -k' output. -u:: The commit log message, author name and author email are diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 8f40f4b..0c41711 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -122,8 +122,8 @@ others have already seen the old one. So just use "git tag -f" again, as if you hadn't already published the old one. However, Git does *not* (and it should not) change tags behind -users back. So if somebody already got the old tag, doing a "git -pull" on your tree shouldn't just make them overwrite the old +users back. So if somebody already got the old tag, doing a +"git pull" on your tree shouldn't just make them overwrite the old one. If somebody got a release tag from you, you cannot just change diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt index b75508a..2afc5a3 100644 --- a/Documentation/gitrepository-layout.txt +++ b/Documentation/gitrepository-layout.txt @@ -167,14 +167,14 @@ info/grafts:: info/exclude:: This file, by convention among Porcelains, stores the exclude pattern list. `.gitignore` is the per-directory - ignore file. `git status`, `git add`, `git rm` and `git - clean` look at it but the core git commands do not look + ignore file. `git status`, `git add`, `git rm` and + `git clean` look at it but the core git commands do not look at it. See also: linkgit:gitignore[5]. remotes:: Stores shorthands to be used to give URL and default - refnames to interact with remote repository to `git - fetch`, `git pull` and `git push` commands. + refnames to interact with remote repository to + `git fetch`, `git pull` and `git push` commands. logs:: Records of changes made to refs are stored in this diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt index b833167..144bacd 100644 --- a/Documentation/gittutorial.txt +++ b/Documentation/gittutorial.txt @@ -19,8 +19,8 @@ If you are instead primarily interested in using git to fetch a project, for example, to test the latest version, you may prefer to start with the first two chapters of link:user-manual.html[The Git User's Manual]. -First, note that you can get documentation for a command such as "git -log --graph" with: +First, note that you can get documentation for a command such as +"git log --graph" with: ------------------------------------------------ $ man git-log -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 6/7] Documentation: be consistent about "git-" versus "git " 2008-06-30 22:17 ` [PATCH 5/7] Documentation: prepare to be consistent about "git-" versus "git " Jonathan Nieder @ 2008-06-30 22:29 ` Jonathan Nieder 0 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-06-30 22:29 UTC (permalink / raw) To: git; +Cc: Junio C Hamano, Christian Couder, Nguyen Thai Ngoc Duy [Patch at <http://home.uchicago.edu/~jrnieder/20080701-git-doc-hyphens.txt>] Since the git-* commands are not installed in $(bindir), using "git-command <parameters>" in examples in the documentation is not a good idea. On the other hand, it is nice to be able to refer to each command using one hyphenated word. (There is no escaping it, anyway: man page names cannot have spaces in them.) This patch retains the dash in naming an operation, command, program, process, or action. Complete command lines that can be entered at a shell (i.e., without options omitted) are made to use the dashless form. The changes consist only of replacing some spaces with hyphens and vice versa. After a "s/ /-/g", the unpatched and patched versions are identical. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Documentation/git-add.txt | 2 +- Documentation/git-am.txt | 4 +- Documentation/git-annotate.txt | 2 +- Documentation/git-apply.txt | 2 +- Documentation/git-archimport.txt | 2 +- Documentation/git-archive.txt | 2 +- Documentation/git-bisect.txt | 2 +- Documentation/git-blame.txt | 2 +- Documentation/git-branch.txt | 8 +- Documentation/git-bundle.txt | 14 ++-- Documentation/git-cat-file.txt | 4 +- Documentation/git-check-attr.txt | 2 +- Documentation/git-check-ref-format.txt | 4 +- Documentation/git-checkout-index.txt | 20 +++--- Documentation/git-checkout.txt | 8 +- Documentation/git-cherry-pick.txt | 2 +- Documentation/git-cherry.txt | 2 +- Documentation/git-clean.txt | 2 +- Documentation/git-clone.txt | 2 +- Documentation/git-commit-tree.txt | 2 +- Documentation/git-commit.txt | 4 +- Documentation/git-config.txt | 26 ++++---- Documentation/git-count-objects.txt | 4 +- Documentation/git-cvsexportcommit.txt | 8 +- Documentation/git-cvsimport.txt | 4 +- Documentation/git-cvsserver.txt | 2 +- Documentation/git-daemon.txt | 2 +- Documentation/git-describe.txt | 10 ++-- Documentation/git-diff-files.txt | 2 +- Documentation/git-diff-index.txt | 12 ++-- Documentation/git-diff-tree.txt | 8 +- Documentation/git-diff.txt | 18 +++--- Documentation/git-fast-export.txt | 2 +- Documentation/git-fast-import.txt | 8 +- Documentation/git-fetch-pack.txt | 2 +- Documentation/git-fetch.txt | 4 +- Documentation/git-filter-branch.txt | 4 +- Documentation/git-fmt-merge-msg.txt | 4 +- Documentation/git-for-each-ref.txt | 8 +- Documentation/git-format-patch.txt | 2 +- Documentation/git-fsck-objects.txt | 2 +- Documentation/git-fsck.txt | 4 +- Documentation/git-gc.txt | 6 +- Documentation/git-get-tar-commit-id.txt | 2 +- Documentation/git-grep.txt | 2 +- Documentation/git-hash-object.txt | 2 +- Documentation/git-http-fetch.txt | 2 +- Documentation/git-http-push.txt | 2 +- Documentation/git-imap-send.txt | 4 +- Documentation/git-index-pack.txt | 4 +- Documentation/git-init-db.txt | 2 +- Documentation/git-init.txt | 6 +- Documentation/git-instaweb.txt | 4 +- Documentation/git-log.txt | 2 +- Documentation/git-lost-found.txt | 2 +- Documentation/git-ls-files.txt | 2 +- Documentation/git-ls-remote.txt | 2 +- Documentation/git-ls-tree.txt | 2 +- Documentation/git-mailinfo.txt | 4 +- Documentation/git-mailsplit.txt | 2 +- Documentation/git-merge-base.txt | 4 +- Documentation/git-merge-file.txt | 4 +- Documentation/git-merge-index.txt | 6 +- Documentation/git-merge-tree.txt | 2 +- Documentation/git-merge.txt | 10 ++-- Documentation/git-mergetool.txt | 16 +++--- Documentation/git-mktag.txt | 2 +- Documentation/git-mktree.txt | 2 +- Documentation/git-mv.txt | 6 +- Documentation/git-name-rev.txt | 2 +- Documentation/git-pack-objects.txt | 2 +- Documentation/git-pack-redundant.txt | 6 +- Documentation/git-pack-refs.txt | 4 +- Documentation/git-patch-id.txt | 2 +- Documentation/git-peek-remote.txt | 2 +- Documentation/git-prune-packed.txt | 2 +- Documentation/git-prune.txt | 4 +- Documentation/git-pull.txt | 2 +- Documentation/git-push.txt | 2 +- Documentation/git-quiltimport.txt | 2 +- Documentation/git-read-tree.txt | 32 +++++----- Documentation/git-rebase.txt | 20 +++--- Documentation/git-receive-pack.txt | 10 ++-- Documentation/git-relink.txt | 2 +- Documentation/git-remote.txt | 12 ++-- Documentation/git-repack.txt | 10 ++-- Documentation/git-repo-config.txt | 2 +- Documentation/git-request-pull.txt | 2 +- Documentation/git-rerere.txt | 4 +- Documentation/git-rev-list.txt | 10 ++-- Documentation/git-rev-parse.txt | 6 +- Documentation/git-revert.txt | 2 +- Documentation/git-rm.txt | 8 +- Documentation/git-send-email.txt | 2 +- Documentation/git-send-pack.txt | 2 +- Documentation/git-shortlog.txt | 6 +- Documentation/git-show-branch.txt | 4 +- Documentation/git-show-index.txt | 2 +- Documentation/git-show-ref.txt | 6 +- Documentation/git-show.txt | 2 +- Documentation/git-stash.txt | 12 ++-- Documentation/git-status.txt | 6 +- Documentation/git-stripspace.txt | 2 +- Documentation/git-submodule.txt | 10 ++-- Documentation/git-svn.txt | 34 +++++----- Documentation/git-symbolic-ref.txt | 2 +- Documentation/git-tag.txt | 14 ++-- Documentation/git-tar-tree.txt | 2 +- Documentation/git-unpack-file.txt | 2 +- Documentation/git-unpack-objects.txt | 2 +- Documentation/git-update-index.txt | 12 ++-- Documentation/git-update-ref.txt | 10 ++-- Documentation/git-update-server-info.txt | 2 +- Documentation/git-upload-archive.txt | 2 +- Documentation/git-upload-pack.txt | 2 +- Documentation/git-var.txt | 4 +- Documentation/git-verify-pack.txt | 2 +- Documentation/git-verify-tag.txt | 2 +- Documentation/git-web--browse.txt | 6 +- Documentation/git-whatchanged.txt | 6 +- Documentation/git-write-tree.txt | 2 +- Documentation/gitattributes.txt | 14 ++-- Documentation/gitcore-tutorial.txt | 102 +++++++++++++++--------------- Documentation/gitcvs-migration.txt | 8 +- Documentation/gitdiffcore.txt | 2 +- Documentation/githooks.txt | 10 ++-- Documentation/gitignore.txt | 4 +- Documentation/gitrepository-layout.txt | 18 +++--- Documentation/gittutorial-2.txt | 18 +++--- Documentation/gittutorial.txt | 30 +++++----- Documentation/user-manual.txt | 76 +++++++++++----------- 131 files changed, 462 insertions(+), 462 deletions(-) Because it is long, I haven't sent the patch. You can find it at <http://home.uchicago.edu/~jrnieder/20080701-git-doc-hyphens.txt>. ^ permalink raw reply [flat|nested] 40+ messages in thread
* [RFC/PATCH 7/7] Documentation formatting and cleanup 2008-06-30 21:56 [PATCH 0/7] Some superficial documentation changes Jonathan Nieder ` (4 preceding siblings ...) 2008-06-30 22:17 ` [PATCH 5/7] Documentation: prepare to be consistent about "git-" versus "git " Jonathan Nieder @ 2008-06-30 22:36 ` Jonathan Nieder 2008-07-01 13:09 ` Olivier Marin 2008-07-01 8:42 ` [PATCH 0/7] Some superficial documentation changes Junio C Hamano 6 siblings, 1 reply; 40+ messages in thread From: Jonathan Nieder @ 2008-06-30 22:36 UTC (permalink / raw) To: git; +Cc: Junio C Hamano, Christian Couder, Jon Loeliger [184 KB patch online at <http://home.uchicago.edu/~jrnieder/20080701-git-doc-style.txt>] Following what appears to be the predominant style, format names of commands and commandlines both as `teletype text`. While we're at it, add articles ("a" and "the") in some places, italicize the name of the command in the manual page synopsis line, and add a comma or two where it seems appropriate. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> 1) I am using `teletype text` both for command names and for command lines. Probably I should be using italics for the command names. 2) Should these changes be split up more? Documentation/git-annotate.txt | 2 +- Documentation/git-apply.txt | 12 ++-- Documentation/git-archimport.txt | 6 +- Documentation/git-archive.txt | 6 +- Documentation/git-bisect.txt | 8 +- Documentation/git-blame.txt | 4 +- Documentation/git-branch.txt | 8 +- Documentation/git-bundle.txt | 27 +++--- Documentation/git-check-ref-format.txt | 2 +- Documentation/git-checkout-index.txt | 2 +- Documentation/git-checkout.txt | 4 +- Documentation/git-cherry-pick.txt | 2 +- Documentation/git-cherry.txt | 8 +- Documentation/git-citool.txt | 4 +- Documentation/git-clean.txt | 4 +- Documentation/git-clone.txt | 12 ++-- Documentation/git-commit-tree.txt | 2 +- Documentation/git-commit.txt | 20 +++--- Documentation/git-config.txt | 12 ++-- Documentation/git-cvsexportcommit.txt | 7 +- Documentation/git-cvsimport.txt | 18 ++-- Documentation/git-cvsserver.txt | 43 +++++----- Documentation/git-daemon.txt | 22 +++--- Documentation/git-describe.txt | 8 +- Documentation/git-diff-files.txt | 2 +- Documentation/git-diff-index.txt | 26 +++--- Documentation/git-diff-tree.txt | 10 +- Documentation/git-fast-export.txt | 8 +- Documentation/git-fast-import.txt | 16 ++-- Documentation/git-fetch-pack.txt | 16 ++-- Documentation/git-fetch.txt | 2 +- Documentation/git-filter-branch.txt | 12 ++-- Documentation/git-fmt-merge-msg.txt | 4 +- Documentation/git-format-patch.txt | 4 +- Documentation/git-fsck.txt | 6 +- Documentation/git-gc.txt | 10 +- Documentation/git-get-tar-commit-id.txt | 6 +- Documentation/git-grep.txt | 2 +- Documentation/git-gui.txt | 24 +++--- Documentation/git-hash-object.txt | 2 +- Documentation/git-help.txt | 6 +- Documentation/git-http-fetch.txt | 2 +- Documentation/git-imap-send.txt | 2 +- Documentation/git-index-pack.txt | 8 +- Documentation/git-instaweb.txt | 4 +- Documentation/git-log.txt | 4 +- Documentation/git-ls-files.txt | 8 +- Documentation/git-ls-remote.txt | 2 +- Documentation/git-mailinfo.txt | 4 +- Documentation/git-merge-base.txt | 8 +- Documentation/git-merge-file.txt | 10 +- Documentation/git-merge-index.txt | 14 ++-- Documentation/git-merge-one-file.txt | 4 +- Documentation/git-merge.txt | 14 ++-- Documentation/git-mergetool.txt | 2 +- Documentation/git-name-rev.txt | 6 +- Documentation/git-pack-objects.txt | 8 +- Documentation/git-pack-redundant.txt | 4 +- Documentation/git-patch-id.txt | 2 +- Documentation/git-peek-remote.txt | 4 +- Documentation/git-prune.txt | 10 +- Documentation/git-pull.txt | 3 +- Documentation/git-push.txt | 2 +- Documentation/git-read-tree.txt | 14 ++-- Documentation/git-rebase.txt | 22 +++--- Documentation/git-receive-pack.txt | 16 ++-- Documentation/git-repack.txt | 11 ++- Documentation/git-rerere.txt | 10 +- Documentation/git-reset.txt | 2 +- Documentation/git-rev-list.txt | 6 +- Documentation/git-rev-parse.txt | 12 ++-- Documentation/git-rm.txt | 2 +- Documentation/git-send-pack.txt | 14 ++-- Documentation/git-shell.txt | 2 +- Documentation/git-shortlog.txt | 2 +- Documentation/git-show-branch.txt | 4 +- Documentation/git-show-index.txt | 4 +- Documentation/git-show-ref.txt | 4 +- Documentation/git-show.txt | 6 +- Documentation/git-stash.txt | 12 ++-- Documentation/git-submodule.txt | 4 +- Documentation/git-svn.txt | 133 +++++++++++++++---------------- Documentation/git-symbolic-ref.txt | 2 +- Documentation/git-tag.txt | 8 +- Documentation/git-tar-tree.txt | 4 +- Documentation/git-unpack-objects.txt | 2 +- Documentation/git-update-index.txt | 14 ++-- Documentation/git-upload-archive.txt | 2 +- Documentation/git-upload-pack.txt | 6 +- Documentation/git-verify-pack.txt | 4 +- Documentation/git-verify-tag.txt | 2 +- Documentation/git-web--browse.txt | 6 +- Documentation/git-whatchanged.txt | 4 +- Documentation/git.txt | 10 +- Documentation/gitattributes.txt | 12 ++-- Documentation/gitcore-tutorial.txt | 18 ++-- Documentation/gitcvs-migration.txt | 4 +- Documentation/gitdiffcore.txt | 34 ++++---- Documentation/gitignore.txt | 4 +- Documentation/gitk.txt | 3 +- Documentation/gitrepository-layout.txt | 2 +- Documentation/gittutorial-2.txt | 28 +++--- Documentation/gittutorial.txt | 46 ++++++------ 103 files changed, 510 insertions(+), 509 deletions(-) See <http://home.uchicago.edu/~jrnieder/20080701-git-doc-style.txt>. ^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [RFC/PATCH 7/7] Documentation formatting and cleanup 2008-06-30 22:36 ` [RFC/PATCH 7/7] Documentation formatting and cleanup Jonathan Nieder @ 2008-07-01 13:09 ` Olivier Marin 2008-07-01 21:34 ` Junio C Hamano 2008-07-03 2:28 ` Jonathan Nieder 0 siblings, 2 replies; 40+ messages in thread From: Olivier Marin @ 2008-07-01 13:09 UTC (permalink / raw) To: Jonathan Nieder; +Cc: git, Junio C Hamano, Christian Couder, Jon Loeliger Jonathan Nieder a écrit : > [184 KB patch online at > <http://home.uchicago.edu/~jrnieder/20080701-git-doc-style.txt>] > > Following what appears to be the predominant style, format > names of commands and commandlines both as `teletype text`. > > While we're at it, add articles ("a" and "the") in some > places, italicize the name of the command in the manual page > synopsis line, and add a comma or two where it seems appropriate. > > Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> > > 1) I am using `teletype text` both for command names and > for command lines. Probably I should be using italics > for the command names. You did a lot of: > -replaced; you need to use a tool such as linkgit:git-diff[1] or the "pickaxe" > +replaced; you need to use a tool such as `git-diff` or the "pickaxe" Are those kind of changes really an improvement? Also, in Documentation/gitdiffcore.txt, you did: > -These are applied in sequence. The set of filepairs git-diff-\* > +These are applied in sequence. The set of filepairs `git-diff-*` but the file does not compile, now. Olivier. ^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [RFC/PATCH 7/7] Documentation formatting and cleanup 2008-07-01 13:09 ` Olivier Marin @ 2008-07-01 21:34 ` Junio C Hamano 2008-07-03 2:09 ` Jonathan Nieder 2008-07-03 2:28 ` Jonathan Nieder 1 sibling, 1 reply; 40+ messages in thread From: Junio C Hamano @ 2008-07-01 21:34 UTC (permalink / raw) To: Olivier Marin; +Cc: Jonathan Nieder, git, Christian Couder, Jon Loeliger Olivier Marin <dkr+ml.git@free.fr> writes: > Also, in Documentation/gitdiffcore.txt, you did: > >> -These are applied in sequence. The set of filepairs git-diff-\* >> +These are applied in sequence. The set of filepairs `git-diff-*` > > but the file does not compile, now. There are other places with the same breakage. You would need something like this (using the {asterisk} macro I wrote for updating the docs for another topic). The patch shows only a single use location but there are others in the same file. diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf index 10c1a15..40d43b7 100644 --- a/Documentation/asciidoc.conf +++ b/Documentation/asciidoc.conf @@ -8,6 +8,7 @@ # the command. [attributes] +asterisk=* plus=+ caret=^ startsb=[ diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index 71568ab..7169eee 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -23,7 +23,7 @@ that are easier to understand than the conventional kind. The chain of operation ---------------------- -The `git-diff-*` family works by first comparing two sets of +The `git-diff-{asterisk}` family works by first comparing two sets of files: - `git-diff-index` compares contents of a "tree" object and the ^ permalink raw reply related [flat|nested] 40+ messages in thread
* Re: [RFC/PATCH 7/7] Documentation formatting and cleanup 2008-07-01 21:34 ` Junio C Hamano @ 2008-07-03 2:09 ` Jonathan Nieder 0 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 2:09 UTC (permalink / raw) To: Junio C Hamano; +Cc: Olivier Marin, git, Christian Couder, Jon Loeliger Junio C Hamano writes: > Olivier Marin <dkr+ml.git@free.fr> writes: > >> Also, in Documentation/gitdiffcore.txt, you did: >> >>> -These are applied in sequence. The set of filepairs git-diff-\* >>> +These are applied in sequence. The set of filepairs `git-diff-*` >> >> but the file does not compile, now. > > There are other places with the same breakage. Sorry about that. Thanks for the fix. Do you know of a good page to read to learn that subset of Asciidoc 7 we use? Right now, I am wondering: why wouldn't `git-diff-\*` work? Jonathan ^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [RFC/PATCH 7/7] Documentation formatting and cleanup 2008-07-01 13:09 ` Olivier Marin 2008-07-01 21:34 ` Junio C Hamano @ 2008-07-03 2:28 ` Jonathan Nieder 1 sibling, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 2:28 UTC (permalink / raw) To: Olivier Marin; +Cc: git, Junio C Hamano, Christian Couder, Jon Loeliger [-- Warning: decoded text below may be mangled, UTF-8 assumed --] [-- Attachment #1: Type: TEXT/PLAIN; charset=X-UNKNOWN, Size: 722 bytes --] Olivier Marin wrote: > Jonathan Nieder a écrit : > > [184 KB patch online at > > <http://home.uchicago.edu/~jrnieder/20080701-git-doc-style.txt>] > > You did a lot of: > > > -replaced; you need to use a tool such as linkgit:git-diff[1] or the "pickaxe" > > +replaced; you need to use a tool such as `git-diff` or the "pickaxe" > > Are those kind of changes really an improvement? I should have also added SEE ALSO -------- linkgit:git-diff[1], ... but I was trying to keep my changes minimal. I'll send some suggestions for see also sections ome time this week; I haven't found time to prune down the lists of cross references I have in my tree now. Thanks for the reminder. Jonathan ^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH 0/7] Some superficial documentation changes 2008-06-30 21:56 [PATCH 0/7] Some superficial documentation changes Jonathan Nieder ` (5 preceding siblings ...) 2008-06-30 22:36 ` [RFC/PATCH 7/7] Documentation formatting and cleanup Jonathan Nieder @ 2008-07-01 8:42 ` Junio C Hamano 2008-07-03 4:31 ` Jonathan Nieder 6 siblings, 1 reply; 40+ messages in thread From: Junio C Hamano @ 2008-07-01 8:42 UTC (permalink / raw) To: Jonathan Nieder; +Cc: git, Christian Couder, Nguyen Thai Ngoc Duy, Jon Loeliger Jonathan Nieder <jrnieder@uchicago.edu> writes: > But at least I was able to check that patch 6/7 (which redistributes the > dashes in the world) doesn't touch anything but spaces and hyphens. > Hopefully that should make this easier to review. Yes, the earlier "line break adjustments" patch really helped. I've queued all of them to 'pu' while reading them over, except for the last one. I did not look very carefully, but the parts I did look at made sense. In general, I've always preferred to see command names "git-foo" typeset in teletype face, consistent with examples (also typeset in tt), because they are both something the end users are expected to type. With this transition, we are however making "git-foo" not something users are expected to type, which means that the use of a typeface that is different from the body text to spell command names is now strictly for making them stand out in context. In that sense, I share your hesitation about the last one to use tt for command names. It probably is better to use italic now. On my next git day (coming Wednesday, if nothing goes wrong at day job), I'll merge all except the last one to 'master' so that the HTML version of the manual page k.org serves to the general public is updated and we can get a wider exposure to looking for conversion errors more easily. If you also prefer 'italics' and list agrees, it might be a better idea to also apply that patch when I do so, as that step is the most error prone one and benefits from more eyeballs. Thanks. ^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH 0/7] Some superficial documentation changes 2008-07-01 8:42 ` [PATCH 0/7] Some superficial documentation changes Junio C Hamano @ 2008-07-03 4:31 ` Jonathan Nieder 2008-07-03 4:47 ` [PATCH 01/15] git-format-patch(1): fix stray \ in output Jonathan Nieder ` (14 more replies) 0 siblings, 15 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 4:31 UTC (permalink / raw) To: Junio C Hamano Cc: git, Christian Couder, Nguyen Thai Ngoc Duy, Jon Loeliger, Dan McGee, J. Bruce Fields, Olivier Marin On Tue, 1 Jul 2008, Junio C Hamano wrote: > In general, I've always preferred to see command names "git-foo" typeset > in teletype face, consistent with examples (also typeset in tt), because > they are both something the end users are expected to type. With this > transition, we are however making "git-foo" not something users are > expected to type, which means that the use of a typeface that is different > from the body text to spell command names is now strictly for making them > stand out in context. > > [...] If you > also prefer 'italics' and list agrees, it might be a better idea to also > apply that patch when I do so, as that step is the most error prone one > and benefits from more eyeballs. I am not sure whether the list agrees, but I do prefer italics. I haven't finished making the user manual use italics yet, but here are some patches to make the man pages do so. I also included some formatting fixes irrelevant to that purpose to problems I found along the way. I was surprised to get so much feedback with the patches I sent earlier this week. Thanks! I hope you find as much interesting in this series. The bulk of the changes are in patch 11, which only replaces backticks with apostrophes. Jonathan git-format-patch(1): fix stray \ in output Documentation: fix gitlinks manpages: fix bogus whitespace git(1): add comma git-add(1): depersonalize description Documentation: rewrap to prepare for "git-" vs "git " change Documentation: more "git-" versus "git " changes gitdiffcore(7): fix awkward wording manpages: italicize command names in synopses manpages: italicize names of commands manpages: italicize git command names (which were in teletype font) manpages: italicize gitk's name (where it was in teletype font) manpages: italicize nongit command names (which were in teletype font) manpages: italicize git subcommand names (which were in teletype font) manpages: use teletype font for sample command lines Documentation/config.txt | 70 ++++++------ Documentation/fetch-options.txt | 8 +- Documentation/git-am.txt | 14 +- Documentation/git-apply.txt | 18 ++-- Documentation/git-archimport.txt | 12 +- Documentation/git-archive.txt | 6 +- Documentation/git-bisect.txt | 8 +- Documentation/git-blame.txt | 8 +- Documentation/git-branch.txt | 8 +- Documentation/git-bundle.txt | 26 ++-- Documentation/git-check-ref-format.txt | 2 +- Documentation/git-checkout-index.txt | 8 +- Documentation/git-checkout.txt | 4 +- Documentation/git-cherry-pick.txt | 2 +- Documentation/git-cherry.txt | 6 +- Documentation/git-citool.txt | 4 +- Documentation/git-clean.txt | 4 +- Documentation/git-clone.txt | 6 +- Documentation/git-commit-tree.txt | 2 +- Documentation/git-commit.txt | 26 ++-- Documentation/git-config.txt | 12 +- Documentation/git-cvsexportcommit.txt | 2 +- Documentation/git-cvsimport.txt | 18 ++-- Documentation/git-cvsserver.txt | 40 ++++---- Documentation/git-daemon.txt | 40 ++++---- Documentation/git-describe.txt | 6 +- Documentation/git-diff-files.txt | 2 +- Documentation/git-diff-index.txt | 20 ++-- Documentation/git-diff-tree.txt | 10 +- Documentation/git-fast-export.txt | 8 +- Documentation/git-fast-import.txt | 22 ++-- Documentation/git-fetch-pack.txt | 14 +- Documentation/git-fetch.txt | 2 +- Documentation/git-filter-branch.txt | 14 +- Documentation/git-fmt-merge-msg.txt | 4 +- Documentation/git-for-each-ref.txt | 2 +- Documentation/git-format-patch.txt | 18 ++-- Documentation/git-fsck.txt | 6 +- Documentation/git-gc.txt | 20 ++-- Documentation/git-get-tar-commit-id.txt | 6 +- Documentation/git-grep.txt | 2 +- Documentation/git-gui.txt | 28 +++--- Documentation/git-hash-object.txt | 2 +- Documentation/git-help.txt | 10 +- Documentation/git-http-fetch.txt | 2 +- Documentation/git-imap-send.txt | 2 +- Documentation/git-index-pack.txt | 8 +- Documentation/git-init.txt | 6 +- Documentation/git-instaweb.txt | 2 +- Documentation/git-log.txt | 4 +- Documentation/git-ls-files.txt | 6 +- Documentation/git-ls-remote.txt | 2 +- Documentation/git-mailinfo.txt | 4 +- Documentation/git-merge-base.txt | 4 +- Documentation/git-merge-file.txt | 14 +- Documentation/git-merge-index.txt | 14 +- Documentation/git-merge-one-file.txt | 4 +- Documentation/git-merge.txt | 16 ++-- Documentation/git-mergetool.txt | 16 ++-- Documentation/git-name-rev.txt | 6 +- Documentation/git-pack-objects.txt | 6 +- Documentation/git-pack-redundant.txt | 2 +- Documentation/git-parse-remote.txt | 2 +- Documentation/git-patch-id.txt | 2 +- Documentation/git-peek-remote.txt | 6 +- Documentation/git-prune.txt | 14 +- Documentation/git-pull.txt | 10 +- Documentation/git-push.txt | 4 +- Documentation/git-read-tree.txt | 42 ++++---- Documentation/git-rebase.txt | 30 +++--- Documentation/git-receive-pack.txt | 12 +- Documentation/git-reflog.txt | 16 ++-- Documentation/git-remote.txt | 12 +- Documentation/git-repack.txt | 16 ++-- Documentation/git-rerere.txt | 34 +++--- Documentation/git-reset.txt | 2 +- Documentation/git-rev-list.txt | 6 +- Documentation/git-rev-parse.txt | 24 ++-- Documentation/git-revert.txt | 4 +- Documentation/git-rm.txt | 4 +- Documentation/git-send-pack.txt | 10 +- Documentation/git-sh-setup.txt | 2 +- Documentation/git-shell.txt | 2 +- Documentation/git-shortlog.txt | 4 +- Documentation/git-show-branch.txt | 2 +- Documentation/git-show-index.txt | 4 +- Documentation/git-show-ref.txt | 4 +- Documentation/git-show.txt | 6 +- Documentation/git-stash.txt | 6 +- Documentation/git-status.txt | 6 +- Documentation/git-submodule.txt | 4 +- Documentation/git-svn.txt | 106 +++++++++--------- Documentation/git-symbolic-ref.txt | 2 +- Documentation/git-tag.txt | 8 +- Documentation/git-tar-tree.txt | 6 +- Documentation/git-update-index.txt | 22 ++-- Documentation/git-upload-archive.txt | 2 +- Documentation/git-upload-pack.txt | 6 +- Documentation/git-var.txt | 2 +- Documentation/git-verify-pack.txt | 2 +- Documentation/git-verify-tag.txt | 2 +- Documentation/git-web--browse.txt | 6 +- Documentation/git-whatchanged.txt | 4 +- Documentation/git-write-tree.txt | 8 +- Documentation/git.txt | 16 ++-- Documentation/gitattributes.txt | 22 ++-- Documentation/gitcore-tutorial.txt | 188 +++++++++++++++--------------- Documentation/gitcvs-migration.txt | 18 ++-- Documentation/gitdiffcore.txt | 38 +++--- Documentation/githooks.txt | 74 ++++++------ Documentation/gitignore.txt | 4 +- Documentation/gitk.txt | 2 +- Documentation/gitrepository-layout.txt | 18 ++-- Documentation/gittutorial-2.txt | 16 ++-- Documentation/gittutorial.txt | 79 +++++++++----- Documentation/i18n.txt | 4 +- Documentation/merge-options.txt | 4 +- Documentation/pull-fetch-param.txt | 8 +- Documentation/urls-remotes.txt | 4 +- Documentation/user-manual.txt | 42 ++++---- 120 files changed, 848 insertions(+), 823 deletions(-) ^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH 01/15] git-format-patch(1): fix stray \ in output 2008-07-03 4:31 ` Jonathan Nieder @ 2008-07-03 4:47 ` Jonathan Nieder 2008-07-03 4:54 ` [PATCH 02/15] Documentation: fix gitlinks Jonathan Nieder ` (13 subsequent siblings) 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 4:47 UTC (permalink / raw) To: Junio C Hamano; +Cc: git, Christian Couder, Jon Loeliger In listing blocks (set off by rows of dashes), the usual formatting characters of asciidoc are instead rendered verbatim. When the escaped double-hyphen of olden days is moved into such a block along with other formatting improvements, it becomes backslash-dash-dash. So we remove the backslash. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/git-format-patch.txt | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 894b82d..3c9192a 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -206,7 +206,7 @@ For each commit a separate file is created in the current directory. project: + ------------ -$ git format-patch \--root origin +$ git format-patch --root origin ------------ * The same as the previous one: -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 02/15] Documentation: fix gitlinks 2008-07-03 4:31 ` Jonathan Nieder 2008-07-03 4:47 ` [PATCH 01/15] git-format-patch(1): fix stray \ in output Jonathan Nieder @ 2008-07-03 4:54 ` Jonathan Nieder 2008-07-03 5:03 ` [PATCH 03/15] manpages: fix bogus whitespace Jonathan Nieder ` (12 subsequent siblings) 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 4:54 UTC (permalink / raw) To: Junio C Hamano Cc: git, Shawn O. Pearce, Dan McGee, Dana L. How, J. Bruce Fields Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/git-repack.txt | 2 +- Documentation/user-manual.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt index 0d72e83..c956aff 100644 --- a/Documentation/git-repack.txt +++ b/Documentation/git-repack.txt @@ -72,7 +72,7 @@ OPTIONS `git-update-server-info`. This option skips updating local catalog files needed to publish this repository (or a direct copy of it) - over HTTP or FTP. See gitlink:git-update-server-info[1]. + over HTTP or FTP. See linkgit:git-update-server-info[1]. --window=[N]:: --depth=[N]:: diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index ca13266..cbfc5d0 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1303,7 +1303,7 @@ $ git diff -3 file.txt # diff against stage 3 $ git diff --theirs file.txt # same as the above. ------------------------------------------------- -The linkgit:git-log[1] and gitk[1] commands also provide special help +The linkgit:git-log[1] and linkgit:gitk[1] commands also provide special help for merges: ------------------------------------------------- -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 03/15] manpages: fix bogus whitespace 2008-07-03 4:31 ` Jonathan Nieder 2008-07-03 4:47 ` [PATCH 01/15] git-format-patch(1): fix stray \ in output Jonathan Nieder 2008-07-03 4:54 ` [PATCH 02/15] Documentation: fix gitlinks Jonathan Nieder @ 2008-07-03 5:03 ` Jonathan Nieder 2008-07-03 23:55 ` Junio C Hamano 2008-07-03 5:08 ` [PATCH 04/15] git(1): add comma Jonathan Nieder ` (11 subsequent siblings) 14 siblings, 1 reply; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 5:03 UTC (permalink / raw) To: Junio C Hamano Cc: git, Christian Couder, J. Bruce Fields, Miklos Vajna, Shawn O. Pearce It's distracting. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/git-fast-import.txt | 2 +- Documentation/git-format-patch.txt | 8 ++++---- Documentation/git-gui.txt | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index 70cc8e8..9602764 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -86,7 +86,7 @@ OPTIONS --quiet:: Disable all non-fatal output, making fast-import silent when it - is successful. This option disables the output shown by + is successful. This option disables the output shown by \--stats. --stats:: diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 3c9192a..b990052 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -175,10 +175,10 @@ and file suffix, and number patches when outputting more than one. ------------ [format] - headers = "Organization: git-foo\n" - subjectprefix = CHANGE - suffix = .txt - numbered = auto + headers = "Organization: git-foo\n" + subjectprefix = CHANGE + suffix = .txt + numbered = auto cc = <email> ------------ diff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt index 940e43f..ea1e4ce 100644 --- a/Documentation/git-gui.txt +++ b/Documentation/git-gui.txt @@ -34,7 +34,7 @@ blame:: browser:: Start a tree browser showing all files in the specified - commit (or 'HEAD' by default). Files selected through the + commit (or 'HEAD' by default). Files selected through the browser are opened in the blame viewer. citool:: @@ -61,7 +61,7 @@ git gui blame Makefile:: git gui blame v0.99.8 Makefile:: Show the contents of 'Makefile' in revision 'v0.99.8' - and provide annotations for each line. Unlike the above + and provide annotations for each line. Unlike the above example the file is read from the object database and not the working directory. -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* Re: [PATCH 03/15] manpages: fix bogus whitespace 2008-07-03 5:03 ` [PATCH 03/15] manpages: fix bogus whitespace Jonathan Nieder @ 2008-07-03 23:55 ` Junio C Hamano 2008-07-04 1:14 ` Jonathan Nieder 0 siblings, 1 reply; 40+ messages in thread From: Junio C Hamano @ 2008-07-03 23:55 UTC (permalink / raw) To: Jonathan Nieder Cc: git, Christian Couder, J. Bruce Fields, Miklos Vajna, Shawn O. Pearce Jonathan Nieder <jrnieder@uchicago.edu> writes: > It's distracting. > > Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> > --- > Documentation/git-fast-import.txt | 2 +- > Documentation/git-format-patch.txt | 8 ++++---- > Documentation/git-gui.txt | 4 ++-- > 3 files changed, 7 insertions(+), 7 deletions(-) > > diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt > index 70cc8e8..9602764 100644 > --- a/Documentation/git-fast-import.txt > +++ b/Documentation/git-fast-import.txt > @@ -86,7 +86,7 @@ OPTIONS > > --quiet:: > Disable all non-fatal output, making fast-import silent when it > - is successful. This option disables the output shown by > + is successful. This option disables the output shown by How did you find *this* one? It took me a few minutes to finally notice that you are talking about the HT. In other words, I had to work hard to get distracted by it. ^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH 03/15] manpages: fix bogus whitespace 2008-07-03 23:55 ` Junio C Hamano @ 2008-07-04 1:14 ` Jonathan Nieder 0 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-04 1:14 UTC (permalink / raw) To: Junio C Hamano Cc: git, Christian Couder, J. Bruce Fields, Miklos Vajna, Shawn O. Pearce Junio C Hamano wrote: > Jonathan Nieder <jrnieder@uchicago.edu> writes: > >> - is successful. This option disables the output shown by >> + is successful. This option disables the output shown by > > How did you find *this* one? It took me a few minutes to finally notice > that you are talking about the HT. In other words, I had to work hard to > get distracted by it. I use vim with listchars=tab:>-,nbsp:~,trail:$ (I was bit too many times by Makefiles mysteriously breaking) so the tab is visibile. If it feels like too much churn for no visible effect, I don't mind if you drop the patch. I feel bad for sending so many documentation patches that don't add to the content in any significant way. Jonathan ^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH 04/15] git(1): add comma 2008-07-03 4:31 ` Jonathan Nieder ` (2 preceding siblings ...) 2008-07-03 5:03 ` [PATCH 03/15] manpages: fix bogus whitespace Jonathan Nieder @ 2008-07-03 5:08 ` Jonathan Nieder 2008-07-03 5:13 ` [PATCH 05/15] git-commit(1): depersonalize description Jonathan Nieder ` (10 subsequent siblings) 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 5:08 UTC (permalink / raw) To: Junio C Hamano; +Cc: git, J. Bruces Fields Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/git.txt | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/Documentation/git.txt b/Documentation/git.txt index f9e4416..5f4d666 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -141,7 +141,7 @@ help ...'. --exec-path:: Path to wherever your core git programs are installed. This can also be controlled by setting the GIT_EXEC_PATH - environment variable. If no path is given 'git' will print + environment variable. If no path is given, 'git' will print the current setting and then exit. -p:: -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 05/15] git-commit(1): depersonalize description 2008-07-03 4:31 ` Jonathan Nieder ` (3 preceding siblings ...) 2008-07-03 5:08 ` [PATCH 04/15] git(1): add comma Jonathan Nieder @ 2008-07-03 5:13 ` Jonathan Nieder 2008-07-03 5:20 ` [PATCH 06/15] Documentation: rewrap to prepare for "git-" vs "git " change Jonathan Nieder ` (9 subsequent siblings) 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 5:13 UTC (permalink / raw) To: Junio C Hamano; +Cc: git, J. Bruce Fields, Olivier Marin, Stephan Beyer The intent is to make git-commit(1) feel more like a manual page. The change also makes the page four words shorter. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/git-commit.txt | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 03594cd..0ac6204 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -15,8 +15,8 @@ SYNOPSIS DESCRIPTION ----------- -Use 'git commit' to store the current contents of the index in a new -commit along with a log message describing the changes you have made. +Stores the current contents of the index in a new commit along +with a log message from the user describing the changes. The content to be added can be specified in several ways: -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 06/15] Documentation: rewrap to prepare for "git-" vs "git " change 2008-07-03 4:31 ` Jonathan Nieder ` (4 preceding siblings ...) 2008-07-03 5:13 ` [PATCH 05/15] git-commit(1): depersonalize description Jonathan Nieder @ 2008-07-03 5:20 ` Jonathan Nieder 2008-07-03 5:28 ` [PATCH 07/15] Documentation: more "git-" versus "git " changes Jonathan Nieder ` (8 subsequent siblings) 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 5:20 UTC (permalink / raw) To: Junio C Hamano; +Cc: git, Johannes Schindelin, J. Bruce Fields Rewrap lines in preparation for added dashes. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/config.txt | 4 ++-- Documentation/user-manual.txt | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 52d01b8..498247a 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -627,8 +627,8 @@ gc.autopacklimit:: gc.packrefs:: `git gc` does not run `git pack-refs` in a bare repository by default so that older dumb-transport clients can still fetch - from the repository. Setting this to `true` lets `git - gc` to run `git pack-refs`. Setting this to `false` tells + from the repository. Setting this to `true` lets `git gc` + to run `git pack-refs`. Setting this to `false` tells `git gc` never to run `git pack-refs`. The default setting is `notbare`. Enable it only when you know you do not have to support such clients. The default setting will change to `true` diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index cbfc5d0..61cf30f 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -2443,8 +2443,8 @@ patches to the new mywork. The result will look like: ................................................ In the process, it may discover conflicts. In that case it will stop -and allow you to fix the conflicts; after fixing conflicts, use "git -add" to update the index with those contents, and then, instead of +and allow you to fix the conflicts; after fixing conflicts, use "git add" +to update the index with those contents, and then, instead of running git-commit, just run ------------------------------------------------- @@ -2700,8 +2700,8 @@ master branch. In more detail: git fetch and fast-forwards --------------------------- -In the previous example, when updating an existing branch, "git -fetch" checks to make sure that the most recent commit on the remote +In the previous example, when updating an existing branch, "git fetch" +checks to make sure that the most recent commit on the remote branch is a descendant of the most recent commit on your copy of the branch before updating your copy of the branch to point at the new commit. Git calls this process a <<fast-forwards,fast forward>>. -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 07/15] Documentation: more "git-" versus "git " changes 2008-07-03 4:31 ` Jonathan Nieder ` (5 preceding siblings ...) 2008-07-03 5:20 ` [PATCH 06/15] Documentation: rewrap to prepare for "git-" vs "git " change Jonathan Nieder @ 2008-07-03 5:28 ` Jonathan Nieder 2008-07-03 5:30 ` [PATCH 08/15] gitdiffcore(7): fix awkward wording Jonathan Nieder ` (7 subsequent siblings) 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 5:28 UTC (permalink / raw) To: Junio C Hamano Cc: git, Christian Couder, Nguyen Thai Ngoc Duy, Johanness Schindelin, J. Bruce Fields With git-commands moving out of $(bindir), it is useful to make a clearer distinction between the git subcommand 'git-whatever' and the command you type, `git whatever <options>`. So we use a dash after "git" when referring to the former and not the latter. I already sent a patch doing this same thing, but I missed some spots. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/config.txt | 52 +++++++++++++++++----------------- Documentation/git-bisect.txt | 4 +- Documentation/git-commit.txt | 2 +- Documentation/git-filter-branch.txt | 2 +- Documentation/git-format-patch.txt | 2 +- Documentation/git-help.txt | 2 +- Documentation/git-rebase.txt | 4 +- Documentation/git-reflog.txt | 2 +- Documentation/git-remote.txt | 2 +- Documentation/git-rerere.txt | 2 +- Documentation/git-shortlog.txt | 2 +- Documentation/gitcore-tutorial.txt | 30 ++++++++++---------- Documentation/user-manual.txt | 36 ++++++++++++------------ 13 files changed, 71 insertions(+), 71 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 498247a..5a98a5b 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -356,8 +356,8 @@ core.pager:: core.whitespace:: A comma separated list of common whitespace problems to - notice. `git diff` will use `color.diff.whitespace` to - highlight them, and `git apply --whitespace=error` will + notice. `git-diff` will use `color.diff.whitespace` to + highlight them, and `git-apply --whitespace=error` will consider them as errors: + * `trailing-space` treats trailing whitespaces at the end of the line @@ -426,20 +426,20 @@ branch.autosetuprebase:: This option defaults to never. branch.<name>.remote:: - When in branch <name>, it tells `git fetch` which remote to fetch. - If this option is not given, `git fetch` defaults to remote "origin". + When in branch <name>, it tells `git-fetch` which remote to fetch. + If this option is not given, `git-fetch` defaults to remote "origin". branch.<name>.merge:: - When in branch <name>, it tells `git fetch` the default + When in branch <name>, it tells `git-fetch` the default refspec to be marked for merging in FETCH_HEAD. The value is handled like the remote part of a refspec, and must match a ref which is fetched from the remote given by "branch.<name>.remote". - The merge information is used by `git pull` (which at first calls - `git fetch`) to lookup the default branch for merging. Without - this option, `git pull` defaults to merge the first refspec fetched. + The merge information is used by `git-pull` (which at first calls + `git-fetch`) to lookup the default branch for merging. Without + this option, `git-pull` defaults to merge the first refspec fetched. Specify multiple values to get an octopus merge. - If you wish to setup `git pull` so that it merges into <name> from + If you wish to setup `git-pull` so that it merges into <name> from another branch in the local repository, you can point branch.<name>.merge to the desired branch, and use the special setting `.` (a period) for branch.<name>.remote. @@ -508,12 +508,12 @@ color.diff.<slot>:: color.interactive:: When set to `always`, always use colors for interactive prompts - and displays (such as those used by "git add --interactive"). + and displays (such as those used by "git-add --interactive"). When false (or `never`), never. When set to `true` or `auto`, use colors only when the output is to the terminal. Defaults to false. color.interactive.<slot>:: - Use customized color for `git add --interactive` + Use customized color for `git-add --interactive` output. `<slot>` may be `prompt`, `header`, or `help`, for three distinct types of normal output from interactive programs. The values of these variables may be specified as @@ -550,14 +550,14 @@ color.ui:: take precedence over this setting. Defaults to false. diff.autorefreshindex:: - When using `git diff` to compare with work tree + When using `git-diff` to compare with work tree files, do not consider stat-only change as changed. Instead, silently run `git update-index --refresh` to update the cached stat information for paths whose contents in the work tree match the contents in the index. This option defaults to true. Note that this - affects only `git diff` Porcelain, and not lower level - `diff` commands, such as `git diff-files`. + affects only `git-diff` Porcelain, and not lower level + `diff` commands, such as `git-diff-files`. diff.external:: If this config variable is set, diff generation is not @@ -568,7 +568,7 @@ diff.external:: diff.renameLimit:: The number of files to consider when performing the copy/rename - detection; equivalent to the git diff option '-l'. + detection; equivalent to the git-diff option '-l'. diff.renames:: Tells git to detect renames. If set to any boolean value, it @@ -608,7 +608,7 @@ format.pretty:: gc.aggressiveWindow:: The window size parameter used in the delta compression - algorithm used by 'git gc --aggressive'. This defaults + algorithm used by 'git-gc --aggressive'. This defaults to 10. gc.auto:: @@ -625,37 +625,37 @@ gc.autopacklimit:: default value is 50. Setting this to 0 disables it. gc.packrefs:: - `git gc` does not run `git pack-refs` in a bare repository by + `git-gc` does not run `git pack-refs` in a bare repository by default so that older dumb-transport clients can still fetch - from the repository. Setting this to `true` lets `git gc` + from the repository. Setting this to `true` lets `git-gc` to run `git pack-refs`. Setting this to `false` tells - `git gc` never to run `git pack-refs`. The default setting is + `git-gc` never to run `git pack-refs`. The default setting is `notbare`. Enable it only when you know you do not have to support such clients. The default setting will change to `true` at some stage, and setting this to `false` will continue to - prevent `git pack-refs` from being run from `git gc`. + prevent `git pack-refs` from being run from `git-gc`. gc.pruneexpire:: - When `git gc` is run, it will call `prune --expire 2.weeks.ago`. + When `git-gc` is run, it will call `prune --expire 2.weeks.ago`. Override the grace period with this config variable. gc.reflogexpire:: - `git reflog expire` removes reflog entries older than + `git-reflog expire` removes reflog entries older than this time; defaults to 90 days. gc.reflogexpireunreachable:: - `git reflog expire` removes reflog entries older than + `git-reflog expire` removes reflog entries older than this time and are not reachable from the current tip; defaults to 30 days. gc.rerereresolved:: Records of conflicted merge you resolved earlier are - kept for this many days when `git rerere gc` is run. + kept for this many days when `git-rerere gc` is run. The default is 60 days. See linkgit:git-rerere[1]. gc.rerereunresolved:: Records of conflicted merge you have not resolved are - kept for this many days when `git rerere gc` is run. + kept for this many days when `git-rerere gc` is run. The default is 15 days. See linkgit:git-rerere[1]. rerere.autoupdate:: @@ -849,7 +849,7 @@ instaweb.port:: log.date:: Set default date-time mode for the log command. Setting log.date - value is similar to using git log's --date option. The value is one of + value is similar to using git-log's --date option. The value is one of the following alternatives: {relative,local,default,iso,rfc,short}. See linkgit:git-log[1]. diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt index 8bbcb94..a13983f 100644 --- a/Documentation/git-bisect.txt +++ b/Documentation/git-bisect.txt @@ -26,7 +26,7 @@ on the subcommand: git bisect log git bisect run <cmd>... -This command uses `git rev-list --bisect` to help drive the +This command uses `git-rev-list --bisect` to help drive the binary search process to find which change introduced a bug, given an old "good" commit object name and a later "bad" commit object name. @@ -101,7 +101,7 @@ $ git bisect visualize to see the currently remaining suspects in `gitk`. `visualize` is a bit too long to type and `view` is provided as a synonym. -If `DISPLAY` environment variable is not set, `git log` is used +If 'DISPLAY' environment variable is not set, `git-log` is used instead. You can even give command line options such as `-p` and `--stat`. diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 0ac6204..9812dbd 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -155,7 +155,7 @@ but can be used to amend a merge commit. Make a commit only from the paths specified on the command line, disregarding any contents that have been staged so far. This is the default mode of operation of - 'git commit' if any paths are given on the command line, + 'git-commit' if any paths are given on the command line, in which case this option can be omitted. If this option is specified together with '--amend', then no paths need be specified, which can be used to amend diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt index a9388e0..4262309 100644 --- a/Documentation/git-filter-branch.txt +++ b/Documentation/git-filter-branch.txt @@ -163,7 +163,7 @@ to other tags will be rewritten to point to the underlying commit. -f:: --force:: - `git filter-branch` refuses to start with an existing temporary + `git-filter-branch` refuses to start with an existing temporary directory or when there are already refs starting with 'refs/original/', unless forced. diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index b990052..41e487a 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -190,7 +190,7 @@ EXAMPLES the current branch using `git-am` to cherry-pick them: + ------------ -$ git format-patch -k --stdout R1..R2 | git-am -3 -k +$ git format-patch -k --stdout R1..R2 | git am -3 -k ------------ * Extract all commits which are in the current branch but not in the diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 5ace863..73ec7ad 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -120,7 +120,7 @@ man.<tool>.path You can explicitly provide a full path to your preferred man viewer by setting the configuration variable 'man.<tool>.path'. For example, you can configure the absolute path to konqueror by setting -'man.konqueror.path'. Otherwise, 'git help' assumes the tool is +'man.konqueror.path'. Otherwise, 'git-help' assumes the tool is available in PATH. man.<tool>.cmd diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index 754230e..67aa497 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -259,10 +259,10 @@ NOTES When you rebase a branch, you are changing its history in a way that will cause problems for anyone who already has a copy of the branch in their repository and tries to pull updates from you. You should -understand the implications of using 'git rebase' on a repository that +understand the implications of using 'git-rebase' on a repository that you share. -When the git rebase command is run, it will first execute a "pre-rebase" +When the git-rebase command is run, it will first execute a "pre-rebase" hook if one exists. You can use this hook to do sanity checks and reject the rebase if it isn't appropriate. Please see the template pre-rebase hook script for an example. diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt index 8492aea..d963c51 100644 --- a/Documentation/git-reflog.txt +++ b/Documentation/git-reflog.txt @@ -60,7 +60,7 @@ OPTIONS refs. + This computation involves traversing all the reachable objects, i.e. it -has the same cost as 'git prune'. Fortunately, once this is run, we +has the same cost as 'git-prune'. Fortunately, once this is run, we should not have to ever worry about missing objects, because the current prune and pack-objects know about reflogs and protect objects referred by them. diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt index 32db0ae..3634efd 100644 --- a/Documentation/git-remote.txt +++ b/Documentation/git-remote.txt @@ -124,7 +124,7 @@ $ git checkout -b nfs linux-nfs/master ... ------------ -* Imitate 'git clone' but track only selected branches +* Imitate 'git-clone' but track only selected branches + ------------ $ mkdir project.git diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 3458029..ae2b2b5 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -163,7 +163,7 @@ If this three-way merge resolves cleanly, the result is written out to your working tree file, so you would not have to manually resolve it. Note that `git-rerere` leaves the index file alone, so you still need to do the final sanity checks with `git diff` -(or `git diff -c`) and `git add` when you are satisfied. +(or `git diff -c`) and `git-add` when you are satisfied. As a convenience measure, `git-merge` automatically invokes `git-rerere` when it exits with a failed automerge, which diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt index 6e4cbc4..74a5f29 100644 --- a/Documentation/git-shortlog.txt +++ b/Documentation/git-shortlog.txt @@ -3,7 +3,7 @@ git-shortlog(1) NAME ---- -git-shortlog - Summarize 'git log' output +git-shortlog - Summarize 'git-log' output SYNOPSIS -------- diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt index 7d721c5..059c8ff 100644 --- a/Documentation/gitcore-tutorial.txt +++ b/Documentation/gitcore-tutorial.txt @@ -595,7 +595,7 @@ pointer to the state you want to tag, but also a small tag name and message, along with optionally a PGP signature that says that yes, you really did that tag. You create these annotated tags with either the `-a` or -`-s` flag to `git tag`: +`-s` flag to `git-tag`: ---------------- $ git tag -s <tagname> @@ -642,7 +642,7 @@ and it will be gone. There's no external repository, and there's no history outside the project you created. - if you want to move or duplicate a git repository, you can do so. There - is `git clone` command, but if all you want to do is just to + is `git-clone` command, but if all you want to do is just to create a copy of your repository (with all the full history that went along with it), you can do so with a regular `cp -a git-tutorial new-git-tutorial`. @@ -776,7 +776,7 @@ to it. ================================================ If you make the decision to start your new branch at some other point in the history than the current `HEAD`, you can do so by -just telling `git checkout` what the base of the checkout would be. +just telling `git-checkout` what the base of the checkout would be. In other words, if you have an earlier tag or branch, you'd just do ------------ @@ -819,7 +819,7 @@ $ git branch <branchname> [startingpoint] which will simply _create_ the branch, but will not do anything further. You can then later -- once you decide that you want to actually develop -on that branch -- switch to that branch with a regular `git checkout` +on that branch -- switch to that branch with a regular `git-checkout` with the branchname as the argument. @@ -881,7 +881,7 @@ source. Anyway, let's exit `gitk` (`^Q` or the File menu), and decide that we want to merge the work we did on the `mybranch` branch into the `master` branch (which is currently our `HEAD` too). To do that, there's a nice -script called `git merge`, which wants to know which branches you want +script called `git-merge`, which wants to know which branches you want to resolve and what the merge is all about: ------------ @@ -1023,12 +1023,12 @@ Merging external work It's usually much more common that you merge with somebody else than merging with your own branches, so it's worth pointing out that git makes that very easy too, and in fact, it's not that different from -doing a `git merge`. In fact, a remote merge ends up being nothing +doing a `git-merge`. In fact, a remote merge ends up being nothing more than "fetch the work from a remote repository into a temporary tag" -followed by a `git merge`. +followed by a `git-merge`. Fetching from a remote repository is done by, unsurprisingly, -`git fetch`: +`git-fetch`: ---------------- $ git fetch <remote-repository> @@ -1115,7 +1115,7 @@ argument. [NOTE] You could do without using any branches at all, by keeping as many local repositories as you would like to have -branches, and merging between them with `git pull`, just like +branches, and merging between them with `git-pull`, just like you merge between branches. The advantage of this approach is that it lets you keep a set of files for each `branch` checked out and you may find it easier to switch back and forth if you @@ -1132,7 +1132,7 @@ like this: $ git config remote.linus.url http://www.kernel.org/pub/scm/git/git.git/ ------------------------------------------------ -and use the "linus" keyword with `git pull` instead of the full URL. +and use the "linus" keyword with `git-pull` instead of the full URL. Examples. @@ -1168,7 +1168,7 @@ $ git show-branch --more=2 master mybranch +* [master^] Some fun. ------------ -Remember, before running `git merge`, our `master` head was at +Remember, before running `git-merge`, our `master` head was at "Some fun." commit, while our `mybranch` head was at "Some work." commit. @@ -1345,7 +1345,7 @@ $ mkdir my-git.git ------------ Then, make that directory into a git repository by running -`git init`, but this time, since its name is not the usual +`git-init`, but this time, since its name is not the usual `.git`, we do things slightly differently: ------------ @@ -1407,7 +1407,7 @@ $ git repack will do it for you. If you followed the tutorial examples, you would have accumulated about 17 objects in `.git/objects/??/` -directories by now. `git repack` tells you how many objects it +directories by now. `git-repack` tells you how many objects it packed, and stores the packed file in `.git/objects/pack` directory. @@ -1656,8 +1656,8 @@ $ git reset --hard master~2 ------------ You can make sure 'git show-branch' matches the state before -those two 'git merge' you just did. Then, instead of running -two 'git merge' commands in a row, you would merge these two +those two 'git-merge' you just did. Then, instead of running +two 'git-merge' commands in a row, you would merge these two branch heads (this is known as 'making an Octopus'): ------------ diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 61cf30f..01c1af6 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1963,10 +1963,10 @@ error: failed to push to 'ssh://yourserver.com/~you/proj.git' This can happen, for example, if you: - - use `git reset --hard` to remove already-published commits, or - - use `git commit --amend` to replace already-published commits + - use `git-reset --hard` to remove already-published commits, or + - use `git-commit --amend` to replace already-published commits (as in <<fixing-a-mistake-by-rewriting-history>>), or - - use `git rebase` to rebase any already-published commits (as + - use `git-rebase` to rebase any already-published commits (as in <<using-git-rebase>>). You may force git-push to perform the update anyway by preceding the @@ -2170,7 +2170,7 @@ they are for, or what status they are in. To get a reminder of what changes are in a specific branch, use: ------------------------------------------------- -$ git log linux..branchname | git-shortlog +$ git log linux..branchname | git shortlog ------------------------------------------------- To see whether it has already been merged into the test or release branches, @@ -2443,7 +2443,7 @@ patches to the new mywork. The result will look like: ................................................ In the process, it may discover conflicts. In that case it will stop -and allow you to fix the conflicts; after fixing conflicts, use "git add" +and allow you to fix the conflicts; after fixing conflicts, use "git-add" to update the index with those contents, and then, instead of running git-commit, just run @@ -2700,7 +2700,7 @@ master branch. In more detail: git fetch and fast-forwards --------------------------- -In the previous example, when updating an existing branch, "git fetch" +In the previous example, when updating an existing branch, "git-fetch" checks to make sure that the most recent commit on the remote branch is a descendant of the most recent commit on your copy of the branch before updating your copy of the branch to point at the new @@ -2726,7 +2726,7 @@ resulting in a situation like: o--o--o <-- new head of the branch ................................................ -In this case, "git fetch" will fail, and print out a warning. +In this case, "git-fetch" will fail, and print out a warning. In that case, you can still force git to update to the new head, as described in the following section. However, note that in the @@ -3106,7 +3106,7 @@ $ git prune to remove any of the "loose" objects that are now contained in the pack. This will also remove any unreferenced objects (which may be -created when, for example, you use "git reset" to remove a commit). +created when, for example, you use "git-reset" to remove a commit). You can verify that the loose objects are gone by looking at the .git/objects directory or by running @@ -3135,7 +3135,7 @@ branch still exists, as does everything it pointed to. The branch pointer itself just doesn't, since you replaced it with another one. There are also other situations that cause dangling objects. For -example, a "dangling blob" may arise because you did a "git add" of a +example, a "dangling blob" may arise because you did a "git-add" of a file, but then, before you actually committed it and made it part of the bigger picture, you changed something else in that file and committed that *updated* thing--the old state that you added originally ends up @@ -3185,7 +3185,7 @@ Usually, dangling blobs and trees aren't very interesting. They're almost always the result of either being a half-way mergebase (the blob will often even have the conflict markers from a merge in it, if you have had conflicting merges that you fixed up by hand), or simply -because you interrupted a "git fetch" with ^C or something like that, +because you interrupted a "git-fetch" with ^C or something like that, leaving _some_ of the new objects in the object database, but just dangling and useless. @@ -3694,7 +3694,7 @@ removed. The only thing `--remove` means is that update-index will be considering a removed file to be a valid thing, and if the file really does not exist any more, it will update the index accordingly. -As a special case, you can also do `git-update-index --refresh`, which +As a special case, you can also do `git update-index --refresh`, which will refresh the "stat" information of each index to match the current stat information. It will 'not' update the object status itself, and it will only update the fields that are used to quickly test whether @@ -3770,7 +3770,7 @@ from one representation to the other: Tying it all together ~~~~~~~~~~~~~~~~~~~~~ -To commit a tree you have instantiated with "git-write-tree", you'd +To commit a tree you have instantiated with "git write-tree", you'd create a "commit" object that refers to that tree and the history behind it--most notably the "parent" commits that preceded it in history. @@ -3927,7 +3927,7 @@ $ git read-tree -m -u <origtree> <yourtree> <targettree> which will do all trivial merge operations for you directly in the index file, and you can just write the result out with -`git-write-tree`. +`git write-tree`. [[merging-multiple-trees-2]] @@ -4095,7 +4095,7 @@ functions like `get_sha1_basic()` or the likes. This is just to get you into the groove for the most libified part of Git: the revision walker. -Basically, the initial version of `git log` was a shell script: +Basically, the initial version of `git-log` was a shell script: ---------------------------------------------------------------- $ git-rev-list --pretty $(git-rev-parse --default HEAD "$@") | \ @@ -4130,7 +4130,7 @@ just have a look at the first implementation of `cmd_log()`; call `git show v1.3.0{tilde}155^2{tilde}4` and scroll down to that function (note that you no longer need to call `setup_pager()` directly). -Nowadays, `git log` is a builtin, which means that it is _contained_ in the +Nowadays, `git-log` is a builtin, which means that it is _contained_ in the command `git`. The source side of a builtin is - a function called `cmd_<bla>`, typically defined in `builtin-<bla>.c`, @@ -4146,7 +4146,7 @@ since they share quite a bit of code. In that case, the commands which are _not_ named like the `.c` file in which they live have to be listed in `BUILT_INS` in the `Makefile`. -`git log` looks more complicated in C than it does in the original script, +`git-log` looks more complicated in C than it does in the original script, but that allows for a much greater flexibility and performance. Here again it is a good point to take a pause. @@ -4157,9 +4157,9 @@ the organization of Git (after you know the basic concepts). So, think about something which you are interested in, say, "how can I access a blob just knowing the object name of it?". The first step is to find a Git command with which you can do it. In this example, it is either -`git show` or `git cat-file`. +`git-show` or `git-cat-file`. -For the sake of clarity, let's stay with `git cat-file`, because it +For the sake of clarity, let's stay with `git-cat-file`, because it - is plumbing, and -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 08/15] gitdiffcore(7): fix awkward wording 2008-07-03 4:31 ` Jonathan Nieder ` (6 preceding siblings ...) 2008-07-03 5:28 ` [PATCH 07/15] Documentation: more "git-" versus "git " changes Jonathan Nieder @ 2008-07-03 5:30 ` Jonathan Nieder 2008-07-03 5:36 ` [PATCH 09/15] manpages: italicize command names in synopses Jonathan Nieder ` (6 subsequent siblings) 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 5:30 UTC (permalink / raw) To: Junio C Hamano; +Cc: git, Chris Shoemaker The phrase "diff outputs" sounds awkward to my ear (I think "output" is meant to be used as a substantive noun.) Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/gitdiffcore.txt | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index 0b7daed..1171b5c 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -16,8 +16,8 @@ The diff commands `git-diff-index`, `git-diff-files`, and `git-diff-tree` can be told to manipulate differences they find in unconventional ways before showing `diff` output. The manipulation is collectively called "diffcore transformation". This short note -describes what they are and how to use them to produce diff outputs -that are easier to understand than the conventional kind. +describes what they are and how to use them to produce diff output +that is easier to understand than the conventional kind. The chain of operation -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 09/15] manpages: italicize command names in synopses 2008-07-03 4:31 ` Jonathan Nieder ` (7 preceding siblings ...) 2008-07-03 5:30 ` [PATCH 08/15] gitdiffcore(7): fix awkward wording Jonathan Nieder @ 2008-07-03 5:36 ` Jonathan Nieder 2008-07-03 5:37 ` [PATCH 10/15] manpages: italicize command names Jonathan Nieder ` (5 subsequent siblings) 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 5:36 UTC (permalink / raw) To: Junio C Hamano; +Cc: git, Dan McGee, J. Bruce Fields, Michele Ballabio To tell command names from options in a glance. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/git-reflog.txt | 10 +++++----- Documentation/git-remote.txt | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt index d963c51..1710626 100644 --- a/Documentation/git-reflog.txt +++ b/Documentation/git-reflog.txt @@ -16,12 +16,12 @@ The command takes various subcommands, and different options depending on the subcommand: [verse] -git reflog expire [--dry-run] [--stale-fix] [--verbose] +'git reflog expire' [--dry-run] [--stale-fix] [--verbose] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>... - -git reflog delete ref@\{specifier\}... - -git reflog [show] [log-options] [<ref>] ++ +'git reflog delete' ref@\{specifier\}... ++ +'git reflog' ['show'] [log-options] [<ref>] Reflog is a mechanism to record when the tip of branches are updated. This command is to manage the information recorded in it. diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt index 3634efd..bb99810 100644 --- a/Documentation/git-remote.txt +++ b/Documentation/git-remote.txt @@ -10,11 +10,11 @@ SYNOPSIS -------- [verse] 'git remote' [-v | --verbose] -'git remote' add [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url> -'git remote' rm <name> -'git remote' show [-n] <name> -'git remote' prune [-n | --dry-run] <name> -'git remote' update [group] +'git remote add' [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url> +'git remote rm' <name> +'git remote show' [-n] <name> +'git remote prune' [-n | --dry-run] <name> +'git remote update' [group] DESCRIPTION ----------- -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 10/15] manpages: italicize command names 2008-07-03 4:31 ` Jonathan Nieder ` (8 preceding siblings ...) 2008-07-03 5:36 ` [PATCH 09/15] manpages: italicize command names in synopses Jonathan Nieder @ 2008-07-03 5:37 ` Jonathan Nieder 2008-07-03 5:45 ` [PATCH 11/15] manpages: italicize git command names (which were in teletype font) Jonathan Nieder ` (4 subsequent siblings) 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 5:37 UTC (permalink / raw) To: Junio C Hamano Cc: git, Christian Couder, Nguyen Thai Ngoc Duy, Jon Loeliger, Dan McGee, J. Bruce Fields, Olivier Marin This includes nongit commands like RCS 'merge'. This patch only italicizes names of commands if they had no formatting before. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- The escaping under "log.date" in config.txt works for me with asciidoc 8.2.6 and ASCIIDOC8=YesPlease. Will it work on asciidoc 7? Documentation/config.txt | 4 ++-- Documentation/git-apply.txt | 6 +++--- Documentation/git-merge-file.txt | 2 +- Documentation/git-merge-index.txt | 2 +- Documentation/git-rerere.txt | 4 ++-- Documentation/gitdiffcore.txt | 4 ++-- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 5a98a5b..84a0e77 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -568,7 +568,7 @@ diff.external:: diff.renameLimit:: The number of files to consider when performing the copy/rename - detection; equivalent to the git-diff option '-l'. + detection; equivalent to the 'git-diff' option '-l'. diff.renames:: Tells git to detect renames. If set to any boolean value, it @@ -849,7 +849,7 @@ instaweb.port:: log.date:: Set default date-time mode for the log command. Setting log.date - value is similar to using git-log's --date option. The value is one of the + value is similar to using 'git-log'\'s --date option. The value is one of the following alternatives: {relative,local,default,iso,rfc,short}. See linkgit:git-log[1]. diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index fbe1130..b2f909d 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -18,7 +18,7 @@ SYNOPSIS DESCRIPTION ----------- -Reads supplied diff output and applies it on a git index file +Reads supplied 'diff' output and applies it on a git index file and a work tree. OPTIONS @@ -165,9 +165,9 @@ behavior: * `error-all` is similar to `error` but shows all errors. --inaccurate-eof:: - Under certain circumstances, some versions of diff do not correctly + Under certain circumstances, some versions of 'diff' do not correctly detect a missing new-line at the end of the file. As a result, patches - created by such diff programs do not record incomplete lines + created by such 'diff' programs do not record incomplete lines correctly. This option adds support for applying such patches by working around this bug. diff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt index 2a033dd..b5eb630 100644 --- a/Documentation/git-merge-file.txt +++ b/Documentation/git-merge-file.txt @@ -93,7 +93,7 @@ Written by Johannes Schindelin <johannes.schindelin@gmx.de> Documentation -------------- Documentation by Johannes Schindelin and the git-list <git@vger.kernel.org>, -with parts copied from the original documentation of RCS merge. +with parts copied from the original documentation of RCS 'merge'. GIT --- diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt index 4368084..4f04bbb 100644 --- a/Documentation/git-merge-index.txt +++ b/Documentation/git-merge-index.txt @@ -41,7 +41,7 @@ processes them in turn only stopping if merge returns a non-zero exit code. Typically this is run with a script calling git's imitation of -the merge command from the RCS package. +the 'merge' command from the RCS package. A sample script called `git-merge-one-file` is included in the distribution. diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index ae2b2b5..30ec68d 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -7,7 +7,7 @@ git-rerere - Reuse recorded resolution of conflicted merges SYNOPSIS -------- -'git rerere' [clear|diff|status|gc] +'git rerere' ['clear'|'diff'|'status'|'gc'] DESCRIPTION ----------- @@ -49,7 +49,7 @@ conflicts. Additional arguments are passed directly to the system 'status':: -Like diff, but this only prints the filenames that will be tracked +Like 'diff', but this only prints the filenames that will be tracked for resolutions. 'gc':: diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index 1171b5c..949332b 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -7,7 +7,7 @@ gitdiffcore - Tweaking diff output (June 2005) SYNOPSIS -------- -git diff * +'git diff' * DESCRIPTION ----------- @@ -16,7 +16,7 @@ The diff commands `git-diff-index`, `git-diff-files`, and `git-diff-tree` can be told to manipulate differences they find in unconventional ways before showing `diff` output. The manipulation is collectively called "diffcore transformation". This short note -describes what they are and how to use them to produce diff output +describes what they are and how to use them to produce 'diff' output that is easier to understand than the conventional kind. -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 11/15] manpages: italicize git command names (which were in teletype font) 2008-07-03 4:31 ` Jonathan Nieder ` (9 preceding siblings ...) 2008-07-03 5:37 ` [PATCH 10/15] manpages: italicize command names Jonathan Nieder @ 2008-07-03 5:45 ` Jonathan Nieder 2008-07-03 5:49 ` [PATCH 12/15] manpages: italicize gitk's name (where it was " Jonathan Nieder ` (3 subsequent siblings) 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 5:45 UTC (permalink / raw) To: Junio C Hamano Cc: git, Christian Couder, Nguyen Thai Ngoc Duy, Jon Loeliger, Dan McGee, J. Bruce Fields, Olivier Marin This patch is huge (256 KB), so I am not sending it. You can find it at <http://home.uchicago.edu/~jrnieder/20080703-git-italics.txt>. The names of git commands are not meant to be entered at the commandline; they are just names. So we render them in italics, as is usual for command names in manpages. Using doit () { perl -e 'for (<>) { s/\`(git-[^\`.]*)\`/'\''\1'\''/g; print }' } for i in git*.txt config.txt diff*.txt blame*.txt fetch*.txt i18n.txt \ merge*.txt pretty*.txt pull*.txt rev*.txt urls*.txt do doit <"$i" >"$i+" && mv "$i+" "$i" done git diff . Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> My script missed some spots, but I don't think there were any false positives. (I hope there weren't.) Documentation/config.txt | 56 ++++++------ Documentation/fetch-options.txt | 8 +- Documentation/git-am.txt | 14 ++-- Documentation/git-apply.txt | 10 +- Documentation/git-archimport.txt | 12 +- Documentation/git-archive.txt | 6 +- Documentation/git-bisect.txt | 6 +- Documentation/git-blame.txt | 8 +- Documentation/git-branch.txt | 8 +- Documentation/git-bundle.txt | 26 +++--- Documentation/git-check-ref-format.txt | 2 +- Documentation/git-checkout-index.txt | 8 +- Documentation/git-checkout.txt | 4 +- Documentation/git-cherry-pick.txt | 2 +- Documentation/git-cherry.txt | 6 +- Documentation/git-citool.txt | 4 +- Documentation/git-clean.txt | 4 +- Documentation/git-clone.txt | 6 +- Documentation/git-commit-tree.txt | 2 +- Documentation/git-commit.txt | 20 ++-- Documentation/git-config.txt | 12 +- Documentation/git-cvsexportcommit.txt | 2 +- Documentation/git-cvsimport.txt | 18 ++-- Documentation/git-cvsserver.txt | 38 ++++---- Documentation/git-daemon.txt | 40 ++++---- Documentation/git-describe.txt | 6 +- Documentation/git-diff-files.txt | 2 +- Documentation/git-diff-index.txt | 20 ++-- Documentation/git-diff-tree.txt | 10 +- Documentation/git-fast-export.txt | 8 +- Documentation/git-fast-import.txt | 20 ++-- Documentation/git-fetch-pack.txt | 14 ++-- Documentation/git-fetch.txt | 2 +- Documentation/git-filter-branch.txt | 14 ++-- Documentation/git-fmt-merge-msg.txt | 4 +- Documentation/git-for-each-ref.txt | 2 +- Documentation/git-format-patch.txt | 6 +- Documentation/git-fsck.txt | 4 +- Documentation/git-gc.txt | 20 ++-- Documentation/git-get-tar-commit-id.txt | 6 +- Documentation/git-grep.txt | 2 +- Documentation/git-gui.txt | 20 ++-- Documentation/git-hash-object.txt | 2 +- Documentation/git-help.txt | 6 +- Documentation/git-http-fetch.txt | 2 +- Documentation/git-imap-send.txt | 2 +- Documentation/git-index-pack.txt | 8 +- Documentation/git-init.txt | 6 +- Documentation/git-instaweb.txt | 2 +- Documentation/git-log.txt | 4 +- Documentation/git-ls-files.txt | 6 +- Documentation/git-ls-remote.txt | 2 +- Documentation/git-mailinfo.txt | 4 +- Documentation/git-merge-base.txt | 4 +- Documentation/git-merge-file.txt | 10 +- Documentation/git-merge-index.txt | 8 +- Documentation/git-merge-one-file.txt | 4 +- Documentation/git-merge.txt | 16 ++-- Documentation/git-mergetool.txt | 16 ++-- Documentation/git-name-rev.txt | 6 +- Documentation/git-pack-objects.txt | 6 +- Documentation/git-pack-redundant.txt | 2 +- Documentation/git-parse-remote.txt | 2 +- Documentation/git-patch-id.txt | 2 +- Documentation/git-peek-remote.txt | 6 +- Documentation/git-prune.txt | 14 ++-- Documentation/git-pull.txt | 10 +- Documentation/git-push.txt | 4 +- Documentation/git-read-tree.txt | 42 ++++---- Documentation/git-rebase.txt | 26 +++--- Documentation/git-receive-pack.txt | 12 +- Documentation/git-repack.txt | 14 ++-- Documentation/git-rerere.txt | 28 +++--- Documentation/git-reset.txt | 2 +- Documentation/git-rev-list.txt | 6 +- Documentation/git-rev-parse.txt | 24 +++--- Documentation/git-revert.txt | 4 +- Documentation/git-rm.txt | 4 +- Documentation/git-send-pack.txt | 10 +- Documentation/git-sh-setup.txt | 2 +- Documentation/git-shell.txt | 2 +- Documentation/git-shortlog.txt | 2 +- Documentation/git-show-branch.txt | 2 +- Documentation/git-show-index.txt | 4 +- Documentation/git-show-ref.txt | 4 +- Documentation/git-show.txt | 6 +- Documentation/git-stash.txt | 6 +- Documentation/git-status.txt | 6 +- Documentation/git-submodule.txt | 4 +- Documentation/git-svn.txt | 106 ++++++++++---------- Documentation/git-symbolic-ref.txt | 2 +- Documentation/git-tag.txt | 8 +- Documentation/git-tar-tree.txt | 6 +- Documentation/git-update-index.txt | 22 ++-- Documentation/git-upload-archive.txt | 2 +- Documentation/git-upload-pack.txt | 6 +- Documentation/git-var.txt | 2 +- Documentation/git-verify-pack.txt | 2 +- Documentation/git-verify-tag.txt | 2 +- Documentation/git-web--browse.txt | 6 +- Documentation/git-whatchanged.txt | 4 +- Documentation/git-write-tree.txt | 8 +- Documentation/git.txt | 8 +- Documentation/gitattributes.txt | 16 ++-- Documentation/gitcore-tutorial.txt | 162 +++++++++++++++--------------- Documentation/gitcvs-migration.txt | 12 +- Documentation/gitdiffcore.txt | 30 +++--- Documentation/githooks.txt | 74 +++++++------- Documentation/gitignore.txt | 4 +- Documentation/gitk.txt | 2 +- Documentation/gitrepository-layout.txt | 18 ++-- Documentation/gittutorial-2.txt | 16 ++-- Documentation/gittutorial.txt | 42 ++++---- Documentation/i18n.txt | 4 +- Documentation/merge-options.txt | 4 +- Documentation/pull-fetch-param.txt | 8 +- Documentation/urls-remotes.txt | 4 +- 117 files changed, 713 insertions(+), 713 deletions(-) patch at <http://home.uchicago.edu/~jrnieder/20080703-git-italics.txt> ^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH 12/15] manpages: italicize gitk's name (where it was in teletype font) 2008-07-03 4:31 ` Jonathan Nieder ` (10 preceding siblings ...) 2008-07-03 5:45 ` [PATCH 11/15] manpages: italicize git command names (which were in teletype font) Jonathan Nieder @ 2008-07-03 5:49 ` Jonathan Nieder 2008-07-03 5:55 ` [PATCH 13/15] manpages: italicize nongit command names (if they are " Jonathan Nieder ` (2 subsequent siblings) 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 5:49 UTC (permalink / raw) To: Junio C Hamano Cc: git, Jonas Fonseca, J. Bruce Fields, Olivier Marin, Jonas Fonseca The name `gitk` is sometimes meant to be entered at the command prompt, but most uses are just referring to the program with that name (not the incantation to start it). Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/git-bisect.txt | 2 +- Documentation/git-gui.txt | 4 ++-- Documentation/gitcore-tutorial.txt | 2 +- Documentation/gittutorial.txt | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt index c794914..c7981ef 100644 --- a/Documentation/git-bisect.txt +++ b/Documentation/git-bisect.txt @@ -98,7 +98,7 @@ During the bisection process, you can say $ git bisect visualize ------------ -to see the currently remaining suspects in `gitk`. `visualize` is a bit +to see the currently remaining suspects in 'gitk'. `visualize` is a bit too long to type and `view` is provided as a synonym. If 'DISPLAY' environment variable is not set, 'git-log' is used diff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt index f067772..a73201d 100644 --- a/Documentation/git-gui.txt +++ b/Documentation/git-gui.txt @@ -16,9 +16,9 @@ on allowing users to make changes to their repository by making new commits, amending existing ones, creating branches, performing local merges, and fetching/pushing to remote repositories. -Unlike `gitk`, 'git-gui' focuses on commit generation +Unlike 'gitk', 'git-gui' focuses on commit generation and single file annotation and does not show project history. -It does however supply menu actions to start a `gitk` session from +It does however supply menu actions to start a 'gitk' session from within 'git-gui'. 'git-gui' is known to work on all popular UNIX systems, Mac OS X, diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt index 2bbe7de..3eba973 100644 --- a/Documentation/gitcore-tutorial.txt +++ b/Documentation/gitcore-tutorial.txt @@ -878,7 +878,7 @@ means: normally it will just show you your current `HEAD`) and their histories. You can also see exactly how they came to be from a common source. -Anyway, let's exit `gitk` (`^Q` or the File menu), and decide that we want +Anyway, let's exit 'gitk' (`^Q` or the File menu), and decide that we want to merge the work we did on the `mybranch` branch into the `master` branch (which is currently our `HEAD` too). To do that, there's a nice script called 'git-merge', which wants to know which branches you want diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt index 930f690..85abc6e 100644 --- a/Documentation/gittutorial.txt +++ b/Documentation/gittutorial.txt @@ -554,7 +554,7 @@ then merged back together, the order in which 'git-log' presents those commits is meaningless. Most projects with multiple contributors (such as the linux kernel, -or git itself) have frequent merges, and `gitk` does a better job of +or git itself) have frequent merges, and 'gitk' does a better job of visualizing their history. For example, ------------------------------------- -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 13/15] manpages: italicize nongit command names (if they are in teletype font) 2008-07-03 4:31 ` Jonathan Nieder ` (11 preceding siblings ...) 2008-07-03 5:49 ` [PATCH 12/15] manpages: italicize gitk's name (where it was " Jonathan Nieder @ 2008-07-03 5:55 ` Jonathan Nieder 2008-07-03 5:59 ` [PATCH 14/15] manpages: italicize git subcommand names (which were " Jonathan Nieder 2008-07-03 6:06 ` [PATCH 15/15] manpages: use teletype font for sample command lines Jonathan Nieder 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 5:55 UTC (permalink / raw) To: Junio C Hamano Cc: git, Sven Verdoolaege, Martin Langhoff, Jon Loeliger, Johannes Schindelin, J. Bruce Fields Some manual pages use teletype font to set command names. We change them to use italics, instead. This creates a visual distinction between names of commands and command lines that can be typed at the command line. It is also more consistent with other man pages outside Git. In this patch, the commands named are non-git commands like bash. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/git-apply.txt | 2 +- Documentation/git-cvsserver.txt | 4 ++-- Documentation/git-fsck.txt | 2 +- Documentation/git-merge-file.txt | 4 ++-- Documentation/git-merge-index.txt | 4 ++-- Documentation/git-rerere.txt | 2 +- Documentation/git-svn.txt | 2 +- Documentation/git.txt | 2 +- Documentation/gitattributes.txt | 6 +++--- Documentation/gitcore-tutorial.txt | 14 +++++++------- Documentation/gitcvs-migration.txt | 4 ++-- Documentation/gitdiffcore.txt | 2 +- 12 files changed, 24 insertions(+), 24 deletions(-) diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index f82c2ce..ca60efd 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -121,7 +121,7 @@ discouraged. --no-add:: When applying a patch, ignore additions made by the patch. This can be used to extract the common part between - two files by first running `diff` on them and applying + two files by first running 'diff' on them and applying the result with this option, which would apply the deletion part but not addition part. diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt index 1804701..2aacdc6 100644 --- a/Documentation/git-cvsserver.txt +++ b/Documentation/git-cvsserver.txt @@ -115,7 +115,7 @@ This has the advantage that it will be saved in your 'CVS/Root' files and you don't need to worry about always setting the correct environment variable. SSH users restricted to 'git-shell' don't need to override the default with CVS_SERVER (and shouldn't) as 'git-shell' understands `cvs` to mean -'git-cvsserver' and pretends that the other end runs the real `cvs` better. +'git-cvsserver' and pretends that the other end runs the real 'cvs' better. -- 2. For each repo that you want accessible from CVS you need to edit config in the repo and add the following section. @@ -328,7 +328,7 @@ is left blank. But if `gitcvs.allbinary` is set to "guess", then the correct '-k' mode will be guessed based on the contents of the file. -For best consistency with `cvs`, it is probably best to override the +For best consistency with 'cvs', it is probably best to override the defaults by setting `gitcvs.usecrlfattr` to true, and `gitcvs.allbinary` to "guess". diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt index 524e0b1..d5a7647 100644 --- a/Documentation/git-fsck.txt +++ b/Documentation/git-fsck.txt @@ -87,7 +87,7 @@ sorted properly etc), but on the whole if 'git-fsck' is happy, you do have a valid tree. Any corrupt objects you will have to find in backups or other archives -(i.e., you can just remove them and do an `rsync` with some other site in +(i.e., you can just remove them and do an 'rsync' with some other site in the hopes that somebody else has the object you have corrupted). Of course, "valid tree" doesn't mean that it wasn't generated by some diff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt index 4ae4bdc..a11c475 100644 --- a/Documentation/git-merge-file.txt +++ b/Documentation/git-merge-file.txt @@ -42,8 +42,8 @@ lines from `<other-file>` respectively. The exit value of this program is negative on error, and the number of conflicts otherwise. If the merge was clean, the exit value is 0. -'git-merge-file' is designed to be a minimal clone of RCS `merge`; that is, it -implements all of RCS merge's functionality which is needed by +'git-merge-file' is designed to be a minimal clone of RCS 'merge'; that is, it +implements all of RCS 'merge''s functionality which is needed by linkgit:git[1]. diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt index 5ebed57..ff088c5 100644 --- a/Documentation/git-merge-index.txt +++ b/Documentation/git-merge-index.txt @@ -47,9 +47,9 @@ A sample script called 'git-merge-one-file' is included in the distribution. ALERT ALERT ALERT! The git "merge object order" is different from the -RCS `merge` program merge object order. In the above ordering, the +RCS 'merge' program merge object order. In the above ordering, the original is first. But the argument order to the 3-way merge program -`merge` is to have the original in the middle. Don't ask me why. +'merge' is to have the original in the middle. Don't ask me why. Examples: diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 666349d..678bfd3 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -45,7 +45,7 @@ will automatically invoke this command. This displays diffs for the current state of the resolution. It is useful for tracking what has changed while the user is resolving conflicts. Additional arguments are passed directly to the system -`diff` command installed in PATH. +'diff' command installed in PATH. 'status':: diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt index dd12335..dc5b8f6 100644 --- a/Documentation/git-svn.txt +++ b/Documentation/git-svn.txt @@ -565,7 +565,7 @@ branch. 'git-clone' does not clone branches under the refs/remotes/ hierarchy or any 'git-svn' metadata, or config. So repositories created and managed with -using 'git-svn' should use `rsync` for cloning, if cloning is to be done +using 'git-svn' should use 'rsync' for cloning, if cloning is to be done at all. Since 'dcommit' uses rebase internally, any git branches you 'git-push' to diff --git a/Documentation/git.txt b/Documentation/git.txt index 992a46d..4d54791 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -493,7 +493,7 @@ other 'GIT_SSH':: If this environment variable is set then 'git-fetch' and 'git-push' will use this command instead - of `ssh` when they need to connect to a remote system. + of 'ssh' when they need to connect to a remote system. The '$GIT_SSH' command will be given exactly two arguments: the 'username@host' (or just 'host') from the URL and the shell command to execute on that remote system. diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt index 0b53044..6a246eb 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -278,7 +278,7 @@ is prefixed with a line of the form: The text is called 'hunk header', and by default a line that begins with an alphabet, an underscore or a dollar sign is used, -which matches what GNU `diff -p` output uses. This default +which matches what GNU 'diff -p' output uses. This default selection however is not suited for some contents, and you can use customized pattern to make a selection. @@ -322,7 +322,7 @@ and other programs such as `git revert` and `git cherry-pick`. Set:: Built-in 3-way merge driver is used to merge the - contents in a way similar to `merge` command of `RCS` + contents in a way similar to 'merge' command of `RCS` suite. This is suitable for ordinary text files. Unset:: @@ -426,7 +426,7 @@ Checking whitespace errors ^^^^^^^^^^^^ The `core.whitespace` configuration variable allows you to define what -`diff` and `apply` should consider whitespace errors for all paths in +'diff' and 'apply' should consider whitespace errors for all paths in the project (See linkgit:git-config[1]). This attribute gives you finer control per path. diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt index 3eba973..5acdeb7 100644 --- a/Documentation/gitcore-tutorial.txt +++ b/Documentation/gitcore-tutorial.txt @@ -61,7 +61,7 @@ Initialized empty Git repository in .git/ which is just git's way of saying that you haven't been doing anything strange, and that it will have created a local `.git` directory setup for your new project. You will now have a `.git` directory, and you can -inspect that with `ls`. For your new empty project, it should show you +inspect that with 'ls'. For your new empty project, it should show you three entries, among other things: - a file called `HEAD`, that has `ref: refs/heads/master` in it. @@ -660,7 +660,7 @@ in the new repository to make sure that the index file is up-to-date. Note that the second point is true even across machines. You can duplicate a remote git repository with *any* regular copy mechanism, be it -`scp`, `rsync` or `wget`. +'scp', 'rsync' or 'wget'. When copying a remote repository, you'll want to at a minimum update the index cache when you do this, and especially with other peoples' @@ -1066,9 +1066,9 @@ most efficient way to exchange git objects between repositories. Local directory:: `/path/to/repo.git/` + -This transport is the same as SSH transport but uses `sh` to run +This transport is the same as SSH transport but uses 'sh' to run both ends on the local machine instead of running other end on -the remote machine via `ssh`. +the remote machine via 'ssh'. git Native:: `git://remote.machine/path/to/repo.git/` @@ -1275,8 +1275,8 @@ fatal: merge program failed describe those three versions, and is responsible to leave the merge results in the working tree. It is a fairly straightforward shell script, and -eventually calls `merge` program from RCS suite to perform a -file-level 3-way merge. In this case, `merge` detects +eventually calls 'merge' program from RCS suite to perform a +file-level 3-way merge. In this case, 'merge' detects conflicts, and the merge result with conflict marks is left in the working tree.. This can be seen if you run `ls-files --stage` again at this point: @@ -1360,7 +1360,7 @@ program on the `$PATH`. [NOTE] Many installations of sshd do not invoke your shell as the login shell when you directly run programs; what this means is that if -your login shell is `bash`, only `.bashrc` is read and not +your login shell is 'bash', only `.bashrc` is read and not `.bash_profile`. As a workaround, make sure `.bashrc` sets up `$PATH` so that you can run 'git-receive-pack' program. diff --git a/Documentation/gitcvs-migration.txt b/Documentation/gitcvs-migration.txt index 41ad608..2737d10 100644 --- a/Documentation/gitcvs-migration.txt +++ b/Documentation/gitcvs-migration.txt @@ -34,7 +34,7 @@ $ git clone foo.com:/pub/repo.git/ my-project $ cd my-project ------------------------------------------------ -and hack away. The equivalent of `cvs update` is +and hack away. The equivalent of 'cvs update' is ------------------------------------------------ $ git pull origin @@ -60,7 +60,7 @@ $ git push origin master ------------------------------------------------ to "push" those commits to the shared repository. If someone else has -updated the repository more recently, 'git-push', like `cvs commit`, will +updated the repository more recently, 'git-push', like 'cvs commit', will complain, in which case you must pull any changes before attempting the push again. diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index 84b95a4..2bdbc3d 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -14,7 +14,7 @@ DESCRIPTION The diff commands 'git-diff-index', 'git-diff-files', and 'git-diff-tree' can be told to manipulate differences they find in -unconventional ways before showing `diff` output. The manipulation +unconventional ways before showing 'diff' output. The manipulation is collectively called "diffcore transformation". This short note describes what they are and how to use them to produce 'diff' output that is easier to understand than the conventional kind. -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 14/15] manpages: italicize git subcommand names (which were in teletype font) 2008-07-03 4:31 ` Jonathan Nieder ` (12 preceding siblings ...) 2008-07-03 5:55 ` [PATCH 13/15] manpages: italicize nongit command names (if they are " Jonathan Nieder @ 2008-07-03 5:59 ` Jonathan Nieder 2008-07-03 6:06 ` [PATCH 15/15] manpages: use teletype font for sample command lines Jonathan Nieder 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 5:59 UTC (permalink / raw) To: Junio C Hamano; +Cc: git, J. Bruce Fields, Eric Wong, Johannes Schindelin Italicize those git subcommand names already in teletype we missed. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/config.txt | 8 ++++---- Documentation/git-svn.txt | 2 +- Documentation/gitcore-tutorial.txt | 6 +++--- Documentation/gitcvs-migration.txt | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index b431747..a7071df 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -118,8 +118,8 @@ core.fileMode:: See linkgit:git-update-index[1]. True by default. core.quotepath:: - The commands that output paths (e.g. `ls-files`, - `diff`), when not given the `-z` option, will quote + The commands that output paths (e.g. 'ls-files', + 'diff'), when not given the `-z` option, will quote "unusual" characters in the pathname by enclosing the pathname in a double-quote pair and with backslashes the same way strings in C source code are quoted. If this @@ -557,7 +557,7 @@ diff.autorefreshindex:: contents in the work tree match the contents in the index. This option defaults to true. Note that this affects only 'git-diff' Porcelain, and not lower level - `diff` commands, such as 'git-diff-files'. + 'diff' commands, such as 'git-diff-files'. diff.external:: If this config variable is set, diff generation is not @@ -636,7 +636,7 @@ gc.packrefs:: prevent `git pack-refs` from being run from 'git-gc'. gc.pruneexpire:: - When 'git-gc' is run, it will call `prune --expire 2.weeks.ago`. + When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'. Override the grace period with this config variable. gc.reflogexpire:: diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt index dc5b8f6..e7c0f1c 100644 --- a/Documentation/git-svn.txt +++ b/Documentation/git-svn.txt @@ -551,7 +551,7 @@ CAVEATS For the sake of simplicity and interoperating with a less-capable system (SVN), it is recommended that all 'git-svn' users clone, fetch and dcommit -directly from the SVN server, and avoid all 'git-clone'/`pull`/`merge`/`push` +directly from the SVN server, and avoid all 'git-clone'/'pull'/'merge'/'push' operations between git repositories and branches. The recommended method of exchanging code between git branches and users is 'git-format-patch' and 'git-am', or just 'dcommit'ing to the SVN repository. diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt index 5acdeb7..dd6a268 100644 --- a/Documentation/gitcore-tutorial.txt +++ b/Documentation/gitcore-tutorial.txt @@ -235,7 +235,7 @@ $ git diff-files ------------ Oops. That wasn't very readable. It just spit out its own internal -version of a `diff`, but that internal version really just tells you +version of a 'diff', but that internal version really just tells you that it has noticed that "hello" has been modified, and that the old object contents it had have been replaced with something else. @@ -468,7 +468,7 @@ Inspecting Changes While creating changes is useful, it's even more useful if you can tell later what changed. The most useful command for this is another of the -`diff` family, namely 'git-diff-tree'. +'diff' family, namely 'git-diff-tree'. 'git-diff-tree' can be given two arbitrary trees, and it will tell you the differences between them. Perhaps even more commonly, though, you can @@ -1006,7 +1006,7 @@ the tree of your branch to that of the `master` branch. This is often called 'fast forward' merge. You can run `gitk \--all` again to see how the commit ancestry -looks like, or run `show-branch`, which tells you this. +looks like, or run 'show-branch', which tells you this. ------------------------------------------------ $ git show-branch master mybranch diff --git a/Documentation/gitcvs-migration.txt b/Documentation/gitcvs-migration.txt index 2737d10..2eb6972 100644 --- a/Documentation/gitcvs-migration.txt +++ b/Documentation/gitcvs-migration.txt @@ -46,7 +46,7 @@ them first before running git pull. [NOTE] ================================ -The `pull` command knows where to get updates from because of certain +The 'pull' command knows where to get updates from because of certain configuration variables that were set by the first 'git-clone' command; see `git config -l` and the linkgit:git-config[1] man page for details. @@ -67,7 +67,7 @@ push again. In the 'git-push' command above we specify the name of the remote branch to update (`master`). If we leave that out, 'git-push' tries to update any branches in the remote repository that have the same name as a branch -in the local repository. So the last `push` can be done with either of: +in the local repository. So the last 'push' can be done with either of: ------------ $ git push origin -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH 15/15] manpages: use teletype font for sample command lines 2008-07-03 4:31 ` Jonathan Nieder ` (13 preceding siblings ...) 2008-07-03 5:59 ` [PATCH 14/15] manpages: italicize git subcommand names (which were " Jonathan Nieder @ 2008-07-03 6:06 ` Jonathan Nieder 14 siblings, 0 replies; 40+ messages in thread From: Jonathan Nieder @ 2008-07-03 6:06 UTC (permalink / raw) To: Junio C Hamano Cc: git, Christian Couder, Matthieu Moy, Olivier Marin, J. Bruce Fields I think that some of these uses of italics were meant to be rendered in quotation marks, anyway. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Documentation/git-gui.txt | 2 +- Documentation/git-help.txt | 2 +- Documentation/git-reflog.txt | 4 ++-- Documentation/git.txt | 4 ++-- Documentation/gitcore-tutorial.txt | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt index a73201d..0e650f4 100644 --- a/Documentation/git-gui.txt +++ b/Documentation/git-gui.txt @@ -71,7 +71,7 @@ git gui citool:: git citool:: - Same as 'git gui citool' (above). + Same as `git gui citool` (above). git gui browser maint:: diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index d5b20f8..f414583 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -23,7 +23,7 @@ If a git command is named, a manual page for that command is brought up. The 'man' program is used by default for this purpose, but this can be overridden by other options or configuration variables. -Note that 'git --help ...' is identical as 'git help ...' because the +Note that `git --help ...` is identical to `git help ...` because the former is internally converted into the latter. OPTIONS diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt index 1710626..146d7f5 100644 --- a/Documentation/git-reflog.txt +++ b/Documentation/git-reflog.txt @@ -36,7 +36,7 @@ The subcommand "show" (which is also the default, in the absence of any subcommands) will take all the normal log options, and show the log of the reference provided in the command-line (or `HEAD`, by default). The reflog will cover all recent actions (HEAD reflog records branch switching -as well). It is an alias for 'git log -g --abbrev-commit --pretty=oneline'; +as well). It is an alias for `git log -g --abbrev-commit --pretty=oneline`; see linkgit:git-log[1]. The reflog is useful in various git commands, to specify the old value @@ -46,7 +46,7 @@ point to one week ago", and so on. See linkgit:git-rev-parse[1] for more details. To delete single entries from the reflog, use the subcommand "delete" -and specify the _exact_ entry (e.g. ``git reflog delete master@\{2\}''). +and specify the _exact_ entry (e.g. "`git reflog delete master@\{2\}`"). OPTIONS diff --git a/Documentation/git.txt b/Documentation/git.txt index 4d54791..92c0884 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -135,8 +135,8 @@ OPTIONS + Other options are available to control how the manual page is displayed. See linkgit:git-help[1] for more information, -because 'git --help ...' is converted internally into 'git -help ...'. +because `git --help ...` is converted internally into `git +help ...`. --exec-path:: Path to wherever your core git programs are installed. diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt index dd6a268..a2b9293 100644 --- a/Documentation/gitcore-tutorial.txt +++ b/Documentation/gitcore-tutorial.txt @@ -1655,7 +1655,7 @@ branch before these two merges by resetting it to 'master~2': $ git reset --hard master~2 ------------ -You can make sure 'git show-branch' matches the state before +You can make sure `git show-branch` matches the state before those two 'git-merge' you just did. Then, instead of running two 'git-merge' commands in a row, you would merge these two branch heads (this is known as 'making an Octopus'): -- 1.5.5.GIT ^ permalink raw reply related [flat|nested] 40+ messages in thread
end of thread, other threads:[~2008-07-04 1:15 UTC | newest] Thread overview: 40+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2008-06-30 21:56 [PATCH 0/7] Some superficial documentation changes Jonathan Nieder 2008-06-30 22:01 ` [PATCH 1/7] Documentation: fix links to tutorials and other new manual pages Jonathan Nieder 2008-06-30 23:30 ` Christian Couder 2008-06-30 22:05 ` [PATCH 2/7] whitespace fix in Documentation/git-repack.txt Jonathan Nieder 2008-06-30 22:10 ` [PATCH 3/7] Documentation: complicate example of "man git-command" Jonathan Nieder 2008-06-30 23:39 ` Christian Couder 2008-07-01 16:23 ` J. Bruce Fields 2008-07-01 23:54 ` Junio C Hamano 2008-07-02 21:31 ` J. Bruce Fields 2008-07-03 1:45 ` Jonathan Nieder 2008-07-03 18:18 ` J. Bruce Fields 2008-07-03 6:06 ` Christian Couder 2008-07-03 7:44 ` Junio C Hamano 2008-06-30 22:15 ` [PATCH 4/7] git-daemon(1): don't assume git-daemon is in /usr/bin Jonathan Nieder 2008-06-30 22:17 ` [PATCH 5/7] Documentation: prepare to be consistent about "git-" versus "git " Jonathan Nieder 2008-06-30 22:29 ` [PATCH 6/7] Documentation: " Jonathan Nieder 2008-06-30 22:36 ` [RFC/PATCH 7/7] Documentation formatting and cleanup Jonathan Nieder 2008-07-01 13:09 ` Olivier Marin 2008-07-01 21:34 ` Junio C Hamano 2008-07-03 2:09 ` Jonathan Nieder 2008-07-03 2:28 ` Jonathan Nieder 2008-07-01 8:42 ` [PATCH 0/7] Some superficial documentation changes Junio C Hamano 2008-07-03 4:31 ` Jonathan Nieder 2008-07-03 4:47 ` [PATCH 01/15] git-format-patch(1): fix stray \ in output Jonathan Nieder 2008-07-03 4:54 ` [PATCH 02/15] Documentation: fix gitlinks Jonathan Nieder 2008-07-03 5:03 ` [PATCH 03/15] manpages: fix bogus whitespace Jonathan Nieder 2008-07-03 23:55 ` Junio C Hamano 2008-07-04 1:14 ` Jonathan Nieder 2008-07-03 5:08 ` [PATCH 04/15] git(1): add comma Jonathan Nieder 2008-07-03 5:13 ` [PATCH 05/15] git-commit(1): depersonalize description Jonathan Nieder 2008-07-03 5:20 ` [PATCH 06/15] Documentation: rewrap to prepare for "git-" vs "git " change Jonathan Nieder 2008-07-03 5:28 ` [PATCH 07/15] Documentation: more "git-" versus "git " changes Jonathan Nieder 2008-07-03 5:30 ` [PATCH 08/15] gitdiffcore(7): fix awkward wording Jonathan Nieder 2008-07-03 5:36 ` [PATCH 09/15] manpages: italicize command names in synopses Jonathan Nieder 2008-07-03 5:37 ` [PATCH 10/15] manpages: italicize command names Jonathan Nieder 2008-07-03 5:45 ` [PATCH 11/15] manpages: italicize git command names (which were in teletype font) Jonathan Nieder 2008-07-03 5:49 ` [PATCH 12/15] manpages: italicize gitk's name (where it was " Jonathan Nieder 2008-07-03 5:55 ` [PATCH 13/15] manpages: italicize nongit command names (if they are " Jonathan Nieder 2008-07-03 5:59 ` [PATCH 14/15] manpages: italicize git subcommand names (which were " Jonathan Nieder 2008-07-03 6:06 ` [PATCH 15/15] manpages: use teletype font for sample command lines Jonathan Nieder
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.