Mercurial > hg-git
comparison README.md @ 1087:3b20ecf51ed5
doc: document all config options in README
| author | Kevin Bullock <kbullock@ringworld.org> |
|---|---|
| date | Mon, 27 Nov 2017 22:03:18 -0600 |
| parents | c71dc6e5c62a |
| children |
comparison
equal
deleted
inserted
replaced
| 1086:c71dc6e5c62a | 1087:3b20ecf51ed5 |
|---|---|
| 160 | 160 |
| 161 It should be noted that **this translation is on the hg->git side only**. Changesets | 161 It should be noted that **this translation is on the hg->git side only**. Changesets |
| 162 coming from Git back to Mercurial will not translate back into hg usernames, so | 162 coming from Git back to Mercurial will not translate back into hg usernames, so |
| 163 it's best that the same username/email combination be used on both the hg and git sides; | 163 it's best that the same username/email combination be used on both the hg and git sides; |
| 164 the author file is mostly useful for translating legacy changesets. | 164 the author file is mostly useful for translating legacy changesets. |
| 165 | |
| 166 git.blockdotgit | |
| 167 --------------- | |
| 168 | |
| 169 Blocks exporting revisions to Git that contain a directory named .git or any | |
| 170 letter-case variation thereof. This prevents creating repositories that newer | |
| 171 versions of Git and many Git hosting services block due to security | |
| 172 concerns. Defaults to True. | |
| 173 | |
| 174 git.blockdothg | |
| 175 -------------- | |
| 176 | |
| 177 Blocks importing revisions from Git that contain a directory named .hg. Defaults | |
| 178 to True. | |
| 165 | 179 |
| 166 git.branch_bookmark_suffix | 180 git.branch_bookmark_suffix |
| 167 --------------------------- | 181 --------------------------- |
| 168 | 182 |
| 169 hg-git does not convert between Mercurial named branches and git branches as | 183 hg-git does not convert between Mercurial named branches and git branches as |
| 220 | 234 |
| 221 If set, branches where the latest commit's commit time is older than this will | 235 If set, branches where the latest commit's commit time is older than this will |
| 222 not be imported. Accepts any date formats that Mercurial does -- see | 236 not be imported. Accepts any date formats that Mercurial does -- see |
| 223 `hg help dates` for more. | 237 `hg help dates` for more. |
| 224 | 238 |
| 239 git.public | |
| 240 ---------- | |
| 241 | |
| 242 A list of Git branches that should be considered "published", and therefore | |
| 243 converted to Mercurial in the 'public' phase. This is only used if | |
| 244 hggit.usephases is set. | |
| 245 | |
| 225 git.renamelimit | 246 git.renamelimit |
| 226 --------------- | 247 --------------- |
| 227 | 248 |
| 228 The number of files to consider when performing the copy/rename detection. | 249 The number of files to consider when performing the copy/rename detection. |
| 229 Detection is disabled if the number of files modified in a commit is above the | 250 Detection is disabled if the number of files modified in a commit is above the |
| 237 Specify how similar files modified in a Git commit must be to be imported as | 258 Specify how similar files modified in a Git commit must be to be imported as |
| 238 Mercurial renames or copies, as a percentage between "0" (disabled) and "100" | 259 Mercurial renames or copies, as a percentage between "0" (disabled) and "100" |
| 239 (files must be identical). For example, "90" means that a delete/add pair will | 260 (files must be identical). For example, "90" means that a delete/add pair will |
| 240 be imported as a rename if more than 90% of the file has stayed the same. The | 261 be imported as a rename if more than 90% of the file has stayed the same. The |
| 241 default is "0" (disabled). | 262 default is "0" (disabled). |
| 263 | |
| 264 hggit.mapsavefrequency | |
| 265 ---------------------- | |
| 266 | |
| 267 Controls how often the mapping between Git and Mercurial commit hashes gets | |
| 268 saved when importing or exporting changesets. Set this to a number greater than | |
| 269 0 to save the mapping after converting that many commits. This can help when the | |
| 270 conversion encounters an error partway through a large batch of | |
| 271 changes. Defaults to 0, so that the mapping is saved once at the end. | |
| 272 | |
| 273 hggit.usephases | |
| 274 --------------- | |
| 275 | |
| 276 When converting Git revisions to Mercurial, place them in the 'public' phase as | |
| 277 appropriate. Namely, revisions that are reachable from the remote Git | |
| 278 repository's HEAD will be marked 'public'. For most repositories, this means the | |
| 279 remote 'master' will be converted as public. This speeds up some local Mercurial | |
| 280 operations including `hg shelve`. |