summaryrefslogtreecommitdiff
path: root/Documentation/user-manual.txt
AgeCommit message (Collapse)AuthorFilesLines
2014-05-28Documentation: wording fixes in the user manual and glossaryLibravatar Jeremiah Mahler1-8/+7
Re-word the section on "Updating a repository with git fetch" in the user manual. Various other minor fixes in the manual and glossary. Signed-off-by: Jeremiah Mahler <jmmahler@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-03-31Documentation: fix misuses of "nor"Libravatar Justin Lebar1-1/+1
Signed-off-by: Justin Lebar <jlebar@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-02-07Merge branch 'ow/manpages-typofix'Libravatar Junio C Hamano1-1/+1
Various typofixes, all looked correct. * ow/manpages-typofix: Documentation: fix typos in man pages
2014-02-05Documentation: fix typos in man pagesLibravatar Øystein Walle1-1/+1
Signed-off-by: Øystein Walle <oystwa@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-01-06user-manual: improve html and pdf formattingLibravatar Thomas Ackermann1-1/+1
Use asciidoc style 'article' instead of 'book' and change asciidoc title level. This removes blank first page and superfluous "Part I" page (there is no "Part II") in pdf output. Also pdf size is decreased by this from 77 to 67 pages. In html output this removes unnecessary sub-tocs and chapter numbering. Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-09-17Merge branch 'ss/doclinks'Libravatar Junio C Hamano1-2/+2
When we converted many documents that were traditionally text-only to be formatted to AsciiDoc, we did not update links that point at them to refer to the formatted HTML files. * ss/doclinks: Documentation: make AsciiDoc links always point to HTML files
2013-09-06Documentation: make AsciiDoc links always point to HTML filesLibravatar Sebastian Schuberth1-2/+2
AsciiDoc's "link" is supposed to create hyperlinks for HTML output, so prefer a "link" to point to an HTML file instead of a text file if an HTML version of the file is being generated. For RelNotes, keep pointing to text files as no equivalent HTML files are generated. If appropriate, also update the link description to not contain the linked file's extension. Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-08-27"git prune" is safeLibravatar Thomas Ackermann1-9/+3
"git prune" is safe in case of concurrent accesses to a repository but using it in such a case is not recommended. Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-08-27Remove irrelevant reference from "Tying it all together"Libravatar Thomas Ackermann1-2/+1
Sorry Jon, but this might not be of any help to new Git users ;) Acked-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-08-27Remove unnecessary historical note from "Object storage format"Libravatar Thomas Ackermann1-2/+0
Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-08-27Improve section "Merging multiple trees"Libravatar Thomas Ackermann1-14/+13
Remove unnecessary quoting. Simplify description of three-way merge. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-08-27Improve section "Manipulating branches"Libravatar Thomas Ackermann1-12/+8
Add some missing punctuation. Simplify description of "git branch -d/-D". Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-08-27Simplify "How to make a commit"Libravatar Thomas Ackermann1-8/+2
Combine the two cases for "git add" into one. Add verb "use" to "git rm" case. Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-08-27Fix some typos and improve wordingLibravatar Thomas Ackermann1-10/+10
Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-08-27Use "git merge" instead of "git pull ."Libravatar Thomas Ackermann1-4/+4
"git pull ." works, but "git merge" is the recommended way for new users to do things. (The old description also should have read "The former is actually *not* very commonly used".) Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-08-27Use current output for "git repack"Libravatar Thomas Ackermann1-9/+7
Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-08-27Use current "detached HEAD" messageLibravatar Thomas Ackermann1-6/+13
Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-08-27Call it "Git User Manual" and remove reference to very old Git versionLibravatar Thomas Ackermann1-3/+2
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-07-22Sync with Git 1.8.3.4Libravatar Junio C Hamano1-2/+2
2013-07-22update URL to the marc.info mail archiveLibravatar Ondřej Bílka1-2/+2
The name marc.theaimsgroup.com is no longer active, and has migrated to marc.info. Signed-off-by: Ondřej Bílka <neleai@seznam.cz> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-07-21Merge branch 'ph/builtin-srcs-are-in-subdir-these-days' into maintLibravatar Junio C Hamano1-6/+7
* ph/builtin-srcs-are-in-subdir-these-days: fix "builtin-*" references to be "builtin/*"
2013-07-01Merge branch 'kb/am-deprecate-resolved'Libravatar Junio C Hamano1-1/+1
Promote "git am --continue" over "git am --resolved" for UI consistency. * kb/am-deprecate-resolved: am: replace uses of --resolved with --continue
2013-07-01Merge branch 'wk/doc-in-linux-3.x-era'Libravatar Junio C Hamano1-14/+20
Update documentation to match more recent realities. * wk/doc-in-linux-3.x-era: Documentation: Update 'linux-2.6.git' -> 'linux.git' Documentation: Update the NFS remote examples to use the staging repo doc/clone: Pick more compelling paths for the --reference example doc/clone: Remove the '--bare -l -s' example
2013-06-27am: replace uses of --resolved with --continueLibravatar Kevin Bracey1-1/+1
git am was previously modified to provide --continue for consistency with rebase, merge etc, and the documentation changed to showing --continue as the primary form. Complete the work by replacing remaining uses of --resolved by --continue, most notably in suggested command reminders. Signed-off-by: Kevin Bracey <kevin@bracey.fi> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-06-26Merge branch 'wk/doc-git-has-grown'Libravatar Junio C Hamano1-3/+3
* wk/doc-git-has-grown: user-manual: Update download size for Git and the kernel
2013-06-26Merge branch 'ph/builtin-srcs-are-in-subdir-these-days'Libravatar Junio C Hamano1-6/+7
* ph/builtin-srcs-are-in-subdir-these-days: fix "builtin-*" references to be "builtin/*"
2013-06-23user-manual: Update download size for Git and the kernelLibravatar W. Trevor King1-3/+3
They've grown since d19fbc3 (Documentation: add git user's manual, 2007-01-07) when the stats were initially added. I've rounded download sizes up to the nearest multiple of ten MiB to decrease the precision and give a bit of growing room. Exact sizes: $ git clone git://git.kernel.org/pub/scm/git/git.git Initialized empty Git repository in /tmp/git/.git/ remote: Counting objects: 156872, done. remote: Compressing objects: 100% (40826/40826), done. remote: Total 156872 (delta 115322), reused 155492 (delta 114094) Receiving objects: 100% (156872/156872), 37.29 MiB | 7.54 MiB/s, done. Resolving deltas: 100% (115322/115322), done. $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git Initialized empty Git repository in /tmp/linux/.git/ remote: Counting objects: 3057404, done. remote: Compressing objects: 100% (474769/474769), done. Receiving objects: 100% (3057404/3057404), 634.33 MiB | 27.95 MiB/s, done. remote: Total 3057404 (delta 2570385), reused 3040910 (delta 2554408) Resolving deltas: 100% (2570385/2570385), done. Checking out files: 100% (43012/43012), done. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-06-22Documentation: Update 'linux-2.6.git' -> 'linux.git'Libravatar W. Trevor King1-4/+4
The 3.x tree has been out for a while now. The -2.6 repository name survived the initial release [1], but kernel.org now only lists 'linux.git' (for aegl as well as torvalds) [2]. [1]: http://article.gmane.org/gmane.linux.kernel/1147422 On 2011-05-30 01:47:57 GMT, Linus Torvalds wrote: > ... yes, that means that my git tree is still called > "linux-2.6.git" on kernel.org. [2]: http://git.kernel.org/cgit/ Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-06-22Documentation: Update the NFS remote examples to use the staging repoLibravatar W. Trevor King1-10/+16
linux-nfs.org seems to have restructured their repository layout since 8391c60 (git-remote.txt: fix example url, 2007-11-02), and Bruce's repo is now at git://git.linux-nfs.org/projects/bfields/linux.git. Bruce also has a more richer internal branch structure (master, everything, for-3.1, ...), so updating the existing example to use his current repo may be confusing. To simplify, I've replaced the NFS repo with Greg's staging repo. I've also updated the output of the surrounding commands to match the output of a current run through. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-06-18fix "builtin-*" references to be "builtin/*"Libravatar Phil Hord1-6/+7
Documentation and some comments still refer to files in builtin/ as 'builtin-*.[cho]'. Update these to show the correct location. Signed-off-by: Phil Hord <hordp@cisco.com> Reviewed-by: Jonathan Nieder <jrnieder@gmail.com> Assisted-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-04-01Merge branch 'da/downcase-u-in-usage' into maintLibravatar Junio C Hamano1-2/+2
* da/downcase-u-in-usage: contrib/mw-to-git/t/install-wiki.sh: use a lowercase "usage:" string contrib/examples/git-remote.perl: use a lowercase "usage:" string tests: use a lowercase "usage:" string git-svn: use a lowercase "usage:" string Documentation/user-manual.txt: use a lowercase "usage:" string templates/hooks--update.sample: use a lowercase "usage:" string contrib/hooks/setgitperms.perl: use a lowercase "usage:" string contrib/examples: use a lowercase "usage:" string contrib/fast-import/import-zips.py: use spaces instead of tabs contrib/fast-import/import-zips.py: fix broken error message contrib/fast-import: use a lowercase "usage:" string contrib/credential: use a lowercase "usage:" string git-cvsimport: use a lowercase "usage:" string git-cvsimport: use a lowercase "usage:" string git-cvsexportcommit: use a lowercase "usage:" string git-archimport: use a lowercase "usage:" string git-merge-one-file: use a lowercase "usage:" string git-relink: use a lowercase "usage:" string git-svn: use a lowercase "usage:" string git-sh-setup: use a lowercase "usage:" string
2013-03-19Merge branch 'wk/user-manual-literal-format'Libravatar Junio C Hamano1-142/+144
* wk/user-manual-literal-format: user-manual: Standardize backtick quoting
2013-03-19Merge branch 'da/downcase-u-in-usage'Libravatar Junio C Hamano1-2/+2
* da/downcase-u-in-usage: contrib/mw-to-git/t/install-wiki.sh: use a lowercase "usage:" string contrib/examples/git-remote.perl: use a lowercase "usage:" string tests: use a lowercase "usage:" string git-svn: use a lowercase "usage:" string Documentation/user-manual.txt: use a lowercase "usage:" string templates/hooks--update.sample: use a lowercase "usage:" string contrib/hooks/setgitperms.perl: use a lowercase "usage:" string contrib/examples: use a lowercase "usage:" string contrib/fast-import/import-zips.py: use spaces instead of tabs contrib/fast-import/import-zips.py: fix broken error message contrib/fast-import: use a lowercase "usage:" string contrib/credential: use a lowercase "usage:" string git-cvsimport: use a lowercase "usage:" string git-cvsimport: use a lowercase "usage:" string git-cvsexportcommit: use a lowercase "usage:" string git-archimport: use a lowercase "usage:" string git-merge-one-file: use a lowercase "usage:" string git-relink: use a lowercase "usage:" string git-svn: use a lowercase "usage:" string git-sh-setup: use a lowercase "usage:" string
2013-03-01Merge branch 'wk/user-manual' into maintLibravatar Junio C Hamano1-56/+77
* wk/user-manual: user-manual: Flesh out uncommitted changes and submodule updates user-manual: Use request-pull to generate "please pull" text user-manual: Reorganize the reroll sections, adding 'git rebase -i'
2013-02-27Merge branch 'wk/man-deny-current-branch-is-default-these-days' into maintLibravatar Junio C Hamano1-3/+4
* wk/man-deny-current-branch-is-default-these-days: user-manual: typofix (ofthe->of the) user-manual: Update for receive.denyCurrentBranch=refuse
2013-02-25user-manual: Standardize backtick quotingLibravatar W. Trevor King1-142/+144
I tried to always use backticks for: * Paths and filenames (e.g. `.git/config`) * Compound refs (e.g. `origin/HEAD`) * Git commands (e.g. `git log`) * Command arguments (e.g. `--pretty`) * URLs (e.g. `git://`), as a subset of command arguments * Special characters (e.g. `+` in diffs). * Config options (e.g. `branch.<name>.remote`) Branch and tag names are sometimes set off with double quotes, sometimes set off with backticks, and sometimes left bare. I tried to judge when the intention was introducing new terms or conventions (double quotes), to reference a recently used command argument (backticks), or to reference the abstract branch/commit (left bare). Obviously these are not particularly crisp definitions, so my decisions are fairly arbitrary ;). When a reference had already been introduced, I changed further double-quoted instances to backticked instances. When new backticks increased the length of a line beyond others in that block, I re-wrapped blocks to 72 columns. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-25Merge branch 'wk/user-manual'Libravatar Junio C Hamano1-56/+77
Further updates to the user manual. * wk/user-manual: user-manual: Flesh out uncommitted changes and submodule updates user-manual: Use request-pull to generate "please pull" text user-manual: Reorganize the reroll sections, adding 'git rebase -i'
2013-02-25Merge branch 'wk/man-deny-current-branch-is-default-these-days'Libravatar Junio C Hamano1-1/+1
* wk/man-deny-current-branch-is-default-these-days: user-manual: typofix (ofthe->of the)
2013-02-24Documentation/user-manual.txt: use a lowercase "usage:" stringLibravatar David Aguilar1-2/+2
Make the usage string in the example script consistent with Git. Reviewed-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: David Aguilar <davvid@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-19user-manual: Flesh out uncommitted changes and submodule updatesLibravatar W. Trevor King1-1/+3
If you try and update a submodule with a dirty working directory, you get an error message like: $ git submodule update error: Your local changes to the following files would be overwritten by checkout: ... Please, commit your changes or stash them before you can switch branches. Aborting ... Mention this in the submodule notes. The previous phrase was short enough that I originally thought it might have been referring to the reflog note (obviously, uncommitted changes will not show up in the reflog either ;). Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-19user-manual: Use request-pull to generate "please pull" textLibravatar W. Trevor King1-9/+5
Less work and more error checking (e.g. does a merge base exist?). Add an explicit push before request-pull to satisfy request-pull, which checks to make sure the references are publically available. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-19user-manual: Reorganize the reroll sections, adding 'git rebase -i'Libravatar W. Trevor King1-46/+69
I think this interface is often more convenient than extended cherry picking or using 'git format-patch'. In fact, I removed the cherry-pick section entirely. The entry-level suggestions for rerolling are now: 1. git commit --amend 2. git format-patch origin git reset --hard origin ...edit and reorder patches... git am *.patch 3. git rebase -i origin Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-18user-manual: typofix (ofthe->of the)Libravatar Junio C Hamano1-1/+1
Noticed by Drew Northup Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-18Merge branch 'maint'Libravatar Junio C Hamano1-40/+55
* maint: user-manual: use -o latest.tar.gz to create a gzipped tarball user-manual: use 'git config --global user.*' for setup user-manual: mention 'git remote add' for remote branch config user-manual: give 'git push -f' as an alternative to +master user-manual: use 'remote add' to setup push URLs
2013-02-18user-manual: use -o latest.tar.gz to create a gzipped tarballLibravatar W. Trevor King1-3/+12
This functionality was introduced by 0e804e09 (archive: provide builtin .tar.gz filter, 2011-07-21) for v1.7.7. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-18user-manual: use 'git config --global user.*' for setupLibravatar W. Trevor King1-5/+13
A simple command line call is easier than spawning an editor, especially for folks new to ideas like the "command line" and "text editors". This is also the approach suggested by 'git commit' if you try and commit without having configured user.name or user.email. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-18user-manual: mention 'git remote add' for remote branch configLibravatar W. Trevor King1-27/+13
I hardly ever setup remote.<name>.url using 'git config'. While it may be instructive to do so, we should also point out 'git remote add'. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-18user-manual: give 'git push -f' as an alternative to +masterLibravatar W. Trevor King1-0/+7
This mirrors existing language in the description of 'git fetch'. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-18user-manual: use 'remote add' to setup push URLsLibravatar W. Trevor King1-5/+10
There is no need to use here documents to setup this configuration. It is easier, less confusing, and more robust to use `git remote add` directly. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-14Merge branch 'wk/man-deny-current-branch-is-default-these-days'Libravatar Junio C Hamano1-3/+4
* wk/man-deny-current-branch-is-default-these-days: user-manual: Update for receive.denyCurrentBranch=refuse
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-18 21:43:37 +0000