Move mailmap documentation into separate file
Include it directly from git-shortlog.txt, and refer to it from pretty-format.txt. Signed-off-by: Marius Storm-Olsen <marius@trolltech.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
		 Marius Storm-Olsen
					Marius Storm-Olsen
				
			
				
					committed by
					
						 Junio C Hamano
						Junio C Hamano
					
				
			
			
				
	
			
			
			 Junio C Hamano
						Junio C Hamano
					
				
			
						parent
						
							d20d654fe8
						
					
				
				
					commit
					7d48e9e6f7
				
			| @ -184,6 +184,12 @@ there is ever added information (like the commit encoding or extended | |||||||
| commit commentary), a blame viewer won't ever care. | commit commentary), a blame viewer won't ever care. | ||||||
|  |  | ||||||
|  |  | ||||||
|  | MAPPING AUTHORS | ||||||
|  | --------------- | ||||||
|  |  | ||||||
|  | include::mailmap.txt[] | ||||||
|  |  | ||||||
|  |  | ||||||
| SEE ALSO | SEE ALSO | ||||||
| -------- | -------- | ||||||
| linkgit:git-annotate[1] | linkgit:git-annotate[1] | ||||||
|  | |||||||
| @ -45,86 +45,15 @@ OPTIONS | |||||||
| 	and subsequent lines are indented by `indent2` spaces. `width`, | 	and subsequent lines are indented by `indent2` spaces. `width`, | ||||||
| 	`indent1`, and `indent2` default to 76, 6 and 9 respectively. | 	`indent1`, and `indent2` default to 76, 6 and 9 respectively. | ||||||
|  |  | ||||||
| FILES |  | ||||||
| ----- |  | ||||||
|  |  | ||||||
| If the file `.mailmap` exists at the toplevel of the repository, or at | MAPPING AUTHORS | ||||||
| the location pointed to by the mailmap.file configuration option, it | --------------- | ||||||
| is used to map author and committer names and email addresses to |  | ||||||
| canonical real names and email addresses. |  | ||||||
| This mapping can be used to coalesce together commits by the same |  | ||||||
| person where their name and/or email address was spelled differently. |  | ||||||
|  |  | ||||||
| In the simple form, each line in the file consists of the canonical | The `.mailmap` feature is used to coalesce together commits by the same | ||||||
| real name of an author, whitespace, and an email address used in the | person in the shortlog, where their name and/or email address was | ||||||
| commit (enclosed by '<' and '>') to map to the name. Thus, looks like | spelled differently. | ||||||
| this |  | ||||||
| -- |  | ||||||
| 	Proper Name <commit@email.xx> |  | ||||||
| -- |  | ||||||
|  |  | ||||||
| The more complex forms are | include::mailmap.txt[] | ||||||
| -- |  | ||||||
| 	<proper@email.xx> <commit@email.xx> |  | ||||||
| -- |  | ||||||
| which allows mailmap to replace only the email part of a commit, and |  | ||||||
| -- |  | ||||||
| 	Proper Name <proper@email.xx> <commit@email.xx> |  | ||||||
| -- |  | ||||||
| which allows mailmap to replace both the name and the email of a |  | ||||||
| commit matching the specified commit email address, and |  | ||||||
| -- |  | ||||||
| 	Proper Name <proper@email.xx> Commit Name <commit@email.xx> |  | ||||||
| -- |  | ||||||
| which allows mailmap to replace both the name and the email of a |  | ||||||
| commit matching both the specified commit name and email address. |  | ||||||
|  |  | ||||||
| Example 1: Your history contains commits by two authors, Jane |  | ||||||
| and Joe, whose names appear in the repository under several forms: |  | ||||||
|  |  | ||||||
| ------------ |  | ||||||
| Joe Developer <joe@example.com> |  | ||||||
| Joe R. Developer <joe@example.com> |  | ||||||
| Jane Doe <jane@example.com> |  | ||||||
| Jane Doe <jane@laptop.(none)> |  | ||||||
| Jane D. <jane@desktop.(none)> |  | ||||||
| ------------ |  | ||||||
|  |  | ||||||
| Now suppose that Joe wants his middle name initial used, and Jane |  | ||||||
| prefers her family name fully spelled out. A proper `.mailmap` file |  | ||||||
| would look like: |  | ||||||
|  |  | ||||||
| ------------ |  | ||||||
| Jane Doe         <jane@desktop.(none)> |  | ||||||
| Joe R. Developer <joe@example.com> |  | ||||||
| ------------ |  | ||||||
|  |  | ||||||
| Note how we don't need an entry for <jane@laptop.(none)>, because the |  | ||||||
| real name of that author is correct already, and coalesced directly. |  | ||||||
|  |  | ||||||
| Example 2: Your repository contains commits from the following |  | ||||||
| authors: |  | ||||||
|  |  | ||||||
| ------------ |  | ||||||
| nick1 <bugs@company.xx> |  | ||||||
| nick2 <bugs@company.xx> |  | ||||||
| nick2 <nick2@company.xx> |  | ||||||
| santa <me@company.xx> |  | ||||||
| claus <me@company.xx> |  | ||||||
| CTO <cto@coompany.xx> |  | ||||||
| ------------ |  | ||||||
|  |  | ||||||
| Then, you might want a `.mailmap` file looking like: |  | ||||||
| ------------ |  | ||||||
| <cto@company.xx>                       <cto@coompany.xx> |  | ||||||
| Some Dude <some@dude.xx>         nick1 <bugs@company.xx> |  | ||||||
| Other Author <other@author.xx>   nick2 <bugs@company.xx> |  | ||||||
| Other Author <other@author.xx>         <nick2@company.xx> |  | ||||||
| Santa Claus <santa.claus@northpole.xx> <me@company.xx> |  | ||||||
| ------------ |  | ||||||
|  |  | ||||||
| Use hash '#' for comments that are either on their own line, or after |  | ||||||
| the email address. |  | ||||||
|  |  | ||||||
|  |  | ||||||
| Author | Author | ||||||
|  | |||||||
							
								
								
									
										75
									
								
								Documentation/mailmap.txt
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										75
									
								
								Documentation/mailmap.txt
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,75 @@ | |||||||
|  | If the file `.mailmap` exists at the toplevel of the repository, or at | ||||||
|  | the location pointed to by the mailmap.file configuration option, it | ||||||
|  | is used to map author and committer names and email addresses to | ||||||
|  | canonical real names and email addresses. | ||||||
|  |  | ||||||
|  | In the simple form, each line in the file consists of the canonical | ||||||
|  | real name of an author, whitespace, and an email address used in the | ||||||
|  | commit (enclosed by '<' and '>') to map to the name. Thus, looks like | ||||||
|  | this | ||||||
|  | -- | ||||||
|  | 	Proper Name <commit@email.xx> | ||||||
|  | -- | ||||||
|  |  | ||||||
|  | The more complex forms are | ||||||
|  | -- | ||||||
|  | 	<proper@email.xx> <commit@email.xx> | ||||||
|  | -- | ||||||
|  | which allows mailmap to replace only the email part of a commit, and | ||||||
|  | -- | ||||||
|  | 	Proper Name <proper@email.xx> <commit@email.xx> | ||||||
|  | -- | ||||||
|  | which allows mailmap to replace both the name and the email of a | ||||||
|  | commit matching the specified commit email address, and | ||||||
|  | -- | ||||||
|  | 	Proper Name <proper@email.xx> Commit Name <commit@email.xx> | ||||||
|  | -- | ||||||
|  | which allows mailmap to replace both the name and the email of a | ||||||
|  | commit matching both the specified commit name and email address. | ||||||
|  |  | ||||||
|  | Example 1: Your history contains commits by two authors, Jane | ||||||
|  | and Joe, whose names appear in the repository under several forms: | ||||||
|  |  | ||||||
|  | ------------ | ||||||
|  | Joe Developer <joe@example.com> | ||||||
|  | Joe R. Developer <joe@example.com> | ||||||
|  | Jane Doe <jane@example.com> | ||||||
|  | Jane Doe <jane@laptop.(none)> | ||||||
|  | Jane D. <jane@desktop.(none)> | ||||||
|  | ------------ | ||||||
|  |  | ||||||
|  | Now suppose that Joe wants his middle name initial used, and Jane | ||||||
|  | prefers her family name fully spelled out. A proper `.mailmap` file | ||||||
|  | would look like: | ||||||
|  |  | ||||||
|  | ------------ | ||||||
|  | Jane Doe         <jane@desktop.(none)> | ||||||
|  | Joe R. Developer <joe@example.com> | ||||||
|  | ------------ | ||||||
|  |  | ||||||
|  | Note how we don't need an entry for <jane@laptop.(none)>, because the | ||||||
|  | real name of that author is correct already. | ||||||
|  |  | ||||||
|  | Example 2: Your repository contains commits from the following | ||||||
|  | authors: | ||||||
|  |  | ||||||
|  | ------------ | ||||||
|  | nick1 <bugs@company.xx> | ||||||
|  | nick2 <bugs@company.xx> | ||||||
|  | nick2 <nick2@company.xx> | ||||||
|  | santa <me@company.xx> | ||||||
|  | claus <me@company.xx> | ||||||
|  | CTO <cto@coompany.xx> | ||||||
|  | ------------ | ||||||
|  |  | ||||||
|  | Then, you might want a `.mailmap` file looking like: | ||||||
|  | ------------ | ||||||
|  | <cto@company.xx>                       <cto@coompany.xx> | ||||||
|  | Some Dude <some@dude.xx>         nick1 <bugs@company.xx> | ||||||
|  | Other Author <other@author.xx>   nick2 <bugs@company.xx> | ||||||
|  | Other Author <other@author.xx>         <nick2@company.xx> | ||||||
|  | Santa Claus <santa.claus@northpole.xx> <me@company.xx> | ||||||
|  | ------------ | ||||||
|  |  | ||||||
|  | Use hash '#' for comments that are either on their own line, or after | ||||||
|  | the email address. | ||||||
| @ -101,18 +101,18 @@ The placeholders are: | |||||||
| - '%P': parent hashes | - '%P': parent hashes | ||||||
| - '%p': abbreviated parent hashes | - '%p': abbreviated parent hashes | ||||||
| - '%an': author name | - '%an': author name | ||||||
| - '%aN': author name (respecting .mailmap) | - '%aN': author name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) | ||||||
| - '%ae': author email | - '%ae': author email | ||||||
| - '%aE': author email (respecting .mailmap) | - '%aE': author email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) | ||||||
| - '%ad': author date (format respects --date= option) | - '%ad': author date (format respects --date= option) | ||||||
| - '%aD': author date, RFC2822 style | - '%aD': author date, RFC2822 style | ||||||
| - '%ar': author date, relative | - '%ar': author date, relative | ||||||
| - '%at': author date, UNIX timestamp | - '%at': author date, UNIX timestamp | ||||||
| - '%ai': author date, ISO 8601 format | - '%ai': author date, ISO 8601 format | ||||||
| - '%cn': committer name | - '%cn': committer name | ||||||
| - '%cN': committer name (respecting .mailmap) | - '%cN': committer name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) | ||||||
| - '%ce': committer email | - '%ce': committer email | ||||||
| - '%cE': committer email (respecting .mailmap) | - '%cE': committer email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) | ||||||
| - '%cd': committer date | - '%cd': committer date | ||||||
| - '%cD': committer date, RFC2822 style | - '%cD': committer date, RFC2822 style | ||||||
| - '%cr': committer date, relative | - '%cr': committer date, relative | ||||||
|  | |||||||
		Reference in New Issue
	
	Block a user