* [PATCH 0/7] user-manual: general improvements @ 2009-04-04 9:38 Felipe Contreras 2009-04-04 9:38 ` [PATCH 1/7] user-manual: remove some git-foo usage Felipe Contreras 0 siblings, 1 reply; 18+ messages in thread From: Felipe Contreras @ 2009-04-04 9:38 UTC (permalink / raw) To: git; +Cc: Junio C Hamano, Felipe Contreras This patch series tries to improve different areas of the user-manual, including style and git configuration. For a quick preview check: http://people.freedesktop.org/~felipec/git/user-manual.html Some changes are non-controversial, like s/git-foo/git foo/ while the font style changes might be. There's one huge patch for quoting improvements, which requires the css style patch in order to look good. Also, a new section 'Getting started' was added, which currently only deals with git configuration. This allows other areas of the manual to be less verbose on 'git config'. Felipe Contreras (7): user-manual: remove some git-foo usage docbook: improve css style user-manual: general quoting improvements user-manual: use 'fast-forward' instead of 'fast forward' user-manual: use SHA-1 instead of SHA1 or sha1 user-manual: add global config section user-manual: simplify the user configuration Documentation/docbook-xsl.css | 14 +- Documentation/user-manual.txt | 1034 +++++++++++++++++++++-------------------- 2 files changed, 543 insertions(+), 505 deletions(-) ^ permalink raw reply [flat|nested] 18+ messages in thread
* [PATCH 1/7] user-manual: remove some git-foo usage 2009-04-04 9:38 [PATCH 0/7] user-manual: general improvements Felipe Contreras @ 2009-04-04 9:38 ` Felipe Contreras 2009-04-04 9:38 ` [PATCH 2/7] docbook: improve css style Felipe Contreras 0 siblings, 1 reply; 18+ messages in thread From: Felipe Contreras @ 2009-04-04 9:38 UTC (permalink / raw) To: git; +Cc: Junio C Hamano, Felipe Contreras Also, use `git foo` when it make sense. Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com> --- Documentation/user-manual.txt | 148 ++++++++++++++++++++-------------------- 1 files changed, 74 insertions(+), 74 deletions(-) diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index e33b29b..e1bc955 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -188,7 +188,7 @@ As you can see, a commit shows who made the latest change, what they did, and why. Every commit has a 40-hexdigit id, sometimes called the "object name" or the -"SHA1 id", shown on the first line of the "git-show" output. You can usually +"SHA1 id", shown on the first line of the "git show" output. You can usually refer to a commit by a shorter name, such as a tag or a branch name, but this longer name can also be useful. Most importantly, it is a globally unique name for this commit: so if you tell somebody else the object name (for @@ -307,7 +307,7 @@ ref: refs/heads/master Examining an old version without creating a new branch ------------------------------------------------------ -The git-checkout command normally expects a branch head, but will also +The `git checkout` command normally expects a branch head, but will also accept an arbitrary commit; for example, you can check out the commit referenced by a tag: @@ -400,7 +400,7 @@ references with the same shorthand name, see the "SPECIFYING REVISIONS" section of linkgit:git-rev-parse[1]. [[Updating-a-repository-With-git-fetch]] -Updating a repository with git-fetch +Updating a repository with git fetch ------------------------------------ Eventually the developer cloned from will do additional work in her @@ -427,7 +427,7 @@ $ git fetch linux-nfs ------------------------------------------------- New remote-tracking branches will be stored under the shorthand name -that you gave "git-remote add", in this case linux-nfs: +that you gave "git remote add", in this case linux-nfs: ------------------------------------------------- $ git branch -r @@ -516,7 +516,7 @@ $ git bisect reset to return you to the branch you were on before. -Note that the version which git-bisect checks out for you at each +Note that the version which `git bisect` checks out for you at each point is just a suggestion, and you're free to try a different version if you think it would be a good idea. For example, occasionally you may land on a commit that broke something unrelated; @@ -592,11 +592,11 @@ In addition to HEAD, there are several other special names for commits: Merges (to be discussed later), as well as operations such as -git-reset, which change the currently checked-out commit, generally +`git reset`, which change the currently checked-out commit, generally set ORIG_HEAD to the value HEAD had before the current operation. -The git-fetch operation always stores the head of the last fetched -branch in FETCH_HEAD. For example, if you run git fetch without +The `git fetch` operation always stores the head of the last fetched +branch in FETCH_HEAD. For example, if you run `git fetch` without specifying a local branch as the target of the operation ------------------------------------------------- @@ -1073,9 +1073,9 @@ $ git diff shows the difference between the working tree and the index file. -Note that "git-add" always adds just the current contents of a file +Note that "git add" always adds just the current contents of a file to the index; further changes to the same file will be ignored unless -you run git-add on the file again. +you run `git add` on the file again. When you're ready, just run @@ -1136,7 +1136,7 @@ Ignoring files A project will often generate files that you do 'not' want to track with git. This typically includes files generated by a build process or temporary backup files made by your editor. Of course, 'not' tracking files with git -is just a matter of 'not' calling `git-add` on them. But it quickly becomes +is just a matter of 'not' calling `git add` on them. But it quickly becomes annoying to have these untracked files lying around; e.g. they make `git add .` practically useless, and they keep showing up in the output of `git status`. @@ -1349,7 +1349,7 @@ $ git add file.txt ------------------------------------------------- the different stages of that file will be "collapsed", after which -git-diff will (by default) no longer show diffs for that file. +`git diff` will (by default) no longer show diffs for that file. [[undoing-a-merge]] Undoing a merge @@ -1446,7 +1446,7 @@ Fixing a mistake by rewriting history If the problematic commit is the most recent commit, and you have not yet made that commit public, then you may just -<<undoing-a-merge,destroy it using git-reset>>. +<<undoing-a-merge,destroy it using `git reset`>>. Alternatively, you can edit the working directory and update the index to fix your @@ -1474,7 +1474,7 @@ Checking out an old version of a file In the process of undoing a previous bad change, you may find it useful to check out an older version of a particular file using -linkgit:git-checkout[1]. We've used git-checkout before to switch +linkgit:git-checkout[1]. We've used `git checkout` before to switch branches, but it has quite different behavior if it is given a path name: the command @@ -1542,7 +1542,7 @@ $ git gc ------------------------------------------------- to recompress the archive. This can be very time-consuming, so -you may prefer to run git-gc when you are not doing other work. +you may prefer to run `git gc` when you are not doing other work. [[ensuring-reliability]] @@ -1634,7 +1634,7 @@ In some situations the reflog may not be able to save you. For example, suppose you delete a branch, then realize you need the history it contained. The reflog is also deleted; however, if you have not yet pruned the repository, then you may still be able to find the lost -commits in the dangling objects that git-fsck reports. See +commits in the dangling objects that `git fsck` reports. See <<dangling-objects>> for the details. ------------------------------------------------- @@ -1676,7 +1676,7 @@ Sharing development with others =============================== [[getting-updates-With-git-pull]] -Getting updates with git-pull +Getting updates with git pull ----------------------------- After you clone a repository and make a few changes of your own, you @@ -1722,7 +1722,7 @@ repository that you pulled from. <<fast-forwards,fast forward>>; instead, your branch will just be updated to point to the latest commit from the upstream branch.) -The git-pull command can also be given "." as the "remote" repository, +The `git pull` command can also be given "." as the "remote" repository, in which case it just merges in a branch from the current repository; so the commands @@ -1795,7 +1795,7 @@ Public git repositories Another way to submit changes to a project is to tell the maintainer of that project to pull the changes from your repository using linkgit:git-pull[1]. In the section "<<getting-updates-With-git-pull, -Getting updates with git-pull>>" we described this as a way to get +Getting updates with `git pull`>>" we described this as a way to get updates from the "main" repository, but it works just as well in the other direction. @@ -1847,7 +1847,7 @@ Setting up a public repository ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Assume your personal repository is in the directory ~/proj. We -first create a new clone of the repository and tell git-daemon that it +first create a new clone of the repository and tell `git daemon` that it is meant to be public: ------------------------------------------------- @@ -1878,10 +1878,10 @@ repository>>", below. Otherwise, all you need to do is start linkgit:git-daemon[1]; it will listen on port 9418. By default, it will allow access to any directory that looks like a git directory and contains the magic file -git-daemon-export-ok. Passing some directory paths as git-daemon +git-daemon-export-ok. Passing some directory paths as `git daemon` arguments will further restrict the exports to those paths. -You can also run git-daemon as an inetd service; see the +You can also run `git daemon` as an inetd service; see the linkgit:git-daemon[1] man page for details. (See especially the examples section.) @@ -1942,7 +1942,7 @@ or just $ git push ssh://yourserver.com/~you/proj.git master ------------------------------------------------- -As with git-fetch, git-push will complain if this does not result in a +As with `git fetch`, `git push` will complain if this does not result in a <<fast-forwards,fast forward>>; see the following section for details on handling this case. @@ -1952,7 +1952,7 @@ repository that has a checked-out working tree, but the working tree will not be updated by the push. This may lead to unexpected results if the branch you push to is the currently checked-out branch! -As with git-fetch, you may also set up configuration options to +As with `git fetch`, you may also set up configuration options to save typing; so, for example, after ------------------------------------------------- @@ -1988,13 +1988,13 @@ 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 +You may force `git push` to perform the update anyway by preceding the branch name with a plus sign: ------------------------------------------------- @@ -2036,7 +2036,7 @@ advantages over the central shared repository: - Git's ability to quickly import and merge patches allows a single maintainer to process incoming changes even at very - high rates. And when that becomes too much, git-pull provides + high rates. And when that becomes too much, `git pull` provides an easy way for that maintainer to delegate this job to other maintainers while still allowing optional review of incoming changes. @@ -2404,7 +2404,7 @@ use them, and then explain some of the problems that can arise because you are rewriting history. [[using-git-rebase]] -Keeping a patch series up to date using git-rebase +Keeping a patch series up to date using git rebase -------------------------------------------------- Suppose that you create a branch "mywork" on a remote-tracking branch @@ -2468,9 +2468,9 @@ 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 +running `git commit`, just run ------------------------------------------------- $ git rebase --continue @@ -2508,7 +2508,7 @@ with $ git tag bad mywork~5 ------------------------------------------------- -(Either gitk or git-log may be useful for finding the commit.) +(Either gitk or `git log` may be useful for finding the commit.) Then check out that commit, edit it, and rebase the rest of the series on top of it (note that we could check out the commit on a temporary @@ -2549,12 +2549,12 @@ $ gitk origin..mywork & and browse through the list of patches in the mywork branch using gitk, applying them (possibly in a different order) to mywork-new using -cherry-pick, and possibly modifying them as you go using `commit --amend`. +cherry-pick, and possibly modifying them as you go using `git commit --amend`. The linkgit:git-gui[1] command may also help as it allows you to individually select diff hunks for inclusion in the index (by right-clicking on the diff hunk and choosing "Stage Hunk for Commit"). -Another technique is to use git-format-patch to create a series of +Another technique is to use `git format-patch` to create a series of patches, then reset the state to before the patches: ------------------------------------------------- @@ -2662,7 +2662,7 @@ you know is that D is bad, that Z is good, and that linkgit:git-bisect[1] identifies C as the culprit, how will you figure out that the problem is due to this change in semantics? -When the result of a git-bisect is a non-merge commit, you should +When the result of a `git bisect` is a non-merge commit, you should normally be able to discover the problem by examining just that commit. Developers can make this easy by breaking their changes into small self-contained commits. That won't help in the case above, however, @@ -2725,7 +2725,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 @@ -2751,7 +2751,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 @@ -2760,7 +2760,7 @@ unless you've already created a reference of your own pointing to them. [[forcing-fetch]] -Forcing git-fetch to do non-fast-forward updates +Forcing git fetch to do non-fast-forward updates ------------------------------------------------ If git fetch fails because the new head of a branch is not a @@ -3131,7 +3131,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 @@ -3160,7 +3160,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 @@ -3210,7 +3210,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. @@ -3225,9 +3225,9 @@ and they'll be gone. But you should only run "git prune" on a quiescent repository--it's kind of like doing a filesystem fsck recovery: you don't want to do that while the filesystem is mounted. -(The same is true of "git-fsck" itself, btw, but since -git-fsck never actually *changes* the repository, it just reports -on what it found, git-fsck itself is never "dangerous" to run. +(The same is true of "git fsck" itself, btw, but since +`git fsck` never actually *changes* the repository, it just reports +on what it found, `git fsck` itself is never 'dangerous' to run. Running it while somebody is actually changing the repository can cause confusing and scary messages, but it won't actually do anything bad. In contrast, running "git prune" while somebody is actively changing the @@ -3489,14 +3489,14 @@ done NOTE: Do not use local URLs here if you plan to publish your superproject! -See what files `git-submodule` created: +See what files `git submodule` created: ------------------------------------------------- $ ls -a . .. .git .gitmodules a b c d ------------------------------------------------- -The `git-submodule add <repo> <path>` command does a couple of things: +The `git submodule add <repo> <path>` command does a couple of things: - It clones the submodule from <repo> to the given <path> under the current directory and by default checks out the master branch. @@ -3542,7 +3542,7 @@ init` to add the submodule repository URLs to `.git/config`: $ git submodule init ------------------------------------------------- -Now use `git-submodule update` to clone the repositories and check out the +Now use `git submodule update` to clone the repositories and check out the commits specified in the superproject: ------------------------------------------------- @@ -3552,8 +3552,8 @@ $ ls -a . .. .git a.txt ------------------------------------------------- -One major difference between `git-submodule update` and `git-submodule add` is -that `git-submodule update` checks out a specific commit, rather than the tip +One major difference between `git submodule update` and `git submodule add` is +that `git submodule update` checks out a specific commit, rather than the tip of a branch. It's like checking out a tag: the head is detached, so you're not working on a branch. @@ -3769,7 +3769,7 @@ You update your working directory from the index by "checking out" files. This is not a very common operation, since normally you'd just keep your files updated, and rather than write to your working directory, you'd tell the index files about the changes in your -working directory (i.e. `git-update-index`). +working directory (i.e. `git update-index`). However, if you decide to jump to a new version, or check out somebody else's version, or just restore a previous tree, you'd populate your @@ -3782,7 +3782,7 @@ $ git checkout-index filename or, if you want to check out all of the index, use `-a`. -NOTE! git-checkout-index normally refuses to overwrite old files, so +NOTE! `git checkout-index` normally refuses to overwrite old files, so if you have an old version of the tree already checked out, you will need to use the "-f" flag ('before' the "-a" flag or the filename) to 'force' the checkout. @@ -3820,7 +3820,7 @@ $ git commit-tree <tree> -p <parent> [-p <parent2> ..] and then giving the reason for the commit on stdin (either through redirection from a pipe or file, or by just typing it at the tty). -git-commit-tree will return the name of the object that represents +`git commit-tree` will return the name of the object that represents that commit, and you should save it away for later use. Normally, you'd commit a new `HEAD` state, and while git doesn't care where you save the note about that state, in practice we tend to just write the @@ -3889,7 +3889,7 @@ $ git cat-file blob|tree|commit|tag <objectname> to show its contents. NOTE! Trees have binary content, and as a result there is a special helper for showing that content, called -`git-ls-tree`, which turns the binary content into a more easily +`git ls-tree`, which turns the binary content into a more easily readable form. It's especially instructive to look at "commit" objects, since those @@ -3984,7 +3984,7 @@ came from: stage 1 corresponds to `$orig` tree, stage 2 `HEAD` tree, and stage3 `$target` tree. Earlier we said that trivial merges are done inside -`git-read-tree -m`. For example, if the file did not change +`git read-tree -m`. For example, if the file did not change from `$orig` to `HEAD` nor `$target`, or if the file changed from `$orig` to `HEAD` and `$orig` to `$target` the same way, obviously the final outcome is what is in `HEAD`. What the @@ -4011,20 +4011,20 @@ $ mv -f hello.c~2 hello.c $ git update-index hello.c ------------------------------------------------- -When a path is in the "unmerged" state, running `git-update-index` for +When a path is in the "unmerged" state, running `git update-index` for that path tells git to mark the path resolved. The above is the description of a git merge at the lowest level, to help you understand what conceptually happens under the hood. -In practice, nobody, not even git itself, runs `git-cat-file` three times -for this. There is a `git-merge-index` program that extracts the +In practice, nobody, not even git itself, runs `git cat-file` three times +for this. There is a `git merge-index` program that extracts the stages to temporary files and calls a "merge" script on it: ------------------------------------------------- $ git merge-index git-merge-one-file hello.c ------------------------------------------------- -and that is what higher level `git-merge -s resolve` is implemented with. +and that is what higher level `git merge -s resolve` is implemented with. [[hacking-git]] Hacking git @@ -4061,7 +4061,7 @@ size> {plus} <byte\0> {plus} <binary object data>. The structured objects can further have their structure and connectivity to other objects verified. This is generally done with -the `git-fsck` program, which generates a full dependency graph +the `git fsck` program, which generates a full dependency graph of all objects, and verifies their internal consistency (in addition to just verifying their superficial consistency through the hash). @@ -4120,7 +4120,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 "$@") | \ @@ -4129,20 +4129,20 @@ $ git-rev-list --pretty $(git-rev-parse --default HEAD "$@") | \ What does this mean? -`git-rev-list` is the original version of the revision walker, which +`git rev-list` is the original version of the revision walker, which _always_ printed a list of revisions to stdout. It is still functional, and needs to, since most new Git programs start out as scripts using -`git-rev-list`. +`git rev-list`. -`git-rev-parse` is not as important any more; it was only used to filter out +`git rev-parse` is not as important any more; it was only used to filter out options that were relevant for the different plumbing commands that were called by the script. -Most of what `git-rev-list` did is contained in `revision.c` and +Most of what `git rev-list` did is contained in `revision.c` and `revision.h`. It wraps the options in a struct named `rev_info`, which controls how and what revisions are walked, and more. -The original job of `git-rev-parse` is now taken by the function +The original job of `git rev-parse` is now taken by the function `setup_revisions()`, which parses the revisions and the common command line options for the revision walker. This information is stored in the struct `rev_info` for later consumption. You can do your own command line option @@ -4155,7 +4155,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`, @@ -4171,7 +4171,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. @@ -4182,9 +4182,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 @@ -4198,7 +4198,7 @@ it does. ------------------------------------------------------------------ git_config(git_default_config); if (argc != 3) - usage("git-cat-file [-t|-s|-e|-p|<type>] <sha1>"); + usage("git cat-file [-t|-s|-e|-p|<type>] <sha1>"); if (get_sha1(argv[2], sha1)) die("Not a valid object name %s", argv[2]); ------------------------------------------------------------------ @@ -4243,10 +4243,10 @@ To find out how the result can be used, just read on in `cmd_cat_file()`: ----------------------------------- Sometimes, you do not know where to look for a feature. In many such cases, -it helps to search through the output of `git log`, and then `git-show` the +it helps to search through the output of `git log`, and then `git show` the corresponding commit. -Example: If you know that there was some test case for `git-bundle`, but +Example: If you know that there was some test case for `git bundle`, but do not remember where it was (yes, you _could_ `git grep bundle t/`, but that does not illustrate the point!): @@ -4530,7 +4530,7 @@ The basic requirements: - Whenever possible, section headings should clearly describe the task they explain how to do, in language that requires no more knowledge than necessary: for example, "importing patches into a project" rather - than "the git-am command" + than "the `git am` command" Think about how to create a clear chapter dependency graph that will allow people to get to important topics without necessarily reading -- 1.6.2.2.404.ge96f3 ^ permalink raw reply related [flat|nested] 18+ messages in thread
* [PATCH 2/7] docbook: improve css style 2009-04-04 9:38 ` [PATCH 1/7] user-manual: remove some git-foo usage Felipe Contreras @ 2009-04-04 9:38 ` Felipe Contreras [not found] ` <1238837909-3060-4-git-send-email-felipe.contreras@gmail.com> 0 siblings, 1 reply; 18+ messages in thread From: Felipe Contreras @ 2009-04-04 9:38 UTC (permalink / raw) To: git; +Cc: Junio C Hamano, Felipe Contreras Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com> --- Documentation/docbook-xsl.css | 14 ++++++++++++-- 1 files changed, 12 insertions(+), 2 deletions(-) diff --git a/Documentation/docbook-xsl.css b/Documentation/docbook-xsl.css index b878b38..e11c8f0 100644 --- a/Documentation/docbook-xsl.css +++ b/Documentation/docbook-xsl.css @@ -16,6 +16,7 @@ body blockquote { html body { margin: 1em 5% 1em 5%; line-height: 1.2; + font-family: sans-serif; } body div { @@ -128,6 +129,15 @@ body pre { tt.literal, code.literal { color: navy; + font-family: sans-serif; +} + +code.literal:before { content: "'"; } +code.literal:after { content: "'"; } + +em { + font-style: italic; + color: #064; } div.literallayout p { @@ -137,7 +147,6 @@ div.literallayout p { div.literallayout { font-family: monospace; -# margin: 0.5em 10% 0.5em 1em; margin: 0em; color: navy; border: 1px solid silver; @@ -187,7 +196,8 @@ dt { } dt span.term { - font-style: italic; + font-style: normal; + color: navy; } div.variablelist dd p { -- 1.6.2.2.404.ge96f3 ^ permalink raw reply related [flat|nested] 18+ messages in thread
[parent not found: <1238837909-3060-4-git-send-email-felipe.contreras@gmail.com>]
* [PATCH 4/7] user-manual: use 'fast-forward' instead of 'fast forward' [not found] ` <1238837909-3060-4-git-send-email-felipe.contreras@gmail.com> @ 2009-04-04 9:38 ` Felipe Contreras 2009-04-04 9:38 ` [PATCH 5/7] user-manual: use SHA-1 instead of SHA1 or sha1 Felipe Contreras 2009-04-06 8:14 ` [PATCH 4/7] user-manual: use 'fast-forward' instead of 'fast forward' Junio C Hamano 0 siblings, 2 replies; 18+ messages in thread From: Felipe Contreras @ 2009-04-04 9:38 UTC (permalink / raw) To: git; +Cc: Junio C Hamano, Felipe Contreras Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com> --- Documentation/user-manual.txt | 14 +++++++------- 1 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 0d5726c..118bbe2 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1384,7 +1384,7 @@ were merged. However, if the current branch is a descendant of the other--so every commit present in the one is already contained in the other--then git -just performs a '``fast forward'''; the head of the current branch is moved +just performs a 'fast-forward'; the head of the current branch is moved forward to point at the head of the merged-in branch, without any new commits being created. @@ -1719,7 +1719,7 @@ producing a default commit message documenting the branch and repository that you pulled from. (But note that no such commit will be created in the case of a -<<fast-forwards,fast forward>>; instead, your branch will just be +<<fast-forwards,fast-forward>>; instead, your branch will just be updated to point to the latest commit from the upstream branch.) The `git pull` command can also be given '"."' as the 'remote' repository, @@ -1943,7 +1943,7 @@ $ git push ssh://yourserver.com/~you/proj.git master ------------------------------------------------- As with `git fetch`, `git push` will complain if this does not result in a -<<fast-forwards,fast forward>>; see the following section for details on +<<fast-forwards,fast-forward>>; see the following section for details on handling this case. Note that the target of a 'push' is normally a @@ -1976,7 +1976,7 @@ details. What to do when a push fails ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If a push would not result in a <<fast-forwards,fast forward>> of the +If a push would not result in a <<fast-forwards,fast-forward>> of the remote branch, then it will fail with an error like: ------------------------------------------------- @@ -2115,7 +2115,7 @@ $ git checkout release && git pull *Important note!* If you have any local changes in these branches, then this merge will create a commit object in the history (with no local -changes git will simply do a 'fast forward' merge). Many people dislike +changes git will simply do a 'fast-forward' merge). Many people dislike the ``noise'' that this creates in the Linux history, so you should avoid doing this capriciously in the 'release' branch, as these noisy commits will become part of the permanent history when you ask Linus to pull @@ -2729,9 +2729,9 @@ 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>>. +commit. Git calls this process a <<fast-forwards,fast-forward>>. -A 'fast forward' looks something like this: +A 'fast-forward' looks something like this: ................................................ o--o--o--o <-- old head of the branch -- 1.6.2.2.404.ge96f3 ^ permalink raw reply related [flat|nested] 18+ messages in thread
* [PATCH 5/7] user-manual: use SHA-1 instead of SHA1 or sha1 2009-04-04 9:38 ` [PATCH 4/7] user-manual: use 'fast-forward' instead of 'fast forward' Felipe Contreras @ 2009-04-04 9:38 ` Felipe Contreras 2009-04-04 9:38 ` [PATCH 6/7] user-manual: add global config section Felipe Contreras 2009-04-06 8:14 ` [PATCH 5/7] user-manual: use SHA-1 instead of SHA1 or sha1 Junio C Hamano 2009-04-06 8:14 ` [PATCH 4/7] user-manual: use 'fast-forward' instead of 'fast forward' Junio C Hamano 1 sibling, 2 replies; 18+ messages in thread From: Felipe Contreras @ 2009-04-04 9:38 UTC (permalink / raw) To: git; +Cc: Junio C Hamano, Felipe Contreras Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com> --- Documentation/user-manual.txt | 54 ++++++++++++++++++++-------------------- 1 files changed, 27 insertions(+), 27 deletions(-) diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 118bbe2..3278aa7 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -188,7 +188,7 @@ As you can see, a commit shows who made the latest change, what they did, and why. Every commit has a 40-hexdigit id, sometimes called the 'object name' or the -`SHA1` id, shown on the first line of the `git show` output. You can usually +`SHA-1` id, shown on the first line of the `git show` output. You can usually refer to a commit by a shorter name, such as a tag or a branch name, but this longer name can also be useful. Most importantly, it is a globally unique name for this commit: so if you tell somebody else the object name (for @@ -320,7 +320,7 @@ If you want to create a new branch from this checkout, you may do so HEAD is now at 427abfa... Linux v2.6.17 ------------------------------------------------ -The `HEAD` then refers to the `SHA1` of the commit instead of to a branch, +The `HEAD` then refers to the `SHA-1` of the commit instead of to a branch, and `git branch` shows that you are no longer on a branch: ------------------------------------------------ @@ -739,7 +739,7 @@ $ git log --pretty=oneline origin..mybranch | wc -l ------------------------------------------------- Alternatively, you may often see this sort of thing done with the -lower-level command linkgit:git-rev-list[1], which just lists the 'SHA1s' +lower-level command linkgit:git-rev-list[1], which just lists the `SHA-1s` of all the given commits: ------------------------------------------------- @@ -2865,8 +2865,8 @@ The Object Database We already saw in <<understanding-commits>> that all commits are stored under a 40-digit 'object name'. In fact, all the information needed to represent the history of a project is stored in objects with such names. -In each case the name is calculated by taking the `SHA1` hash of the -contents of the object. The `SHA1` hash is a cryptographic hash function. +In each case the name is calculated by taking the `SHA-1` hash of the +contents of the object. The `SHA-1` hash is a cryptographic hash function. What that means to us is that it is impossible to find two different objects with the same name. This has a number of advantages; among others: @@ -2877,10 +2877,10 @@ others: same content stored in two repositories will always be stored under the same name. - Git can detect errors when it reads an object, by checking that the - object's name is still the `SHA1` hash of its contents. + object's name is still the `SHA-1` hash of its contents. (See <<object-details>> for the details of the object formatting and -`SHA1` calculation.) +`SHA-1` calculation.) There are four different types of objects: 'blob', 'tree', 'commit', and 'tag'. @@ -2926,9 +2926,9 @@ committer Junio C Hamano <gitster@pobox.com> 1187591163 -0700 As you can see, a commit is defined by: -- a 'tree': The `SHA1` name of a tree object (as defined below), representing +- a 'tree': The `SHA-1` name of a tree object (as defined below), representing the contents of a directory at a certain point in time. -- 'parent(s)': The `SHA1` name of some number of commits which represent the +- 'parent(s)': The `SHA-1` name of some number of commits which represent the immediately previous step(s) in the history of the project. The example above has one parent; merge commits may have more than one. A commit with no parents is called a 'root' commit, and @@ -2977,13 +2977,13 @@ $ git ls-tree fb3a8bdd0ce ------------------------------------------------ As you can see, a tree object contains a list of entries, each with a -mode, object type, `SHA1` name, and name, sorted by name. It represents +mode, object type, `SHA-1` name, and name, sorted by name. It represents the contents of a single directory tree. The object type may be a blob, representing the contents of a file, or another tree, representing the contents of a subdirectory. Since trees -and blobs, like all other objects, are named by the `SHA1` hash of their -contents, two trees have the same `SHA1` name if and only if their +and blobs, like all other objects, are named by the `SHA-1` hash of their +contents, two trees have the same `SHA-1` name if and only if their contents (including, recursively, the contents of all subdirectories) are identical. This allows git to quickly determine the differences between two related tree objects, since it can ignore any entries with @@ -3029,15 +3029,15 @@ currently checked out. Trust ~~~~~ -If you receive the `SHA1` name of a blob from one source, and its contents +If you receive the `SHA-1` name of a blob from one source, and its contents from another (possibly untrusted) source, you can still trust that those -contents are correct as long as the SHA1 name agrees. This is because -the `SHA1` is designed so that it is infeasible to find different contents +contents are correct as long as the `SHA-1` name agrees. This is because +the `SHA-1` is designed so that it is infeasible to find different contents that produce the same hash. -Similarly, you need only trust the `SHA1` name of a top-level tree object +Similarly, you need only trust the `SHA-1` name of a top-level tree object to trust the contents of the entire directory that it refers to, and if -you receive the `SHA1` name of a commit from a trusted source, then you +you receive the `SHA-1` name of a commit from a trusted source, then you can easily verify the entire history of commits reachable through parents of that commit, and all of those contents of the trees referred to by those commits. @@ -3049,7 +3049,7 @@ that you trust that commit, and the immutability of the history of commits tells others that they can trust the whole history. In other words, you can easily validate a whole archive by just -sending out a single email that tells the people the name (`SHA1` hash) +sending out a single email that tells the people the name (`SHA-1` hash) of the top commit, and digitally sign that email using something like GPG/PGP. @@ -3090,7 +3090,7 @@ How git stores objects efficiently: pack files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Newly created objects are initially created in a file named after the -object's `SHA1` hash (stored in '.git/objects'). +object's `SHA-1` hash (stored in '.git/objects'). Unfortunately this system becomes inefficient once a project has a lot of objects. Try this on an old project: @@ -3297,7 +3297,7 @@ $ git hash-object -w somedirectory/myfile ------------------------------------------------ which will create and store a blob object with the contents of -'somedirectory/myfile', and output the sha1 of that object. if you're +'somedirectory/myfile', and output the `SHA-1` of that object. if you're extremely lucky it might be '4b9458b3786228369c63936db65827de3cc06200', in which case you've guessed right, and the corruption is fixed! @@ -3359,7 +3359,7 @@ The index ----------- The index is a binary file (generally kept in `.git/index'` containing a -sorted list of path names, each with permissions and the `SHA1` of a blob +sorted list of path names, each with permissions and the `SHA-1` of a blob object; linkgit:git-ls-files[1] can show you the contents of the index: ------------------------------------------------- @@ -3978,7 +3978,7 @@ $ git ls-files --unmerged ------------------------------------------------ Each line of the `git ls-files --unmerged` output begins with -the blob mode bits, blob `SHA1`, 'stage number', and the +the blob mode bits, blob `SHA-1`, 'stage number', and the filename. The 'stage number' is git's way to say which tree it came from: stage 1 corresponds to '$orig' tree, stage 2 'HEAD' tree, and stage3 '$target' tree. @@ -4045,12 +4045,12 @@ objects). There are currently four different object types: 'blob', Regardless of object type, all objects share the following characteristics: they are all deflated with zlib, and have a header that not only specifies their type, but also provides size information -about the data in the object. It's worth noting that the `SHA1` hash +about the data in the object. It's worth noting that the `SHA-1` hash that is used to name the object is the hash of the original data plus this header, so 'sha1sum file' does not match the object name for 'file'. (Historical note: in the dawn of the age of git the hash -was the sha1 of the 'compressed' object.) +was the `SHA-1` of the 'compressed' object.) As a result, the general consistency of an object can always be tested independently of the contents or the type of the object: all objects can @@ -4206,7 +4206,7 @@ it does. Let's skip over the obvious details; the only really interesting part here is the call to 'get_sha1()'. It tries to interpret 'argv[2]' as an object name, and if it refers to an object which is present in the current -repository, it writes the resulting SHA-1 into the variable 'sha1'. +repository, it writes the resulting `SHA-1` into the variable 'sha1'. Two things are interesting here: @@ -4216,8 +4216,8 @@ Two things are interesting here: - the variable 'sha1' in the function signature of 'get_sha1()' is '"unsigned char \*"', but is actually expected to be a pointer to '"unsigned - char[20]"'. This variable will contain the 160-bit SHA-1 of the given - commit. Note that whenever a SHA-1 is passed as '"unsigned char \*"', it + char[20]"'. This variable will contain the 160-bit `SHA-1` of the given + commit. Note that whenever a `SHA-1` is passed as '"unsigned char \*"', it is the binary representation, as opposed to the ASCII representation in hex characters, which is passed as '"char *"'. -- 1.6.2.2.404.ge96f3 ^ permalink raw reply related [flat|nested] 18+ messages in thread
* [PATCH 6/7] user-manual: add global config section 2009-04-04 9:38 ` [PATCH 5/7] user-manual: use SHA-1 instead of SHA1 or sha1 Felipe Contreras @ 2009-04-04 9:38 ` Felipe Contreras 2009-04-04 9:38 ` [PATCH 7/7] user-manual: simplify the user configuration Felipe Contreras 2009-04-05 9:47 ` [PATCH 6/7] user-manual: add global config section Junio C Hamano 2009-04-06 8:14 ` [PATCH 5/7] user-manual: use SHA-1 instead of SHA1 or sha1 Junio C Hamano 1 sibling, 2 replies; 18+ messages in thread From: Felipe Contreras @ 2009-04-04 9:38 UTC (permalink / raw) To: git; +Cc: Junio C Hamano, Felipe Contreras Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com> --- Documentation/user-manual.txt | 30 ++++++++++++++++++++++++++++++ 1 files changed, 30 insertions(+), 0 deletions(-) diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 3278aa7..a3032c7 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -40,6 +40,36 @@ without any explanation. Finally, see <<todo>> for ways that you can help make this manual more complete. +[[getting-started]] +Getting started +============= + +Git's configuration is distributed among different locations--this manual will +only to deal with 'global' and 'repository' variables, where 'repository' +variables take precedence over 'global' ones. + +You would probably want to start setting up something useful: +------------------------------------------------ +$ git config --global color.ui auto +------------------------------------------------ + +This will make prettier the output of certain commands such as `git diff`, but +that's not important; what is important here is that `color.ui` has been +stored in the 'global' (for the user) configuration. + +View and manually modify the configuration with the `--edit` +option (which will use '$EDITOR'): +------------------------------------------------ +$ git config --global --edit +[color] + ui = auto +------------------------------------------------ + +Or you can manually edit the file which is located in `~/.gitconfig`. Other +locations are `/etc/gitconfig` (system), and `.git/config` (repository). + +Other git configurations will be covered in the rest of the manual, if you +want to learn more look at linkgit:git-config[1] for details. [[repositories-and-branches]] Repositories and Branches -- 1.6.2.2.404.ge96f3 ^ permalink raw reply related [flat|nested] 18+ messages in thread
* [PATCH 7/7] user-manual: simplify the user configuration 2009-04-04 9:38 ` [PATCH 6/7] user-manual: add global config section Felipe Contreras @ 2009-04-04 9:38 ` Felipe Contreras 2009-04-05 3:36 ` Jay Soffian 2009-04-05 9:47 ` [PATCH 6/7] user-manual: add global config section Junio C Hamano 1 sibling, 1 reply; 18+ messages in thread From: Felipe Contreras @ 2009-04-04 9:38 UTC (permalink / raw) To: git; +Cc: Junio C Hamano, Felipe Contreras This is shorter, avoids the burder to think about the format of the configuration file, and git config is already used in other places in the manual. Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com> --- Documentation/user-manual.txt | 8 +++----- 1 files changed, 3 insertions(+), 5 deletions(-) diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index a3032c7..36568e5 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1011,13 +1011,11 @@ Telling git your name --------------------- Before creating any commits, you should introduce yourself to git. The -easiest way to do so is to make sure the following lines appear in a -file named `.gitconfig` in your home directory: +easiest way is to use the linkgit:git-config[1] command: ------------------------------------------------ -[user] - name = Your Name Comes Here - email = you@yourdomain.example.com +$ git config --global user.name "Your Name Comes Here" +$ git config --global user.email you@yourdomain.example.com ------------------------------------------------ (See the '"CONFIGURATION FILE"' section of linkgit:git-config[1] for -- 1.6.2.2.404.ge96f3 ^ permalink raw reply related [flat|nested] 18+ messages in thread
* Re: [PATCH 7/7] user-manual: simplify the user configuration 2009-04-04 9:38 ` [PATCH 7/7] user-manual: simplify the user configuration Felipe Contreras @ 2009-04-05 3:36 ` Jay Soffian 2009-04-05 9:14 ` Felipe Contreras 0 siblings, 1 reply; 18+ messages in thread From: Jay Soffian @ 2009-04-05 3:36 UTC (permalink / raw) To: Felipe Contreras; +Cc: git, Junio C Hamano On Sat, Apr 4, 2009 at 5:38 AM, Felipe Contreras <felipe.contreras@gmail.com> wrote: > This is shorter, avoids the burder to think about the format of the > configuration file, and git config is already used in other places in > the manual. > [...] > ------------------------------------------------ > -[user] > - name = Your Name Comes Here > - email = you@yourdomain.example.com > +$ git config --global user.name "Your Name Comes Here" > +$ git config --global user.email you@yourdomain.example.com > ------------------------------------------------ This has come up before, and the idea was to hint to the reader that .gitconfig is something they can edit themselves. j. ^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH 7/7] user-manual: simplify the user configuration 2009-04-05 3:36 ` Jay Soffian @ 2009-04-05 9:14 ` Felipe Contreras 2009-04-05 15:11 ` Jay Soffian 0 siblings, 1 reply; 18+ messages in thread From: Felipe Contreras @ 2009-04-05 9:14 UTC (permalink / raw) To: Jay Soffian; +Cc: git, Junio C Hamano On Sun, Apr 5, 2009 at 6:36 AM, Jay Soffian <jaysoffian@gmail.com> wrote: > On Sat, Apr 4, 2009 at 5:38 AM, Felipe Contreras > <felipe.contreras@gmail.com> wrote: >> This is shorter, avoids the burder to think about the format of the >> configuration file, and git config is already used in other places in >> the manual. >> [...] >> ------------------------------------------------ >> -[user] >> - name = Your Name Comes Here >> - email = you@yourdomain.example.com >> +$ git config --global user.name "Your Name Comes Here" >> +$ git config --global user.email you@yourdomain.example.com >> ------------------------------------------------ > > This has come up before, and the idea was to hint to the reader that > .gitconfig is something they can edit themselves. Ok, I forgot to explain this again the commit message of this particular patch, but it's described in the patch series description. The previous patch adds a 'Getting Started' section that explains exactly that; you can edit ~/.gitconfig. So that concern is already addressed. -- Felipe Contreras ^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH 7/7] user-manual: simplify the user configuration 2009-04-05 9:14 ` Felipe Contreras @ 2009-04-05 15:11 ` Jay Soffian 0 siblings, 0 replies; 18+ messages in thread From: Jay Soffian @ 2009-04-05 15:11 UTC (permalink / raw) To: Felipe Contreras; +Cc: git, Junio C Hamano On Sun, Apr 5, 2009 at 5:14 AM, Felipe Contreras <felipe.contreras@gmail.com> wrote: => Ok, I forgot to explain this again the commit message of this > particular patch, but it's described in the patch series description. > > The previous patch adds a 'Getting Started' section that explains > exactly that; you can edit ~/.gitconfig. > > So that concern is already addressed. Doh, sorry. Thanks for the explanation. j. ^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH 6/7] user-manual: add global config section 2009-04-04 9:38 ` [PATCH 6/7] user-manual: add global config section Felipe Contreras 2009-04-04 9:38 ` [PATCH 7/7] user-manual: simplify the user configuration Felipe Contreras @ 2009-04-05 9:47 ` Junio C Hamano 2009-05-01 8:37 ` Felipe Contreras 1 sibling, 1 reply; 18+ messages in thread From: Junio C Hamano @ 2009-04-05 9:47 UTC (permalink / raw) To: Felipe Contreras; +Cc: git Felipe Contreras <felipe.contreras@gmail.com> writes: > Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com> > --- > Documentation/user-manual.txt | 30 ++++++++++++++++++++++++++++++ > 1 files changed, 30 insertions(+), 0 deletions(-) > > diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt > index 3278aa7..a3032c7 100644 > --- a/Documentation/user-manual.txt > +++ b/Documentation/user-manual.txt > @@ -40,6 +40,36 @@ without any explanation. > Finally, see <<todo>> for ways that you can help make this manual more > complete. I think a "getting started" section near the beginning of the manual is a good idea (and ll.40- is a very early part of the manual). For that "introductory" purpose, however, I'd suggest showing how they appear in the actual .git/config file first in the editor and then show a way to use the "git config" command as an alternative. > +[[getting-started]] > +Getting started > +============= > + > +Git's configuration is distributed among different locations--this manual will > +only to deal with 'global' and 'repository' variables, where 'repository' > +variables take precedence over 'global' ones. > + > +You would probably want to start setting up something useful: > +------------------------------------------------ > +$ git config --global color.ui auto > +------------------------------------------------ > + > +This will make prettier the output of certain commands such as `git diff`, but > +that's not important; what is important here is that `color.ui` has been > +stored in the 'global' (for the user) configuration. "(for the user)" in parentheses here is better than not saying it anywhere, but I think you should have it in the first paragraph where you explain there are (at least) two kinds, global vs repository, in order to clarify what you mean by 'global' is not "system/site wide" but "in any repository I use" upfront. > +View and manually modify the configuration with the `--edit` > +option (which will use '$EDITOR'): > +------------------------------------------------ > +$ git config --global --edit > +[color] > + ui = auto > +------------------------------------------------ Copies of user manual are found quite easily (and bookmarked by many people) on the web, and are looked at by people with not-so-bleeding-edge version of git, so I'd rather not to give them "config --edit" this early in the documentation. Perhaps after at least 6 months (preferrably a year) after a release that has the new option, we can start encouraging it, but not before. So I'd suggest replacing 'with the --edit ...' with '$HOME/.gitconfig with your favorite editor' or something like that for now. > +Or you can manually edit the file which is located in `~/.gitconfig`. Other > +locations are `/etc/gitconfig` (system), and `.git/config` (repository). IOW, have this (without "Or") at the very beginning, and then as an alternative give "git config color.ui auto". Thanks. ^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH 6/7] user-manual: add global config section 2009-04-05 9:47 ` [PATCH 6/7] user-manual: add global config section Junio C Hamano @ 2009-05-01 8:37 ` Felipe Contreras 2009-05-01 22:08 ` Junio C Hamano 0 siblings, 1 reply; 18+ messages in thread From: Felipe Contreras @ 2009-05-01 8:37 UTC (permalink / raw) To: Junio C Hamano; +Cc: git On Sun, Apr 5, 2009 at 12:47 PM, Junio C Hamano <gitster@pobox.com> wrote: > Felipe Contreras <felipe.contreras@gmail.com> writes: > >> Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com> >> --- >> Documentation/user-manual.txt | 30 ++++++++++++++++++++++++++++++ >> 1 files changed, 30 insertions(+), 0 deletions(-) >> >> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt >> index 3278aa7..a3032c7 100644 >> --- a/Documentation/user-manual.txt >> +++ b/Documentation/user-manual.txt >> @@ -40,6 +40,36 @@ without any explanation. >> Finally, see <<todo>> for ways that you can help make this manual more >> complete. > > I think a "getting started" section near the beginning of the manual is a > good idea (and ll.40- is a very early part of the manual). > > For that "introductory" purpose, however, I'd suggest showing how they > appear in the actual .git/config file first in the editor and then show a > way to use the "git config" command as an alternative. I disagree. Opening ~/.gitconfig will just open an empty file for the new users, afterwards they'll just scratch their heads wondering, now what? If you first teach them to do 'git config --global color.ui auto' they'll blindly enter the command but then when they open the file they'll say "ahhh, so that's what happens". >> +[[getting-started]] >> +Getting started >> +============= >> + >> +Git's configuration is distributed among different locations--this manual will >> +only to deal with 'global' and 'repository' variables, where 'repository' >> +variables take precedence over 'global' ones. >> + >> +You would probably want to start setting up something useful: >> +------------------------------------------------ >> +$ git config --global color.ui auto >> +------------------------------------------------ >> + >> +This will make prettier the output of certain commands such as `git diff`, but >> +that's not important; what is important here is that `color.ui` has been >> +stored in the 'global' (for the user) configuration. > > "(for the user)" in parentheses here is better than not saying it > anywhere, but I think you should have it in the first paragraph where you > explain there are (at least) two kinds, global vs repository, in order to > clarify what you mean by 'global' is not "system/site wide" but "in any > repository I use" upfront. Ok. >> +View and manually modify the configuration with the `--edit` >> +option (which will use '$EDITOR'): >> +------------------------------------------------ >> +$ git config --global --edit >> +[color] >> + ui = auto >> +------------------------------------------------ > > Copies of user manual are found quite easily (and bookmarked by many > people) on the web, and are looked at by people with not-so-bleeding-edge > version of git, so I'd rather not to give them "config --edit" this early > in the documentation. Perhaps after at least 6 months (preferrably a > year) after a release that has the new option, we can start encouraging > it, but not before. So I'd suggest replacing 'with the --edit ...' with > '$HOME/.gitconfig with your favorite editor' or something like that for > now. Good point. >> +Or you can manually edit the file which is located in `~/.gitconfig`. Other >> +locations are `/etc/gitconfig` (system), and `.git/config` (repository). > > IOW, have this (without "Or") at the very beginning, and then as an > alternative give "git config color.ui auto". Read my first comment. I'll send another round of patches. -- Felipe Contreras ^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH 6/7] user-manual: add global config section 2009-05-01 8:37 ` Felipe Contreras @ 2009-05-01 22:08 ` Junio C Hamano 2009-05-01 22:51 ` Felipe Contreras 0 siblings, 1 reply; 18+ messages in thread From: Junio C Hamano @ 2009-05-01 22:08 UTC (permalink / raw) To: Felipe Contreras; +Cc: git Felipe Contreras <felipe.contreras@gmail.com> writes: >> For that "introductory" purpose, however, I'd suggest showing how they >> appear in the actual .git/config file first in the editor and then show a >> way to use the "git config" command as an alternative. > > I disagree. Opening ~/.gitconfig will just open an empty file for the > new users, afterwards they'll just scratch their heads wondering, now > what? Why on earth would anybody start introducing ~/.gitconfig before talking about .git/config? A good sequence would be: To start working on a tarball extract (or your uncontrolled project) with git, first do: $ git init Whoa. That was fast. Did it do anything? Yes, it created a subdirectory .git that is going to store your history and other control information. Right now you do not have any history (nor the current state for that matter) recorded in it, but it already has some control information. One of the more important one is the per-repository configuration file. Take a look: $ git config --edit It would show something like: [core] ... ... explain a bit on how simple the configuration syntax is ... While you have it open, it would be a good idea to add this to introduce yourself to git: [user] email = clueful@git.us.er name = My Self If you work in multiple projects under the same identity, you do not have to add user.email and user.name to each and every repository this way. Instead, you can do that to your per-user configuration file, like: $ git config --global --edit but if you work in different projects using different mail address (e.g. work vs hobby projects), you would want to have this information per-repository. ^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH 6/7] user-manual: add global config section 2009-05-01 22:08 ` Junio C Hamano @ 2009-05-01 22:51 ` Felipe Contreras 2009-05-02 0:16 ` Junio C Hamano 0 siblings, 1 reply; 18+ messages in thread From: Felipe Contreras @ 2009-05-01 22:51 UTC (permalink / raw) To: Junio C Hamano; +Cc: git On Sat, May 2, 2009 at 1:08 AM, Junio C Hamano <gitster@pobox.com> wrote: > Felipe Contreras <felipe.contreras@gmail.com> writes: > >>> For that "introductory" purpose, however, I'd suggest showing how they >>> appear in the actual .git/config file first in the editor and then show a >>> way to use the "git config" command as an alternative. >> >> I disagree. Opening ~/.gitconfig will just open an empty file for the >> new users, afterwards they'll just scratch their heads wondering, now >> what? > > Why on earth would anybody start introducing ~/.gitconfig before talking > about .git/config? In most people's minds 'configuring git' means a global configuration. The first configuration most people do is to configure their e-mail, doing it for only one repository is not useful at all. > A good sequence would be: > > To start working on a tarball extract (or your uncontrolled > project) with git, first do: > > $ git init > > Whoa. That was fast. Did it do anything? Yes, it created a > subdirectory .git that is going to store your history and other > control information. Right now you do not have any history (nor > the current state for that matter) recorded in it, but it already > has some control information. One of the more important one is > the per-repository configuration file. Take a look: Most people don't start with 'git init' they start with 'git clone' > $ git config --edit > > It would show something like: > > [core] > ... > > ... explain a bit on how simple the configuration syntax is ... > > While you have it open, it would be a good idea to add this to > introduce yourself to git: > > [user] > email = clueful@git.us.er > name = My Self > > If you work in multiple projects under the same identity, you > do not have to add user.email and user.name to each and every > repository this way. Instead, you can do that to your per-user > configuration file, like: > > $ git config --global --edit > > but if you work in different projects using different mail address > (e.g. work vs hobby projects), you would want to have this > information per-repository. All that is already explained in detail, if people want a short-cut this fits better: Before making any commits, configure your user: $ git config --global user.name "Simisani Takobana" $ git config --global user.email simisani@gmail.com This is what most guides use: gnome: http://live.gnome.org/Git/Developers sourceforge: http://apps.sourceforge.net/trac/sourceforge/wiki/Git github: http://github.com/guides/tell-git-your-user-name-and-email-address/6 sourcemage: http://www.sourcemage.org/Git_Guide archlinux: http://wiki.archlinux.org/index.php/Super_Quick_Git_Guide amarok: http://amarok.kde.org/wiki/Development/Git I could continue. The reason why they use 'git config --global' is because introductions must be quick so that the user can do something useful as fast as possible. Many people are not patient enough and even when the guide is simple and fast people still send patches with wrongly configured email addresses. This is a more usual (and pleasant) introduction to git: $ git config --global user.name "Foo Bar" $ git config --global user.email foo.bar@gmail.com $ git clone git://git.gnome.org/foo make changes $ git commit -a $ git format-patch origin/master There, the user has achieved something useful. Hopefully at that point the user will say: Hey, that was easy, I wonder why people complain about git not being user-friendly. Let's read a bit more about what I just did. -- Felipe Contreras ^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH 6/7] user-manual: add global config section 2009-05-01 22:51 ` Felipe Contreras @ 2009-05-02 0:16 ` Junio C Hamano 0 siblings, 0 replies; 18+ messages in thread From: Junio C Hamano @ 2009-05-02 0:16 UTC (permalink / raw) To: Felipe Contreras; +Cc: git Felipe Contreras <felipe.contreras@gmail.com> writes: >> A good sequence would be: >> >> To start working on a tarball extract (or your uncontrolled >> project) with git, first do: >> >> $ git init >> >> Whoa. That was fast. Did it do anything? Yes, it created a >> subdirectory .git that is going to store your history and other >> control information. Right now you do not have any history (nor >> the current state for that matter) recorded in it, but it already >> has some control information. One of the more important one is >> the per-repository configuration file. Take a look: > ... > Most people don't start with 'git init' they start with 'git clone' That does not just not change the issue but even strengthens my point. After clone, you have a working per-repository .git/config file that is a good demonstration of how easy and simple the syntax is. You of course need to adjust the prose to guide the user to the configuration file if you use clone instead of init, but that goes without saying. By the way, I think you lacked 1/4 in your last round and this time it is missing too. [ 17: Felipe Contreras ] [PATCH v2 0/4] user-manual: general impro [ 74: Felipe Contreras ] [PATCH v2 2/4] user-manual: use 'fast-for [ 51: Felipe Contreras ] [PATCH v2 3/4] user-manual: add global c [ 38: Felipe Contreras ] [PATCH v2 4/4] user-manual: simplify th The description in 0/4 makes it sound like 1/4 is a general clean-up improvement, and so is 2/4. Can we apply these two first (and we obviously need to find that missing 1/4 --- is there some git-send-email bug hiding or something)? The two patches 3/4 and 4/4 are not "general" improvement; it is to advocate the use of "git config" more instead of showing the file in the editor, and while you obviously think it is an improvement, I do not think there is a "general" consensus that it is an improvement. More importantly, I do not think that is integral part of the "general clean-up", and by making it a separate topic, we can shrink the size of the patches in flight. ^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH 5/7] user-manual: use SHA-1 instead of SHA1 or sha1 2009-04-04 9:38 ` [PATCH 5/7] user-manual: use SHA-1 instead of SHA1 or sha1 Felipe Contreras 2009-04-04 9:38 ` [PATCH 6/7] user-manual: add global config section Felipe Contreras @ 2009-04-06 8:14 ` Junio C Hamano 2009-05-01 8:26 ` Felipe Contreras 1 sibling, 1 reply; 18+ messages in thread From: Junio C Hamano @ 2009-04-06 8:14 UTC (permalink / raw) To: Felipe Contreras; +Cc: git Thanks. This also seems to depend on the missing 3/7 but I've managed. I retitled it to "user-manual: the name of the hash function is SHA-1, not sha1". ^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH 5/7] user-manual: use SHA-1 instead of SHA1 or sha1 2009-04-06 8:14 ` [PATCH 5/7] user-manual: use SHA-1 instead of SHA1 or sha1 Junio C Hamano @ 2009-05-01 8:26 ` Felipe Contreras 0 siblings, 0 replies; 18+ messages in thread From: Felipe Contreras @ 2009-05-01 8:26 UTC (permalink / raw) To: Junio C Hamano; +Cc: git On Mon, Apr 6, 2009 at 11:14 AM, Junio C Hamano <gitster@pobox.com> wrote: > Thanks. > > This also seems to depend on the missing 3/7 but I've managed. I retitled > it to "user-manual: the name of the hash function is SHA-1, not sha1". You missed one in the Trust section. I'll send a patch. -- Felipe Contreras ^ permalink raw reply [flat|nested] 18+ messages in thread
* Re: [PATCH 4/7] user-manual: use 'fast-forward' instead of 'fast forward' 2009-04-04 9:38 ` [PATCH 4/7] user-manual: use 'fast-forward' instead of 'fast forward' Felipe Contreras 2009-04-04 9:38 ` [PATCH 5/7] user-manual: use SHA-1 instead of SHA1 or sha1 Felipe Contreras @ 2009-04-06 8:14 ` Junio C Hamano 1 sibling, 0 replies; 18+ messages in thread From: Junio C Hamano @ 2009-04-06 8:14 UTC (permalink / raw) To: Felipe Contreras; +Cc: git As there isn't 3/7 and this seems to depend on it, I'm dropping this, for now, but is this an improvement, or is it a "many places already use fast-forward and this patch is bringing consistency to the remainder" patch? ^ permalink raw reply [flat|nested] 18+ messages in thread
end of thread, other threads:[~2009-05-02 0:16 UTC | newest]
Thread overview: 18+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2009-04-04 9:38 [PATCH 0/7] user-manual: general improvements Felipe Contreras
2009-04-04 9:38 ` [PATCH 1/7] user-manual: remove some git-foo usage Felipe Contreras
2009-04-04 9:38 ` [PATCH 2/7] docbook: improve css style Felipe Contreras
[not found] ` <1238837909-3060-4-git-send-email-felipe.contreras@gmail.com>
2009-04-04 9:38 ` [PATCH 4/7] user-manual: use 'fast-forward' instead of 'fast forward' Felipe Contreras
2009-04-04 9:38 ` [PATCH 5/7] user-manual: use SHA-1 instead of SHA1 or sha1 Felipe Contreras
2009-04-04 9:38 ` [PATCH 6/7] user-manual: add global config section Felipe Contreras
2009-04-04 9:38 ` [PATCH 7/7] user-manual: simplify the user configuration Felipe Contreras
2009-04-05 3:36 ` Jay Soffian
2009-04-05 9:14 ` Felipe Contreras
2009-04-05 15:11 ` Jay Soffian
2009-04-05 9:47 ` [PATCH 6/7] user-manual: add global config section Junio C Hamano
2009-05-01 8:37 ` Felipe Contreras
2009-05-01 22:08 ` Junio C Hamano
2009-05-01 22:51 ` Felipe Contreras
2009-05-02 0:16 ` Junio C Hamano
2009-04-06 8:14 ` [PATCH 5/7] user-manual: use SHA-1 instead of SHA1 or sha1 Junio C Hamano
2009-05-01 8:26 ` Felipe Contreras
2009-04-06 8:14 ` [PATCH 4/7] user-manual: use 'fast-forward' instead of 'fast forward' Junio C Hamano
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.