aboutsummaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAge
* Improve git-log documentation wrt file filtersmartin f. krafft2008-10-01
| | | | | | | | | | | | The need for "--" in the git-log synopsis was previously unclear and confusing. This patch makes it a little clearer. Thanks to hyy <yiyihu@gmail.com> for his help. [sp: Changed -- to \-- per prior commit e1ccf53.] Signed-off-by: martin f. krafft <madduck@madduck.net> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
* Documentation: remove '\' in front of short optionsSZEDER Gábor2008-10-01
| | | | | | | | | | | ... because they show up in the man and html outputs. This escaping is only needed for double dashes to be compatible with older asciidoc versions; see commit e1ccf53 ([PATCH] Escape asciidoc's built-in em-dash replacement, 2005-09-12). Signed-off-by: SZEDER Gábor <szeder@ira.uka.de> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
* Replace svn.foo.org with svn.example.com in git-svn docs (RFC 2606)Michael Prokop2008-09-30
| | | | | | | | foo.org is an existing domain, use RFC 2606 complying example.com instead as used in other docs as well. Signed-off-by: Michael Prokop <mika@grml.org> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
* Merge branch 'bc/maint-diff-hunk-header-fix' into maintShawn O. Pearce2008-09-29
|\ | | | | | | | | | | | | | | | | | | | | | | | | * bc/maint-diff-hunk-header-fix: t4018-diff-funcname: test syntax of builtin xfuncname patterns diff hunk pattern: fix misconverted "\{" tex macro introducers diff: use extended regexp to find hunk headers diff.*.xfuncname which uses "extended" regex's for hunk header selection diff.c: associate a flag with each pattern and use it for compiling regex diff.c: return pattern entry pointer rather than just the hunk header pattern Conflicts: Documentation/gitattributes.txt
| * diff.*.xfuncname which uses "extended" regex's for hunk header selectionBrandon Casey2008-09-18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Currently, the hunk headers produced by 'diff -p' are customizable by setting the diff.*.funcname option in the config file. The 'funcname' option takes a basic regular expression. This functionality was designed using the GNU regex library which, by default, allows using backslashed versions of some extended regular expression operators, even in Basic Regular Expression mode. For example, the following characters, when backslashed, are interpreted according to the extended regular expression rules: ?, +, and |. As such, the builtin funcname patterns were created using some extended regular expression operators. Other platforms which adhere more strictly to the POSIX spec do not interpret the backslashed extended RE operators in Basic Regular Expression mode. This causes the pattern matching for the builtin funcname patterns to fail on those platforms. Introduce a new option 'xfuncname' which uses extended regular expressions, and advertise it _instead_ of funcname. Since most users are on GNU platforms, the majority of funcname patterns are created and tested there. Advertising only xfuncname should help to avoid the creation of non-portable patterns which work with GNU regex but not elsewhere. Additionally, the extended regular expressions may be less ugly and complicated compared to the basic RE since many common special operators do not need to be backslashed. For example, the GNU Basic RE: ^[ ]*\\(\\(public\\|static\\).*\\)$ becomes the following Extended RE: ^[ ]*((public|static).*)$ Signed-off-by: Brandon Casey <casey@nrlssc.navy.mil> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: clarify the details of overriding LESS via core.pagerChris Frey2008-09-26
| | | | | | | | | | | | | | | | | | The process of overriding the default LESS options using only git-specific methods is rather obscure. Show the end user how to do it in a step-by-step manner. Signed-off-by: Chris Frey <cdfrey@foursquare.net> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
* | Update release notes for 1.6.0.3Shawn O. Pearce2008-09-25
| | | | | | | | Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
* | Start draft release notes for 1.6.0.3Junio C Hamano2008-09-19
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | git-repack uses --no-repack-object, not --no-repack-delta.Mikael Magnusson2008-09-19
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Bust the ghost of long-defunct diffcore-pathspec.Yann Dirson2008-09-19
| | | | | | | | | | | | | | | | This concept was retired by 77882f6 (Retire diffcore-pathspec., 2006-04-10), more than 2 years ago. Signed-off-by: Yann Dirson <ydirson@altern.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Merge branch 'jc/maint-checkout-keep-remove' into maintJunio C Hamano2008-09-18
|\ \ | | | | | | | | | | | | * jc/maint-checkout-keep-remove: checkout: do not lose staged removal
| * | checkout: do not lose staged removalJunio C Hamano2008-09-09
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The logic to checkout a different commit implements the safety to never lose user's local changes. For example, switching from a commit to another commit, when you have changed a path that is different between them, need to merge your changes to the version from the switched-to commit, which you may not necessarily be able to resolve easily. By default, "git checkout" refused to switch branches, to give you a chance to stash your local changes (or use "-m" to merge, accepting the risks of getting conflicts). This safety, however, had one deliberate hole since early June 2005. When your local change was to remove a path (and optionally to stage that removal), the command checked out the path from the switched-to commit nevertheless. This was to allow an initial checkout to happen smoothly (e.g. an initial checkout is done by starting with an empty index and switching from the commit at the HEAD to the same commit). We can tighten the rule slightly to allow this special case to pass, without losing sight of removal explicitly done by the user, by noticing if the index is truly empty when the operation begins. For historical background, see: http://thread.gmane.org/gmane.comp.version-control.git/4641/focus=4646 This case is marked as *0* in the message, which both Linus and I said "it feels somewhat wrong but otherwise we cannot start from an empty index". Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | | Clarified gitattributes documentation regarding custom hunk header.Garry Dolley2008-09-18
| |/ |/| | | | | | | | | | | | | The only part of the hunk header that we can change is the "TEXT" portion. Additionally, a few grammatical errors have been corrected. Signed-off-by: Garry Dolley <gdolley@ucla.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | GIT 1.6.0.2v1.6.0.2Junio C Hamano2008-09-12
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Fix some manual typos.Ralf Wildenhues2008-09-12
| | | | | | | | | | Signed-off-by: Ralf Wildenhues <Ralf.Wildenhues@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Update draft release notes for 1.6.0.2Junio C Hamano2008-09-10
|/ | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Update draft release notes for 1.6.0.2Junio C Hamano2008-09-06
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Mention the fact that 'git annotate' is only for backward compatibility.Junio C Hamano2008-09-05
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | When somebody is reading git-blame.txt (or git-annotate.txt) for the first time, the message we would like to send is: (1) Here is why you would want to use this command, what it can do (perhaps more than what you would have expected from "$scm blame"), and how you tell it to do what it does. This is obvious. (2) You might have heard of the command with the other name. There is no difference between the two, except they differ in their default output formats. This is essential to answer: "git has both? how are they different?" (3) We tend to encourage blame over annotate for new scripts and new people, but there is no reason to choose one over the other. This is not as important as (2), but would be useful to avoid repeated questions about "when will we start deprecating this?" As long as we describe (2) on git-annotate page clearly enough, people who read git-blame page first and get curious can refer to git-annotate page. While at it, subtly hint (3) without being overly explicit. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Start 1.6.0.2 maintenance cycleJunio C Hamano2008-09-03
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Fix passwd(5) ref and reflect that commit doens't use commit-treeJonas Fonseca2008-09-03
| | | | | Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Improve documentation for --dirstat diff optionHeikki Orsila2008-09-01
| | | | | Signed-off-by: Heikki Orsila <heikki.orsila@iki.fi> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: minor cleanup in a use case in 'git stash' manualSZEDER Gábor2008-09-01
| | | | | | | | There is no need to explicitly pass the file to be committed to 'git commit', because it's contents is already in the index. Signed-off-by: SZEDER Gábor <szeder@ira.uka.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: fix disappeared lines in 'git stash' manpageSZEDER Gábor2008-09-01
| | | | | | | | | Asciidoc removes lines starting with a dot when creating manpages. Since those lines were comments in use case examples showing shell commands, preceed those lines with a hash sign. Signed-off-by: SZEDER Gábor <szeder@ira.uka.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: fix reference to a for-each-ref optionSZEDER Gábor2008-09-01
| | | | | | | ... to match the synopsis section Signed-off-by: SZEDER Gábor <szeder@ira.uka.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Document sendemail.envelopesender configurationAsk Bjørn Hansen2008-08-31
| | | | | Signed-off-by: Ask Bjørn Hansen <ask@develooper.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Document clarification: gitmodules, gitattributesGustaf Hendeby2008-08-31
| | | | | | | | | | The SYNOPSIS section of gitattibutes and gitmodule fail to clearly specify the name of the in tree files used. This patch brings in the initial `.' and the fact that the `.gitmodules' file should reside at the top-level of the working tree. Signed-off-by: Gustaf Hendeby <hendeby@isy.liu.se> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* config.txt: Add missing colons after option nameTeemu Likonen2008-08-30
| | | | | | | | | gitcvs.usecrlfattr --> gitcvs.usecrlfattr:: This fixes an asciidoc markup issue. Signed-off-by: Teemu Likonen <tlikonen@iki.fi> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* gitattributes: -crlf is not binaryJunio C Hamano2008-08-30
| | | | | | | | | | | | | The description of crlf attribute incorrectly said that "-crlf" means binary. It is true that for binary files you would want "-crlf", but that is not the same thing. We also have supported attribute macros and via that mechanism a handy "binary" to specify "-crlf -diff" at the same time. It was not documented anywhere as far as I can tell, even though the support was there from the very beginning. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Fix example in git-name-rev documentationJunio C Hamano2008-08-30
| | | | | | | | | Since 59d3f54 (name-rev: avoid "^0" when unneeded, 2007-02-20), name-rev stopped showing an unnecessary "^0" to dereference a tag down to a commit. The patch should have made a matching update to the documentation, but we forgot. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* tutorial: gentler illustration of Alice/Bob workflow using gitkPaolo Ciarrocchi2008-08-29
| | | | | | | | | Update to gitutorial as discussedin the git mailing list: http://marc.info/?t=121969390900002&r=1&w=2 Signed-off-by: Paolo Ciarrocchi <paolo.ciarrocchi@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* pretty=format: respect date format optionsJeff King2008-08-29
| | | | | | | | | | | | | When running a command like: git log --pretty=format:%ad --date=short the date option was ignored. This patch causes it to use whatever format was specified by --date (or by --relative-date, etc), just as the non-user formats would do. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Document gitk --argscmd flag.Yann Dirson2008-08-29
| | | | | | | This was part of my original patch, but appears to have been lost. Signed-off-by: Yann Dirson <ydirson@altern.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.6.0.1v1.6.0.1Junio C Hamano2008-08-24
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: clarify pager configurationJonathan Nieder2008-08-24
| | | | | | | The unwary user may not know how to disable the -FRSX options. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: clarify pager.<cmd> configurationJonathan Nieder2008-08-24
| | | | | | | | | | | | | | It was not obvious from the text that pager.<cmd> is a boolean setting. While we're changing the description, make some other improvements: lest we forget and fret, clarify that -p and pager.<cmd> do not kick in when stdout is not a tty; point to related core.pager and GIT_PAGER settings; use renamed --paginate option. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Update draft release notes for 1.6.0.1Junio C Hamano2008-08-20
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Add hints to revert documentation about other ways to undo changesTarmigan Casebolt2008-08-20
| | | | | | | | | | | | | | Based on its name, people may read the 'git revert' documentation when they want to undo local changes, especially people who have used other SCM's. 'git revert' may not be what they had in mind, but git provides several other ways to undo changes to files. We can help them by pointing them towards the git commands that do what they might want to do. Cc: Daniel Barkalow <barkalow@iabervon.org> Cc: Lea Wiemann <lewiemann@gmail.com> Signed-off-by: Tarmigan Casebolt <tarmigan+git@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* adapt git-cvsserver manpage to dash-free syntaxRobert Schiele2008-08-18
| | | | | Signed-off-by: Robert Schiele <rschiele@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Start 1.6.0.X maintenance seriesJunio C Hamano2008-08-17
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.6.0v1.6.0Junio C Hamano2008-08-17
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: document the pager.* configuration settingMiklos Vajna2008-08-16
| | | | | | | | It was already documented in RelNotes-1.6.0, but not in the git-config manual page. Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git-stash: improve synopsis in help and manual pageStephan Beyer2008-08-16
| | | | | | | | | | | | | | | | | | | | | | "git stash -h" showed some incomplete and ugly usage information. For example, the useful "--keep-index" option for "save" or the "--index" option for "apply" were not shown. Also in the documentation synopsis they were not shown, so that there is no incentive to scroll down and even see that such options exist. This patch improves the git-stash synopsis in the documentation by mentioning that further options to the stash commands and then copies this synopsis to the usage information string of git-stash.sh. For the latter, the dashless git command string has to be inserted on the second and the following usage lines. The code of this is taken from git-sh-setup so that all lines will show the command string. Note that the "create" command is not advertised at all now, because it was not mentioned in git-stash.txt. Signed-off-by: Stephan Beyer <s-beyer@gmx.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git-am: ignore --binary optionStephan Beyer2008-08-16
| | | | | | | | | The git-apply documentation says that --binary is a historical option. This patch lets git-am ignore --binary and removes advertisements of this option. Signed-off-by: Stephan Beyer <s-beyer@gmx.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git format-patch documentation: clarify what --cover-letter doesMatt McCutchen2008-08-14
| | | | | Signed-off-by: Matt McCutchen <matt@mattmccutchen.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* GIT 1.6.0-rc3v1.6.0-rc3Junio C Hamano2008-08-12
| | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'maint'Junio C Hamano2008-08-12
|\ | | | | | | | | * maint: Do not talk about "diff" in rev-list documentation.
| * Do not talk about "diff" in rev-list documentation.Junio C Hamano2008-08-12
| | | | | | | | | | | | | | | | Since 8c02eee (git-rev-list(1): group options; reformat; document more options, 2006-09-01), git-rev-list documentation talks as if it supports any kind of diff output. It doesn't. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: rev-list-options: Rewrite simplification descriptions for clarityThomas Rast2008-08-12
| | | | | | | | | | | | | | | | This completely rewrites the documentation of --full-history with lots of examples. Signed-off-by: Thomas Rast <trast@student.ethz.ch> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Teach git diff about BibTeX head hunk patternsGustaf Hendeby2008-08-12
| | | | | | | | | | | | | | | | | | | | | | All BibTeX entries starts with an @ followed by an entry type. Since there are many entry types and own can be defined, the pattern matches legal entry type names instead of just the default types (which would be a long list). The pattern also matches strings and comments since they will also be useful to position oneself in a bib-file. Signed-off-by: Gustaf Hendeby <hendeby@isy.liu.se> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | gitattributes: Document built in hunk header patternsGustaf Hendeby2008-08-12
| | | | | | | | | | | | | | | | | | Since the hunk header pattern text was written patterns for Ruby and Pascal/Delphi have been added. For users to be able to find them they should be documented not only in code. Signed-off-by: Gustaf Hendeby <hendeby@isy.liu.se> Signed-off-by: Junio C Hamano <gitster@pobox.com>
generated by cgit v1.2.1 (git 2.18.0) at 2024-09-19 05:29:52 +0000