##// END OF EJS Templates
commitextras: move fb extension to core which add extras to a commit...
Pulkit Goyal -
r33546:77c0c366 default
parent child Browse files
Show More
@@ -0,0 +1,45 b''
1 # commitextras.py
2 #
3 # Copyright 2013 Facebook, Inc.
4 #
5 # This software may be used and distributed according to the terms of the
6 # GNU General Public License version 2 or any later version.
7
8 '''adds a new flag extras to commit'''
9
10 from __future__ import absolute_import
11
12 from mercurial.i18n import _
13 from mercurial import (
14 commands,
15 extensions,
16 registrar,
17 )
18
19 cmdtable = {}
20 command = registrar.command(cmdtable)
21 testedwith = 'ships-with-hg-core'
22
23 def extsetup(ui):
24 entry = extensions.wrapcommand(commands.table, 'commit', _commit)
25 options = entry[1]
26 options.append(('', 'extra', [],
27 _('set a changeset\'s extra values'), _("KEY=VALUE")))
28
29 def _commit(orig, ui, repo, *pats, **opts):
30 origcommit = repo.commit
31 try:
32 def _wrappedcommit(*innerpats, **inneropts):
33 extras = opts.get('extra')
34 if extras:
35 for raw in extras:
36 k, v = raw.split('=', 1)
37 inneropts['extra'][k] = v
38 return origcommit(*innerpats, **inneropts)
39
40 # This __dict__ logic is needed because the normal
41 # extension.wrapfunction doesn't seem to work.
42 repo.__dict__['commit'] = _wrappedcommit
43 return orig(ui, repo, *pats, **opts)
44 finally:
45 del repo.__dict__['commit']
@@ -1,3367 +1,3368 b''
1 Short help:
1 Short help:
2
2
3 $ hg
3 $ hg
4 Mercurial Distributed SCM
4 Mercurial Distributed SCM
5
5
6 basic commands:
6 basic commands:
7
7
8 add add the specified files on the next commit
8 add add the specified files on the next commit
9 annotate show changeset information by line for each file
9 annotate show changeset information by line for each file
10 clone make a copy of an existing repository
10 clone make a copy of an existing repository
11 commit commit the specified files or all outstanding changes
11 commit commit the specified files or all outstanding changes
12 diff diff repository (or selected files)
12 diff diff repository (or selected files)
13 export dump the header and diffs for one or more changesets
13 export dump the header and diffs for one or more changesets
14 forget forget the specified files on the next commit
14 forget forget the specified files on the next commit
15 init create a new repository in the given directory
15 init create a new repository in the given directory
16 log show revision history of entire repository or files
16 log show revision history of entire repository or files
17 merge merge another revision into working directory
17 merge merge another revision into working directory
18 pull pull changes from the specified source
18 pull pull changes from the specified source
19 push push changes to the specified destination
19 push push changes to the specified destination
20 remove remove the specified files on the next commit
20 remove remove the specified files on the next commit
21 serve start stand-alone webserver
21 serve start stand-alone webserver
22 status show changed files in the working directory
22 status show changed files in the working directory
23 summary summarize working directory state
23 summary summarize working directory state
24 update update working directory (or switch revisions)
24 update update working directory (or switch revisions)
25
25
26 (use 'hg help' for the full list of commands or 'hg -v' for details)
26 (use 'hg help' for the full list of commands or 'hg -v' for details)
27
27
28 $ hg -q
28 $ hg -q
29 add add the specified files on the next commit
29 add add the specified files on the next commit
30 annotate show changeset information by line for each file
30 annotate show changeset information by line for each file
31 clone make a copy of an existing repository
31 clone make a copy of an existing repository
32 commit commit the specified files or all outstanding changes
32 commit commit the specified files or all outstanding changes
33 diff diff repository (or selected files)
33 diff diff repository (or selected files)
34 export dump the header and diffs for one or more changesets
34 export dump the header and diffs for one or more changesets
35 forget forget the specified files on the next commit
35 forget forget the specified files on the next commit
36 init create a new repository in the given directory
36 init create a new repository in the given directory
37 log show revision history of entire repository or files
37 log show revision history of entire repository or files
38 merge merge another revision into working directory
38 merge merge another revision into working directory
39 pull pull changes from the specified source
39 pull pull changes from the specified source
40 push push changes to the specified destination
40 push push changes to the specified destination
41 remove remove the specified files on the next commit
41 remove remove the specified files on the next commit
42 serve start stand-alone webserver
42 serve start stand-alone webserver
43 status show changed files in the working directory
43 status show changed files in the working directory
44 summary summarize working directory state
44 summary summarize working directory state
45 update update working directory (or switch revisions)
45 update update working directory (or switch revisions)
46
46
47 $ hg help
47 $ hg help
48 Mercurial Distributed SCM
48 Mercurial Distributed SCM
49
49
50 list of commands:
50 list of commands:
51
51
52 add add the specified files on the next commit
52 add add the specified files on the next commit
53 addremove add all new files, delete all missing files
53 addremove add all new files, delete all missing files
54 annotate show changeset information by line for each file
54 annotate show changeset information by line for each file
55 archive create an unversioned archive of a repository revision
55 archive create an unversioned archive of a repository revision
56 backout reverse effect of earlier changeset
56 backout reverse effect of earlier changeset
57 bisect subdivision search of changesets
57 bisect subdivision search of changesets
58 bookmarks create a new bookmark or list existing bookmarks
58 bookmarks create a new bookmark or list existing bookmarks
59 branch set or show the current branch name
59 branch set or show the current branch name
60 branches list repository named branches
60 branches list repository named branches
61 bundle create a bundle file
61 bundle create a bundle file
62 cat output the current or given revision of files
62 cat output the current or given revision of files
63 clone make a copy of an existing repository
63 clone make a copy of an existing repository
64 commit commit the specified files or all outstanding changes
64 commit commit the specified files or all outstanding changes
65 config show combined config settings from all hgrc files
65 config show combined config settings from all hgrc files
66 copy mark files as copied for the next commit
66 copy mark files as copied for the next commit
67 diff diff repository (or selected files)
67 diff diff repository (or selected files)
68 export dump the header and diffs for one or more changesets
68 export dump the header and diffs for one or more changesets
69 files list tracked files
69 files list tracked files
70 forget forget the specified files on the next commit
70 forget forget the specified files on the next commit
71 graft copy changes from other branches onto the current branch
71 graft copy changes from other branches onto the current branch
72 grep search revision history for a pattern in specified files
72 grep search revision history for a pattern in specified files
73 heads show branch heads
73 heads show branch heads
74 help show help for a given topic or a help overview
74 help show help for a given topic or a help overview
75 identify identify the working directory or specified revision
75 identify identify the working directory or specified revision
76 import import an ordered set of patches
76 import import an ordered set of patches
77 incoming show new changesets found in source
77 incoming show new changesets found in source
78 init create a new repository in the given directory
78 init create a new repository in the given directory
79 log show revision history of entire repository or files
79 log show revision history of entire repository or files
80 manifest output the current or given revision of the project manifest
80 manifest output the current or given revision of the project manifest
81 merge merge another revision into working directory
81 merge merge another revision into working directory
82 outgoing show changesets not found in the destination
82 outgoing show changesets not found in the destination
83 paths show aliases for remote repositories
83 paths show aliases for remote repositories
84 phase set or show the current phase name
84 phase set or show the current phase name
85 pull pull changes from the specified source
85 pull pull changes from the specified source
86 push push changes to the specified destination
86 push push changes to the specified destination
87 recover roll back an interrupted transaction
87 recover roll back an interrupted transaction
88 remove remove the specified files on the next commit
88 remove remove the specified files on the next commit
89 rename rename files; equivalent of copy + remove
89 rename rename files; equivalent of copy + remove
90 resolve redo merges or set/view the merge status of files
90 resolve redo merges or set/view the merge status of files
91 revert restore files to their checkout state
91 revert restore files to their checkout state
92 root print the root (top) of the current working directory
92 root print the root (top) of the current working directory
93 serve start stand-alone webserver
93 serve start stand-alone webserver
94 status show changed files in the working directory
94 status show changed files in the working directory
95 summary summarize working directory state
95 summary summarize working directory state
96 tag add one or more tags for the current or given revision
96 tag add one or more tags for the current or given revision
97 tags list repository tags
97 tags list repository tags
98 unbundle apply one or more bundle files
98 unbundle apply one or more bundle files
99 update update working directory (or switch revisions)
99 update update working directory (or switch revisions)
100 verify verify the integrity of the repository
100 verify verify the integrity of the repository
101 version output version and copyright information
101 version output version and copyright information
102
102
103 additional help topics:
103 additional help topics:
104
104
105 bundlespec Bundle File Formats
105 bundlespec Bundle File Formats
106 color Colorizing Outputs
106 color Colorizing Outputs
107 config Configuration Files
107 config Configuration Files
108 dates Date Formats
108 dates Date Formats
109 diffs Diff Formats
109 diffs Diff Formats
110 environment Environment Variables
110 environment Environment Variables
111 extensions Using Additional Features
111 extensions Using Additional Features
112 filesets Specifying File Sets
112 filesets Specifying File Sets
113 glossary Glossary
113 glossary Glossary
114 hgignore Syntax for Mercurial Ignore Files
114 hgignore Syntax for Mercurial Ignore Files
115 hgweb Configuring hgweb
115 hgweb Configuring hgweb
116 internals Technical implementation topics
116 internals Technical implementation topics
117 merge-tools Merge Tools
117 merge-tools Merge Tools
118 pager Pager Support
118 pager Pager Support
119 patterns File Name Patterns
119 patterns File Name Patterns
120 phases Working with Phases
120 phases Working with Phases
121 revisions Specifying Revisions
121 revisions Specifying Revisions
122 scripting Using Mercurial from scripts and automation
122 scripting Using Mercurial from scripts and automation
123 subrepos Subrepositories
123 subrepos Subrepositories
124 templating Template Usage
124 templating Template Usage
125 urls URL Paths
125 urls URL Paths
126
126
127 (use 'hg help -v' to show built-in aliases and global options)
127 (use 'hg help -v' to show built-in aliases and global options)
128
128
129 $ hg -q help
129 $ hg -q help
130 add add the specified files on the next commit
130 add add the specified files on the next commit
131 addremove add all new files, delete all missing files
131 addremove add all new files, delete all missing files
132 annotate show changeset information by line for each file
132 annotate show changeset information by line for each file
133 archive create an unversioned archive of a repository revision
133 archive create an unversioned archive of a repository revision
134 backout reverse effect of earlier changeset
134 backout reverse effect of earlier changeset
135 bisect subdivision search of changesets
135 bisect subdivision search of changesets
136 bookmarks create a new bookmark or list existing bookmarks
136 bookmarks create a new bookmark or list existing bookmarks
137 branch set or show the current branch name
137 branch set or show the current branch name
138 branches list repository named branches
138 branches list repository named branches
139 bundle create a bundle file
139 bundle create a bundle file
140 cat output the current or given revision of files
140 cat output the current or given revision of files
141 clone make a copy of an existing repository
141 clone make a copy of an existing repository
142 commit commit the specified files or all outstanding changes
142 commit commit the specified files or all outstanding changes
143 config show combined config settings from all hgrc files
143 config show combined config settings from all hgrc files
144 copy mark files as copied for the next commit
144 copy mark files as copied for the next commit
145 diff diff repository (or selected files)
145 diff diff repository (or selected files)
146 export dump the header and diffs for one or more changesets
146 export dump the header and diffs for one or more changesets
147 files list tracked files
147 files list tracked files
148 forget forget the specified files on the next commit
148 forget forget the specified files on the next commit
149 graft copy changes from other branches onto the current branch
149 graft copy changes from other branches onto the current branch
150 grep search revision history for a pattern in specified files
150 grep search revision history for a pattern in specified files
151 heads show branch heads
151 heads show branch heads
152 help show help for a given topic or a help overview
152 help show help for a given topic or a help overview
153 identify identify the working directory or specified revision
153 identify identify the working directory or specified revision
154 import import an ordered set of patches
154 import import an ordered set of patches
155 incoming show new changesets found in source
155 incoming show new changesets found in source
156 init create a new repository in the given directory
156 init create a new repository in the given directory
157 log show revision history of entire repository or files
157 log show revision history of entire repository or files
158 manifest output the current or given revision of the project manifest
158 manifest output the current or given revision of the project manifest
159 merge merge another revision into working directory
159 merge merge another revision into working directory
160 outgoing show changesets not found in the destination
160 outgoing show changesets not found in the destination
161 paths show aliases for remote repositories
161 paths show aliases for remote repositories
162 phase set or show the current phase name
162 phase set or show the current phase name
163 pull pull changes from the specified source
163 pull pull changes from the specified source
164 push push changes to the specified destination
164 push push changes to the specified destination
165 recover roll back an interrupted transaction
165 recover roll back an interrupted transaction
166 remove remove the specified files on the next commit
166 remove remove the specified files on the next commit
167 rename rename files; equivalent of copy + remove
167 rename rename files; equivalent of copy + remove
168 resolve redo merges or set/view the merge status of files
168 resolve redo merges or set/view the merge status of files
169 revert restore files to their checkout state
169 revert restore files to their checkout state
170 root print the root (top) of the current working directory
170 root print the root (top) of the current working directory
171 serve start stand-alone webserver
171 serve start stand-alone webserver
172 status show changed files in the working directory
172 status show changed files in the working directory
173 summary summarize working directory state
173 summary summarize working directory state
174 tag add one or more tags for the current or given revision
174 tag add one or more tags for the current or given revision
175 tags list repository tags
175 tags list repository tags
176 unbundle apply one or more bundle files
176 unbundle apply one or more bundle files
177 update update working directory (or switch revisions)
177 update update working directory (or switch revisions)
178 verify verify the integrity of the repository
178 verify verify the integrity of the repository
179 version output version and copyright information
179 version output version and copyright information
180
180
181 additional help topics:
181 additional help topics:
182
182
183 bundlespec Bundle File Formats
183 bundlespec Bundle File Formats
184 color Colorizing Outputs
184 color Colorizing Outputs
185 config Configuration Files
185 config Configuration Files
186 dates Date Formats
186 dates Date Formats
187 diffs Diff Formats
187 diffs Diff Formats
188 environment Environment Variables
188 environment Environment Variables
189 extensions Using Additional Features
189 extensions Using Additional Features
190 filesets Specifying File Sets
190 filesets Specifying File Sets
191 glossary Glossary
191 glossary Glossary
192 hgignore Syntax for Mercurial Ignore Files
192 hgignore Syntax for Mercurial Ignore Files
193 hgweb Configuring hgweb
193 hgweb Configuring hgweb
194 internals Technical implementation topics
194 internals Technical implementation topics
195 merge-tools Merge Tools
195 merge-tools Merge Tools
196 pager Pager Support
196 pager Pager Support
197 patterns File Name Patterns
197 patterns File Name Patterns
198 phases Working with Phases
198 phases Working with Phases
199 revisions Specifying Revisions
199 revisions Specifying Revisions
200 scripting Using Mercurial from scripts and automation
200 scripting Using Mercurial from scripts and automation
201 subrepos Subrepositories
201 subrepos Subrepositories
202 templating Template Usage
202 templating Template Usage
203 urls URL Paths
203 urls URL Paths
204
204
205 Test extension help:
205 Test extension help:
206 $ hg help extensions --config extensions.rebase= --config extensions.children=
206 $ hg help extensions --config extensions.rebase= --config extensions.children=
207 Using Additional Features
207 Using Additional Features
208 """""""""""""""""""""""""
208 """""""""""""""""""""""""
209
209
210 Mercurial has the ability to add new features through the use of
210 Mercurial has the ability to add new features through the use of
211 extensions. Extensions may add new commands, add options to existing
211 extensions. Extensions may add new commands, add options to existing
212 commands, change the default behavior of commands, or implement hooks.
212 commands, change the default behavior of commands, or implement hooks.
213
213
214 To enable the "foo" extension, either shipped with Mercurial or in the
214 To enable the "foo" extension, either shipped with Mercurial or in the
215 Python search path, create an entry for it in your configuration file,
215 Python search path, create an entry for it in your configuration file,
216 like this:
216 like this:
217
217
218 [extensions]
218 [extensions]
219 foo =
219 foo =
220
220
221 You may also specify the full path to an extension:
221 You may also specify the full path to an extension:
222
222
223 [extensions]
223 [extensions]
224 myfeature = ~/.hgext/myfeature.py
224 myfeature = ~/.hgext/myfeature.py
225
225
226 See 'hg help config' for more information on configuration files.
226 See 'hg help config' for more information on configuration files.
227
227
228 Extensions are not loaded by default for a variety of reasons: they can
228 Extensions are not loaded by default for a variety of reasons: they can
229 increase startup overhead; they may be meant for advanced usage only; they
229 increase startup overhead; they may be meant for advanced usage only; they
230 may provide potentially dangerous abilities (such as letting you destroy
230 may provide potentially dangerous abilities (such as letting you destroy
231 or modify history); they might not be ready for prime time; or they may
231 or modify history); they might not be ready for prime time; or they may
232 alter some usual behaviors of stock Mercurial. It is thus up to the user
232 alter some usual behaviors of stock Mercurial. It is thus up to the user
233 to activate extensions as needed.
233 to activate extensions as needed.
234
234
235 To explicitly disable an extension enabled in a configuration file of
235 To explicitly disable an extension enabled in a configuration file of
236 broader scope, prepend its path with !:
236 broader scope, prepend its path with !:
237
237
238 [extensions]
238 [extensions]
239 # disabling extension bar residing in /path/to/extension/bar.py
239 # disabling extension bar residing in /path/to/extension/bar.py
240 bar = !/path/to/extension/bar.py
240 bar = !/path/to/extension/bar.py
241 # ditto, but no path was supplied for extension baz
241 # ditto, but no path was supplied for extension baz
242 baz = !
242 baz = !
243
243
244 enabled extensions:
244 enabled extensions:
245
245
246 children command to display child changesets (DEPRECATED)
246 children command to display child changesets (DEPRECATED)
247 rebase command to move sets of revisions to a different ancestor
247 rebase command to move sets of revisions to a different ancestor
248
248
249 disabled extensions:
249 disabled extensions:
250
250
251 acl hooks for controlling repository access
251 acl hooks for controlling repository access
252 blackbox log repository events to a blackbox for debugging
252 blackbox log repository events to a blackbox for debugging
253 bugzilla hooks for integrating with the Bugzilla bug tracker
253 bugzilla hooks for integrating with the Bugzilla bug tracker
254 censor erase file content at a given revision
254 censor erase file content at a given revision
255 churn command to display statistics about repository history
255 churn command to display statistics about repository history
256 clonebundles advertise pre-generated bundles to seed clones
256 clonebundles advertise pre-generated bundles to seed clones
257 commitextras adds a new flag extras to commit
257 convert import revisions from foreign VCS repositories into
258 convert import revisions from foreign VCS repositories into
258 Mercurial
259 Mercurial
259 eol automatically manage newlines in repository files
260 eol automatically manage newlines in repository files
260 extdiff command to allow external programs to compare revisions
261 extdiff command to allow external programs to compare revisions
261 factotum http authentication with factotum
262 factotum http authentication with factotum
262 gpg commands to sign and verify changesets
263 gpg commands to sign and verify changesets
263 hgk browse the repository in a graphical way
264 hgk browse the repository in a graphical way
264 highlight syntax highlighting for hgweb (requires Pygments)
265 highlight syntax highlighting for hgweb (requires Pygments)
265 histedit interactive history editing
266 histedit interactive history editing
266 keyword expand keywords in tracked files
267 keyword expand keywords in tracked files
267 largefiles track large binary files
268 largefiles track large binary files
268 mq manage a stack of patches
269 mq manage a stack of patches
269 notify hooks for sending email push notifications
270 notify hooks for sending email push notifications
270 patchbomb command to send changesets as (a series of) patch emails
271 patchbomb command to send changesets as (a series of) patch emails
271 purge command to delete untracked files from the working
272 purge command to delete untracked files from the working
272 directory
273 directory
273 relink recreates hardlinks between repository clones
274 relink recreates hardlinks between repository clones
274 schemes extend schemes with shortcuts to repository swarms
275 schemes extend schemes with shortcuts to repository swarms
275 share share a common history between several working directories
276 share share a common history between several working directories
276 shelve save and restore changes to the working directory
277 shelve save and restore changes to the working directory
277 strip strip changesets and their descendants from history
278 strip strip changesets and their descendants from history
278 transplant command to transplant changesets from another branch
279 transplant command to transplant changesets from another branch
279 win32mbcs allow the use of MBCS paths with problematic encodings
280 win32mbcs allow the use of MBCS paths with problematic encodings
280 zeroconf discover and advertise repositories on the local network
281 zeroconf discover and advertise repositories on the local network
281
282
282 Verify that extension keywords appear in help templates
283 Verify that extension keywords appear in help templates
283
284
284 $ hg help --config extensions.transplant= templating|grep transplant > /dev/null
285 $ hg help --config extensions.transplant= templating|grep transplant > /dev/null
285
286
286 Test short command list with verbose option
287 Test short command list with verbose option
287
288
288 $ hg -v help shortlist
289 $ hg -v help shortlist
289 Mercurial Distributed SCM
290 Mercurial Distributed SCM
290
291
291 basic commands:
292 basic commands:
292
293
293 add add the specified files on the next commit
294 add add the specified files on the next commit
294 annotate, blame
295 annotate, blame
295 show changeset information by line for each file
296 show changeset information by line for each file
296 clone make a copy of an existing repository
297 clone make a copy of an existing repository
297 commit, ci commit the specified files or all outstanding changes
298 commit, ci commit the specified files or all outstanding changes
298 diff diff repository (or selected files)
299 diff diff repository (or selected files)
299 export dump the header and diffs for one or more changesets
300 export dump the header and diffs for one or more changesets
300 forget forget the specified files on the next commit
301 forget forget the specified files on the next commit
301 init create a new repository in the given directory
302 init create a new repository in the given directory
302 log, history show revision history of entire repository or files
303 log, history show revision history of entire repository or files
303 merge merge another revision into working directory
304 merge merge another revision into working directory
304 pull pull changes from the specified source
305 pull pull changes from the specified source
305 push push changes to the specified destination
306 push push changes to the specified destination
306 remove, rm remove the specified files on the next commit
307 remove, rm remove the specified files on the next commit
307 serve start stand-alone webserver
308 serve start stand-alone webserver
308 status, st show changed files in the working directory
309 status, st show changed files in the working directory
309 summary, sum summarize working directory state
310 summary, sum summarize working directory state
310 update, up, checkout, co
311 update, up, checkout, co
311 update working directory (or switch revisions)
312 update working directory (or switch revisions)
312
313
313 global options ([+] can be repeated):
314 global options ([+] can be repeated):
314
315
315 -R --repository REPO repository root directory or name of overlay bundle
316 -R --repository REPO repository root directory or name of overlay bundle
316 file
317 file
317 --cwd DIR change working directory
318 --cwd DIR change working directory
318 -y --noninteractive do not prompt, automatically pick the first choice for
319 -y --noninteractive do not prompt, automatically pick the first choice for
319 all prompts
320 all prompts
320 -q --quiet suppress output
321 -q --quiet suppress output
321 -v --verbose enable additional output
322 -v --verbose enable additional output
322 --color TYPE when to colorize (boolean, always, auto, never, or
323 --color TYPE when to colorize (boolean, always, auto, never, or
323 debug)
324 debug)
324 --config CONFIG [+] set/override config option (use 'section.name=value')
325 --config CONFIG [+] set/override config option (use 'section.name=value')
325 --debug enable debugging output
326 --debug enable debugging output
326 --debugger start debugger
327 --debugger start debugger
327 --encoding ENCODE set the charset encoding (default: ascii)
328 --encoding ENCODE set the charset encoding (default: ascii)
328 --encodingmode MODE set the charset encoding mode (default: strict)
329 --encodingmode MODE set the charset encoding mode (default: strict)
329 --traceback always print a traceback on exception
330 --traceback always print a traceback on exception
330 --time time how long the command takes
331 --time time how long the command takes
331 --profile print command execution profile
332 --profile print command execution profile
332 --version output version information and exit
333 --version output version information and exit
333 -h --help display help and exit
334 -h --help display help and exit
334 --hidden consider hidden changesets
335 --hidden consider hidden changesets
335 --pager TYPE when to paginate (boolean, always, auto, or never)
336 --pager TYPE when to paginate (boolean, always, auto, or never)
336 (default: auto)
337 (default: auto)
337
338
338 (use 'hg help' for the full list of commands)
339 (use 'hg help' for the full list of commands)
339
340
340 $ hg add -h
341 $ hg add -h
341 hg add [OPTION]... [FILE]...
342 hg add [OPTION]... [FILE]...
342
343
343 add the specified files on the next commit
344 add the specified files on the next commit
344
345
345 Schedule files to be version controlled and added to the repository.
346 Schedule files to be version controlled and added to the repository.
346
347
347 The files will be added to the repository at the next commit. To undo an
348 The files will be added to the repository at the next commit. To undo an
348 add before that, see 'hg forget'.
349 add before that, see 'hg forget'.
349
350
350 If no names are given, add all files to the repository (except files
351 If no names are given, add all files to the repository (except files
351 matching ".hgignore").
352 matching ".hgignore").
352
353
353 Returns 0 if all files are successfully added.
354 Returns 0 if all files are successfully added.
354
355
355 options ([+] can be repeated):
356 options ([+] can be repeated):
356
357
357 -I --include PATTERN [+] include names matching the given patterns
358 -I --include PATTERN [+] include names matching the given patterns
358 -X --exclude PATTERN [+] exclude names matching the given patterns
359 -X --exclude PATTERN [+] exclude names matching the given patterns
359 -S --subrepos recurse into subrepositories
360 -S --subrepos recurse into subrepositories
360 -n --dry-run do not perform actions, just print output
361 -n --dry-run do not perform actions, just print output
361
362
362 (some details hidden, use --verbose to show complete help)
363 (some details hidden, use --verbose to show complete help)
363
364
364 Verbose help for add
365 Verbose help for add
365
366
366 $ hg add -hv
367 $ hg add -hv
367 hg add [OPTION]... [FILE]...
368 hg add [OPTION]... [FILE]...
368
369
369 add the specified files on the next commit
370 add the specified files on the next commit
370
371
371 Schedule files to be version controlled and added to the repository.
372 Schedule files to be version controlled and added to the repository.
372
373
373 The files will be added to the repository at the next commit. To undo an
374 The files will be added to the repository at the next commit. To undo an
374 add before that, see 'hg forget'.
375 add before that, see 'hg forget'.
375
376
376 If no names are given, add all files to the repository (except files
377 If no names are given, add all files to the repository (except files
377 matching ".hgignore").
378 matching ".hgignore").
378
379
379 Examples:
380 Examples:
380
381
381 - New (unknown) files are added automatically by 'hg add':
382 - New (unknown) files are added automatically by 'hg add':
382
383
383 $ ls
384 $ ls
384 foo.c
385 foo.c
385 $ hg status
386 $ hg status
386 ? foo.c
387 ? foo.c
387 $ hg add
388 $ hg add
388 adding foo.c
389 adding foo.c
389 $ hg status
390 $ hg status
390 A foo.c
391 A foo.c
391
392
392 - Specific files to be added can be specified:
393 - Specific files to be added can be specified:
393
394
394 $ ls
395 $ ls
395 bar.c foo.c
396 bar.c foo.c
396 $ hg status
397 $ hg status
397 ? bar.c
398 ? bar.c
398 ? foo.c
399 ? foo.c
399 $ hg add bar.c
400 $ hg add bar.c
400 $ hg status
401 $ hg status
401 A bar.c
402 A bar.c
402 ? foo.c
403 ? foo.c
403
404
404 Returns 0 if all files are successfully added.
405 Returns 0 if all files are successfully added.
405
406
406 options ([+] can be repeated):
407 options ([+] can be repeated):
407
408
408 -I --include PATTERN [+] include names matching the given patterns
409 -I --include PATTERN [+] include names matching the given patterns
409 -X --exclude PATTERN [+] exclude names matching the given patterns
410 -X --exclude PATTERN [+] exclude names matching the given patterns
410 -S --subrepos recurse into subrepositories
411 -S --subrepos recurse into subrepositories
411 -n --dry-run do not perform actions, just print output
412 -n --dry-run do not perform actions, just print output
412
413
413 global options ([+] can be repeated):
414 global options ([+] can be repeated):
414
415
415 -R --repository REPO repository root directory or name of overlay bundle
416 -R --repository REPO repository root directory or name of overlay bundle
416 file
417 file
417 --cwd DIR change working directory
418 --cwd DIR change working directory
418 -y --noninteractive do not prompt, automatically pick the first choice for
419 -y --noninteractive do not prompt, automatically pick the first choice for
419 all prompts
420 all prompts
420 -q --quiet suppress output
421 -q --quiet suppress output
421 -v --verbose enable additional output
422 -v --verbose enable additional output
422 --color TYPE when to colorize (boolean, always, auto, never, or
423 --color TYPE when to colorize (boolean, always, auto, never, or
423 debug)
424 debug)
424 --config CONFIG [+] set/override config option (use 'section.name=value')
425 --config CONFIG [+] set/override config option (use 'section.name=value')
425 --debug enable debugging output
426 --debug enable debugging output
426 --debugger start debugger
427 --debugger start debugger
427 --encoding ENCODE set the charset encoding (default: ascii)
428 --encoding ENCODE set the charset encoding (default: ascii)
428 --encodingmode MODE set the charset encoding mode (default: strict)
429 --encodingmode MODE set the charset encoding mode (default: strict)
429 --traceback always print a traceback on exception
430 --traceback always print a traceback on exception
430 --time time how long the command takes
431 --time time how long the command takes
431 --profile print command execution profile
432 --profile print command execution profile
432 --version output version information and exit
433 --version output version information and exit
433 -h --help display help and exit
434 -h --help display help and exit
434 --hidden consider hidden changesets
435 --hidden consider hidden changesets
435 --pager TYPE when to paginate (boolean, always, auto, or never)
436 --pager TYPE when to paginate (boolean, always, auto, or never)
436 (default: auto)
437 (default: auto)
437
438
438 Test the textwidth config option
439 Test the textwidth config option
439
440
440 $ hg root -h --config ui.textwidth=50
441 $ hg root -h --config ui.textwidth=50
441 hg root
442 hg root
442
443
443 print the root (top) of the current working
444 print the root (top) of the current working
444 directory
445 directory
445
446
446 Print the root directory of the current
447 Print the root directory of the current
447 repository.
448 repository.
448
449
449 Returns 0 on success.
450 Returns 0 on success.
450
451
451 (some details hidden, use --verbose to show
452 (some details hidden, use --verbose to show
452 complete help)
453 complete help)
453
454
454 Test help option with version option
455 Test help option with version option
455
456
456 $ hg add -h --version
457 $ hg add -h --version
457 Mercurial Distributed SCM (version *) (glob)
458 Mercurial Distributed SCM (version *) (glob)
458 (see https://mercurial-scm.org for more information)
459 (see https://mercurial-scm.org for more information)
459
460
460 Copyright (C) 2005-* Matt Mackall and others (glob)
461 Copyright (C) 2005-* Matt Mackall and others (glob)
461 This is free software; see the source for copying conditions. There is NO
462 This is free software; see the source for copying conditions. There is NO
462 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
463 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
463
464
464 $ hg add --skjdfks
465 $ hg add --skjdfks
465 hg add: option --skjdfks not recognized
466 hg add: option --skjdfks not recognized
466 hg add [OPTION]... [FILE]...
467 hg add [OPTION]... [FILE]...
467
468
468 add the specified files on the next commit
469 add the specified files on the next commit
469
470
470 options ([+] can be repeated):
471 options ([+] can be repeated):
471
472
472 -I --include PATTERN [+] include names matching the given patterns
473 -I --include PATTERN [+] include names matching the given patterns
473 -X --exclude PATTERN [+] exclude names matching the given patterns
474 -X --exclude PATTERN [+] exclude names matching the given patterns
474 -S --subrepos recurse into subrepositories
475 -S --subrepos recurse into subrepositories
475 -n --dry-run do not perform actions, just print output
476 -n --dry-run do not perform actions, just print output
476
477
477 (use 'hg add -h' to show more help)
478 (use 'hg add -h' to show more help)
478 [255]
479 [255]
479
480
480 Test ambiguous command help
481 Test ambiguous command help
481
482
482 $ hg help ad
483 $ hg help ad
483 list of commands:
484 list of commands:
484
485
485 add add the specified files on the next commit
486 add add the specified files on the next commit
486 addremove add all new files, delete all missing files
487 addremove add all new files, delete all missing files
487
488
488 (use 'hg help -v ad' to show built-in aliases and global options)
489 (use 'hg help -v ad' to show built-in aliases and global options)
489
490
490 Test command without options
491 Test command without options
491
492
492 $ hg help verify
493 $ hg help verify
493 hg verify
494 hg verify
494
495
495 verify the integrity of the repository
496 verify the integrity of the repository
496
497
497 Verify the integrity of the current repository.
498 Verify the integrity of the current repository.
498
499
499 This will perform an extensive check of the repository's integrity,
500 This will perform an extensive check of the repository's integrity,
500 validating the hashes and checksums of each entry in the changelog,
501 validating the hashes and checksums of each entry in the changelog,
501 manifest, and tracked files, as well as the integrity of their crosslinks
502 manifest, and tracked files, as well as the integrity of their crosslinks
502 and indices.
503 and indices.
503
504
504 Please see https://mercurial-scm.org/wiki/RepositoryCorruption for more
505 Please see https://mercurial-scm.org/wiki/RepositoryCorruption for more
505 information about recovery from corruption of the repository.
506 information about recovery from corruption of the repository.
506
507
507 Returns 0 on success, 1 if errors are encountered.
508 Returns 0 on success, 1 if errors are encountered.
508
509
509 (some details hidden, use --verbose to show complete help)
510 (some details hidden, use --verbose to show complete help)
510
511
511 $ hg help diff
512 $ hg help diff
512 hg diff [OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...
513 hg diff [OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...
513
514
514 diff repository (or selected files)
515 diff repository (or selected files)
515
516
516 Show differences between revisions for the specified files.
517 Show differences between revisions for the specified files.
517
518
518 Differences between files are shown using the unified diff format.
519 Differences between files are shown using the unified diff format.
519
520
520 Note:
521 Note:
521 'hg diff' may generate unexpected results for merges, as it will
522 'hg diff' may generate unexpected results for merges, as it will
522 default to comparing against the working directory's first parent
523 default to comparing against the working directory's first parent
523 changeset if no revisions are specified.
524 changeset if no revisions are specified.
524
525
525 When two revision arguments are given, then changes are shown between
526 When two revision arguments are given, then changes are shown between
526 those revisions. If only one revision is specified then that revision is
527 those revisions. If only one revision is specified then that revision is
527 compared to the working directory, and, when no revisions are specified,
528 compared to the working directory, and, when no revisions are specified,
528 the working directory files are compared to its first parent.
529 the working directory files are compared to its first parent.
529
530
530 Alternatively you can specify -c/--change with a revision to see the
531 Alternatively you can specify -c/--change with a revision to see the
531 changes in that changeset relative to its first parent.
532 changes in that changeset relative to its first parent.
532
533
533 Without the -a/--text option, diff will avoid generating diffs of files it
534 Without the -a/--text option, diff will avoid generating diffs of files it
534 detects as binary. With -a, diff will generate a diff anyway, probably
535 detects as binary. With -a, diff will generate a diff anyway, probably
535 with undesirable results.
536 with undesirable results.
536
537
537 Use the -g/--git option to generate diffs in the git extended diff format.
538 Use the -g/--git option to generate diffs in the git extended diff format.
538 For more information, read 'hg help diffs'.
539 For more information, read 'hg help diffs'.
539
540
540 Returns 0 on success.
541 Returns 0 on success.
541
542
542 options ([+] can be repeated):
543 options ([+] can be repeated):
543
544
544 -r --rev REV [+] revision
545 -r --rev REV [+] revision
545 -c --change REV change made by revision
546 -c --change REV change made by revision
546 -a --text treat all files as text
547 -a --text treat all files as text
547 -g --git use git extended diff format
548 -g --git use git extended diff format
548 --binary generate binary diffs in git mode (default)
549 --binary generate binary diffs in git mode (default)
549 --nodates omit dates from diff headers
550 --nodates omit dates from diff headers
550 --noprefix omit a/ and b/ prefixes from filenames
551 --noprefix omit a/ and b/ prefixes from filenames
551 -p --show-function show which function each change is in
552 -p --show-function show which function each change is in
552 --reverse produce a diff that undoes the changes
553 --reverse produce a diff that undoes the changes
553 -w --ignore-all-space ignore white space when comparing lines
554 -w --ignore-all-space ignore white space when comparing lines
554 -b --ignore-space-change ignore changes in the amount of white space
555 -b --ignore-space-change ignore changes in the amount of white space
555 -B --ignore-blank-lines ignore changes whose lines are all blank
556 -B --ignore-blank-lines ignore changes whose lines are all blank
556 -U --unified NUM number of lines of context to show
557 -U --unified NUM number of lines of context to show
557 --stat output diffstat-style summary of changes
558 --stat output diffstat-style summary of changes
558 --root DIR produce diffs relative to subdirectory
559 --root DIR produce diffs relative to subdirectory
559 -I --include PATTERN [+] include names matching the given patterns
560 -I --include PATTERN [+] include names matching the given patterns
560 -X --exclude PATTERN [+] exclude names matching the given patterns
561 -X --exclude PATTERN [+] exclude names matching the given patterns
561 -S --subrepos recurse into subrepositories
562 -S --subrepos recurse into subrepositories
562
563
563 (some details hidden, use --verbose to show complete help)
564 (some details hidden, use --verbose to show complete help)
564
565
565 $ hg help status
566 $ hg help status
566 hg status [OPTION]... [FILE]...
567 hg status [OPTION]... [FILE]...
567
568
568 aliases: st
569 aliases: st
569
570
570 show changed files in the working directory
571 show changed files in the working directory
571
572
572 Show status of files in the repository. If names are given, only files
573 Show status of files in the repository. If names are given, only files
573 that match are shown. Files that are clean or ignored or the source of a
574 that match are shown. Files that are clean or ignored or the source of a
574 copy/move operation, are not listed unless -c/--clean, -i/--ignored,
575 copy/move operation, are not listed unless -c/--clean, -i/--ignored,
575 -C/--copies or -A/--all are given. Unless options described with "show
576 -C/--copies or -A/--all are given. Unless options described with "show
576 only ..." are given, the options -mardu are used.
577 only ..." are given, the options -mardu are used.
577
578
578 Option -q/--quiet hides untracked (unknown and ignored) files unless
579 Option -q/--quiet hides untracked (unknown and ignored) files unless
579 explicitly requested with -u/--unknown or -i/--ignored.
580 explicitly requested with -u/--unknown or -i/--ignored.
580
581
581 Note:
582 Note:
582 'hg status' may appear to disagree with diff if permissions have
583 'hg status' may appear to disagree with diff if permissions have
583 changed or a merge has occurred. The standard diff format does not
584 changed or a merge has occurred. The standard diff format does not
584 report permission changes and diff only reports changes relative to one
585 report permission changes and diff only reports changes relative to one
585 merge parent.
586 merge parent.
586
587
587 If one revision is given, it is used as the base revision. If two
588 If one revision is given, it is used as the base revision. If two
588 revisions are given, the differences between them are shown. The --change
589 revisions are given, the differences between them are shown. The --change
589 option can also be used as a shortcut to list the changed files of a
590 option can also be used as a shortcut to list the changed files of a
590 revision from its first parent.
591 revision from its first parent.
591
592
592 The codes used to show the status of files are:
593 The codes used to show the status of files are:
593
594
594 M = modified
595 M = modified
595 A = added
596 A = added
596 R = removed
597 R = removed
597 C = clean
598 C = clean
598 ! = missing (deleted by non-hg command, but still tracked)
599 ! = missing (deleted by non-hg command, but still tracked)
599 ? = not tracked
600 ? = not tracked
600 I = ignored
601 I = ignored
601 = origin of the previous file (with --copies)
602 = origin of the previous file (with --copies)
602
603
603 Returns 0 on success.
604 Returns 0 on success.
604
605
605 options ([+] can be repeated):
606 options ([+] can be repeated):
606
607
607 -A --all show status of all files
608 -A --all show status of all files
608 -m --modified show only modified files
609 -m --modified show only modified files
609 -a --added show only added files
610 -a --added show only added files
610 -r --removed show only removed files
611 -r --removed show only removed files
611 -d --deleted show only deleted (but tracked) files
612 -d --deleted show only deleted (but tracked) files
612 -c --clean show only files without changes
613 -c --clean show only files without changes
613 -u --unknown show only unknown (not tracked) files
614 -u --unknown show only unknown (not tracked) files
614 -i --ignored show only ignored files
615 -i --ignored show only ignored files
615 -n --no-status hide status prefix
616 -n --no-status hide status prefix
616 -C --copies show source of copied files
617 -C --copies show source of copied files
617 -0 --print0 end filenames with NUL, for use with xargs
618 -0 --print0 end filenames with NUL, for use with xargs
618 --rev REV [+] show difference from revision
619 --rev REV [+] show difference from revision
619 --change REV list the changed files of a revision
620 --change REV list the changed files of a revision
620 -I --include PATTERN [+] include names matching the given patterns
621 -I --include PATTERN [+] include names matching the given patterns
621 -X --exclude PATTERN [+] exclude names matching the given patterns
622 -X --exclude PATTERN [+] exclude names matching the given patterns
622 -S --subrepos recurse into subrepositories
623 -S --subrepos recurse into subrepositories
623
624
624 (some details hidden, use --verbose to show complete help)
625 (some details hidden, use --verbose to show complete help)
625
626
626 $ hg -q help status
627 $ hg -q help status
627 hg status [OPTION]... [FILE]...
628 hg status [OPTION]... [FILE]...
628
629
629 show changed files in the working directory
630 show changed files in the working directory
630
631
631 $ hg help foo
632 $ hg help foo
632 abort: no such help topic: foo
633 abort: no such help topic: foo
633 (try 'hg help --keyword foo')
634 (try 'hg help --keyword foo')
634 [255]
635 [255]
635
636
636 $ hg skjdfks
637 $ hg skjdfks
637 hg: unknown command 'skjdfks'
638 hg: unknown command 'skjdfks'
638 Mercurial Distributed SCM
639 Mercurial Distributed SCM
639
640
640 basic commands:
641 basic commands:
641
642
642 add add the specified files on the next commit
643 add add the specified files on the next commit
643 annotate show changeset information by line for each file
644 annotate show changeset information by line for each file
644 clone make a copy of an existing repository
645 clone make a copy of an existing repository
645 commit commit the specified files or all outstanding changes
646 commit commit the specified files or all outstanding changes
646 diff diff repository (or selected files)
647 diff diff repository (or selected files)
647 export dump the header and diffs for one or more changesets
648 export dump the header and diffs for one or more changesets
648 forget forget the specified files on the next commit
649 forget forget the specified files on the next commit
649 init create a new repository in the given directory
650 init create a new repository in the given directory
650 log show revision history of entire repository or files
651 log show revision history of entire repository or files
651 merge merge another revision into working directory
652 merge merge another revision into working directory
652 pull pull changes from the specified source
653 pull pull changes from the specified source
653 push push changes to the specified destination
654 push push changes to the specified destination
654 remove remove the specified files on the next commit
655 remove remove the specified files on the next commit
655 serve start stand-alone webserver
656 serve start stand-alone webserver
656 status show changed files in the working directory
657 status show changed files in the working directory
657 summary summarize working directory state
658 summary summarize working directory state
658 update update working directory (or switch revisions)
659 update update working directory (or switch revisions)
659
660
660 (use 'hg help' for the full list of commands or 'hg -v' for details)
661 (use 'hg help' for the full list of commands or 'hg -v' for details)
661 [255]
662 [255]
662
663
663 Typoed command gives suggestion
664 Typoed command gives suggestion
664 $ hg puls
665 $ hg puls
665 hg: unknown command 'puls'
666 hg: unknown command 'puls'
666 (did you mean one of pull, push?)
667 (did you mean one of pull, push?)
667 [255]
668 [255]
668
669
669 Not enabled extension gets suggested
670 Not enabled extension gets suggested
670
671
671 $ hg rebase
672 $ hg rebase
672 hg: unknown command 'rebase'
673 hg: unknown command 'rebase'
673 'rebase' is provided by the following extension:
674 'rebase' is provided by the following extension:
674
675
675 rebase command to move sets of revisions to a different ancestor
676 rebase command to move sets of revisions to a different ancestor
676
677
677 (use 'hg help extensions' for information on enabling extensions)
678 (use 'hg help extensions' for information on enabling extensions)
678 [255]
679 [255]
679
680
680 Disabled extension gets suggested
681 Disabled extension gets suggested
681 $ hg --config extensions.rebase=! rebase
682 $ hg --config extensions.rebase=! rebase
682 hg: unknown command 'rebase'
683 hg: unknown command 'rebase'
683 'rebase' is provided by the following extension:
684 'rebase' is provided by the following extension:
684
685
685 rebase command to move sets of revisions to a different ancestor
686 rebase command to move sets of revisions to a different ancestor
686
687
687 (use 'hg help extensions' for information on enabling extensions)
688 (use 'hg help extensions' for information on enabling extensions)
688 [255]
689 [255]
689
690
690 Make sure that we don't run afoul of the help system thinking that
691 Make sure that we don't run afoul of the help system thinking that
691 this is a section and erroring out weirdly.
692 this is a section and erroring out weirdly.
692
693
693 $ hg .log
694 $ hg .log
694 hg: unknown command '.log'
695 hg: unknown command '.log'
695 (did you mean log?)
696 (did you mean log?)
696 [255]
697 [255]
697
698
698 $ hg log.
699 $ hg log.
699 hg: unknown command 'log.'
700 hg: unknown command 'log.'
700 (did you mean log?)
701 (did you mean log?)
701 [255]
702 [255]
702 $ hg pu.lh
703 $ hg pu.lh
703 hg: unknown command 'pu.lh'
704 hg: unknown command 'pu.lh'
704 (did you mean one of pull, push?)
705 (did you mean one of pull, push?)
705 [255]
706 [255]
706
707
707 $ cat > helpext.py <<EOF
708 $ cat > helpext.py <<EOF
708 > import os
709 > import os
709 > from mercurial import commands, registrar
710 > from mercurial import commands, registrar
710 >
711 >
711 > cmdtable = {}
712 > cmdtable = {}
712 > command = registrar.command(cmdtable)
713 > command = registrar.command(cmdtable)
713 >
714 >
714 > @command(b'nohelp',
715 > @command(b'nohelp',
715 > [(b'', b'longdesc', 3, b'x'*90),
716 > [(b'', b'longdesc', 3, b'x'*90),
716 > (b'n', b'', None, b'normal desc'),
717 > (b'n', b'', None, b'normal desc'),
717 > (b'', b'newline', b'', b'line1\nline2')],
718 > (b'', b'newline', b'', b'line1\nline2')],
718 > b'hg nohelp',
719 > b'hg nohelp',
719 > norepo=True)
720 > norepo=True)
720 > @command(b'debugoptADV', [(b'', b'aopt', None, b'option is (ADVANCED)')])
721 > @command(b'debugoptADV', [(b'', b'aopt', None, b'option is (ADVANCED)')])
721 > @command(b'debugoptDEP', [(b'', b'dopt', None, b'option is (DEPRECATED)')])
722 > @command(b'debugoptDEP', [(b'', b'dopt', None, b'option is (DEPRECATED)')])
722 > @command(b'debugoptEXP', [(b'', b'eopt', None, b'option is (EXPERIMENTAL)')])
723 > @command(b'debugoptEXP', [(b'', b'eopt', None, b'option is (EXPERIMENTAL)')])
723 > def nohelp(ui, *args, **kwargs):
724 > def nohelp(ui, *args, **kwargs):
724 > pass
725 > pass
725 >
726 >
726 > def uisetup(ui):
727 > def uisetup(ui):
727 > ui.setconfig(b'alias', b'shellalias', b'!echo hi', b'helpext')
728 > ui.setconfig(b'alias', b'shellalias', b'!echo hi', b'helpext')
728 > ui.setconfig(b'alias', b'hgalias', b'summary', b'helpext')
729 > ui.setconfig(b'alias', b'hgalias', b'summary', b'helpext')
729 >
730 >
730 > EOF
731 > EOF
731 $ echo '[extensions]' >> $HGRCPATH
732 $ echo '[extensions]' >> $HGRCPATH
732 $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
733 $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
733
734
734 Test for aliases
735 Test for aliases
735
736
736 $ hg help hgalias
737 $ hg help hgalias
737 hg hgalias [--remote]
738 hg hgalias [--remote]
738
739
739 alias for: hg summary
740 alias for: hg summary
740
741
741 summarize working directory state
742 summarize working directory state
742
743
743 This generates a brief summary of the working directory state, including
744 This generates a brief summary of the working directory state, including
744 parents, branch, commit status, phase and available updates.
745 parents, branch, commit status, phase and available updates.
745
746
746 With the --remote option, this will check the default paths for incoming
747 With the --remote option, this will check the default paths for incoming
747 and outgoing changes. This can be time-consuming.
748 and outgoing changes. This can be time-consuming.
748
749
749 Returns 0 on success.
750 Returns 0 on success.
750
751
751 defined by: helpext
752 defined by: helpext
752
753
753 options:
754 options:
754
755
755 --remote check for push and pull
756 --remote check for push and pull
756
757
757 (some details hidden, use --verbose to show complete help)
758 (some details hidden, use --verbose to show complete help)
758
759
759 $ hg help shellalias
760 $ hg help shellalias
760 hg shellalias
761 hg shellalias
761
762
762 shell alias for:
763 shell alias for:
763
764
764 echo hi
765 echo hi
765
766
766 defined by: helpext
767 defined by: helpext
767
768
768 (some details hidden, use --verbose to show complete help)
769 (some details hidden, use --verbose to show complete help)
769
770
770 Test command with no help text
771 Test command with no help text
771
772
772 $ hg help nohelp
773 $ hg help nohelp
773 hg nohelp
774 hg nohelp
774
775
775 (no help text available)
776 (no help text available)
776
777
777 options:
778 options:
778
779
779 --longdesc VALUE xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
780 --longdesc VALUE xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
780 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (default: 3)
781 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (default: 3)
781 -n -- normal desc
782 -n -- normal desc
782 --newline VALUE line1 line2
783 --newline VALUE line1 line2
783
784
784 (some details hidden, use --verbose to show complete help)
785 (some details hidden, use --verbose to show complete help)
785
786
786 $ hg help -k nohelp
787 $ hg help -k nohelp
787 Commands:
788 Commands:
788
789
789 nohelp hg nohelp
790 nohelp hg nohelp
790
791
791 Extension Commands:
792 Extension Commands:
792
793
793 nohelp (no help text available)
794 nohelp (no help text available)
794
795
795 Test that default list of commands omits extension commands
796 Test that default list of commands omits extension commands
796
797
797 $ hg help
798 $ hg help
798 Mercurial Distributed SCM
799 Mercurial Distributed SCM
799
800
800 list of commands:
801 list of commands:
801
802
802 add add the specified files on the next commit
803 add add the specified files on the next commit
803 addremove add all new files, delete all missing files
804 addremove add all new files, delete all missing files
804 annotate show changeset information by line for each file
805 annotate show changeset information by line for each file
805 archive create an unversioned archive of a repository revision
806 archive create an unversioned archive of a repository revision
806 backout reverse effect of earlier changeset
807 backout reverse effect of earlier changeset
807 bisect subdivision search of changesets
808 bisect subdivision search of changesets
808 bookmarks create a new bookmark or list existing bookmarks
809 bookmarks create a new bookmark or list existing bookmarks
809 branch set or show the current branch name
810 branch set or show the current branch name
810 branches list repository named branches
811 branches list repository named branches
811 bundle create a bundle file
812 bundle create a bundle file
812 cat output the current or given revision of files
813 cat output the current or given revision of files
813 clone make a copy of an existing repository
814 clone make a copy of an existing repository
814 commit commit the specified files or all outstanding changes
815 commit commit the specified files or all outstanding changes
815 config show combined config settings from all hgrc files
816 config show combined config settings from all hgrc files
816 copy mark files as copied for the next commit
817 copy mark files as copied for the next commit
817 diff diff repository (or selected files)
818 diff diff repository (or selected files)
818 export dump the header and diffs for one or more changesets
819 export dump the header and diffs for one or more changesets
819 files list tracked files
820 files list tracked files
820 forget forget the specified files on the next commit
821 forget forget the specified files on the next commit
821 graft copy changes from other branches onto the current branch
822 graft copy changes from other branches onto the current branch
822 grep search revision history for a pattern in specified files
823 grep search revision history for a pattern in specified files
823 heads show branch heads
824 heads show branch heads
824 help show help for a given topic or a help overview
825 help show help for a given topic or a help overview
825 identify identify the working directory or specified revision
826 identify identify the working directory or specified revision
826 import import an ordered set of patches
827 import import an ordered set of patches
827 incoming show new changesets found in source
828 incoming show new changesets found in source
828 init create a new repository in the given directory
829 init create a new repository in the given directory
829 log show revision history of entire repository or files
830 log show revision history of entire repository or files
830 manifest output the current or given revision of the project manifest
831 manifest output the current or given revision of the project manifest
831 merge merge another revision into working directory
832 merge merge another revision into working directory
832 outgoing show changesets not found in the destination
833 outgoing show changesets not found in the destination
833 paths show aliases for remote repositories
834 paths show aliases for remote repositories
834 phase set or show the current phase name
835 phase set or show the current phase name
835 pull pull changes from the specified source
836 pull pull changes from the specified source
836 push push changes to the specified destination
837 push push changes to the specified destination
837 recover roll back an interrupted transaction
838 recover roll back an interrupted transaction
838 remove remove the specified files on the next commit
839 remove remove the specified files on the next commit
839 rename rename files; equivalent of copy + remove
840 rename rename files; equivalent of copy + remove
840 resolve redo merges or set/view the merge status of files
841 resolve redo merges or set/view the merge status of files
841 revert restore files to their checkout state
842 revert restore files to their checkout state
842 root print the root (top) of the current working directory
843 root print the root (top) of the current working directory
843 serve start stand-alone webserver
844 serve start stand-alone webserver
844 status show changed files in the working directory
845 status show changed files in the working directory
845 summary summarize working directory state
846 summary summarize working directory state
846 tag add one or more tags for the current or given revision
847 tag add one or more tags for the current or given revision
847 tags list repository tags
848 tags list repository tags
848 unbundle apply one or more bundle files
849 unbundle apply one or more bundle files
849 update update working directory (or switch revisions)
850 update update working directory (or switch revisions)
850 verify verify the integrity of the repository
851 verify verify the integrity of the repository
851 version output version and copyright information
852 version output version and copyright information
852
853
853 enabled extensions:
854 enabled extensions:
854
855
855 helpext (no help text available)
856 helpext (no help text available)
856
857
857 additional help topics:
858 additional help topics:
858
859
859 bundlespec Bundle File Formats
860 bundlespec Bundle File Formats
860 color Colorizing Outputs
861 color Colorizing Outputs
861 config Configuration Files
862 config Configuration Files
862 dates Date Formats
863 dates Date Formats
863 diffs Diff Formats
864 diffs Diff Formats
864 environment Environment Variables
865 environment Environment Variables
865 extensions Using Additional Features
866 extensions Using Additional Features
866 filesets Specifying File Sets
867 filesets Specifying File Sets
867 glossary Glossary
868 glossary Glossary
868 hgignore Syntax for Mercurial Ignore Files
869 hgignore Syntax for Mercurial Ignore Files
869 hgweb Configuring hgweb
870 hgweb Configuring hgweb
870 internals Technical implementation topics
871 internals Technical implementation topics
871 merge-tools Merge Tools
872 merge-tools Merge Tools
872 pager Pager Support
873 pager Pager Support
873 patterns File Name Patterns
874 patterns File Name Patterns
874 phases Working with Phases
875 phases Working with Phases
875 revisions Specifying Revisions
876 revisions Specifying Revisions
876 scripting Using Mercurial from scripts and automation
877 scripting Using Mercurial from scripts and automation
877 subrepos Subrepositories
878 subrepos Subrepositories
878 templating Template Usage
879 templating Template Usage
879 urls URL Paths
880 urls URL Paths
880
881
881 (use 'hg help -v' to show built-in aliases and global options)
882 (use 'hg help -v' to show built-in aliases and global options)
882
883
883
884
884 Test list of internal help commands
885 Test list of internal help commands
885
886
886 $ hg help debug
887 $ hg help debug
887 debug commands (internal and unsupported):
888 debug commands (internal and unsupported):
888
889
889 debugancestor
890 debugancestor
890 find the ancestor revision of two revisions in a given index
891 find the ancestor revision of two revisions in a given index
891 debugapplystreamclonebundle
892 debugapplystreamclonebundle
892 apply a stream clone bundle file
893 apply a stream clone bundle file
893 debugbuilddag
894 debugbuilddag
894 builds a repo with a given DAG from scratch in the current
895 builds a repo with a given DAG from scratch in the current
895 empty repo
896 empty repo
896 debugbundle lists the contents of a bundle
897 debugbundle lists the contents of a bundle
897 debugcheckstate
898 debugcheckstate
898 validate the correctness of the current dirstate
899 validate the correctness of the current dirstate
899 debugcolor show available color, effects or style
900 debugcolor show available color, effects or style
900 debugcommands
901 debugcommands
901 list all available commands and options
902 list all available commands and options
902 debugcomplete
903 debugcomplete
903 returns the completion list associated with the given command
904 returns the completion list associated with the given command
904 debugcreatestreamclonebundle
905 debugcreatestreamclonebundle
905 create a stream clone bundle file
906 create a stream clone bundle file
906 debugdag format the changelog or an index DAG as a concise textual
907 debugdag format the changelog or an index DAG as a concise textual
907 description
908 description
908 debugdata dump the contents of a data file revision
909 debugdata dump the contents of a data file revision
909 debugdate parse and display a date
910 debugdate parse and display a date
910 debugdeltachain
911 debugdeltachain
911 dump information about delta chains in a revlog
912 dump information about delta chains in a revlog
912 debugdirstate
913 debugdirstate
913 show the contents of the current dirstate
914 show the contents of the current dirstate
914 debugdiscovery
915 debugdiscovery
915 runs the changeset discovery protocol in isolation
916 runs the changeset discovery protocol in isolation
916 debugextensions
917 debugextensions
917 show information about active extensions
918 show information about active extensions
918 debugfileset parse and apply a fileset specification
919 debugfileset parse and apply a fileset specification
919 debugfsinfo show information detected about current filesystem
920 debugfsinfo show information detected about current filesystem
920 debuggetbundle
921 debuggetbundle
921 retrieves a bundle from a repo
922 retrieves a bundle from a repo
922 debugignore display the combined ignore pattern and information about
923 debugignore display the combined ignore pattern and information about
923 ignored files
924 ignored files
924 debugindex dump the contents of an index file
925 debugindex dump the contents of an index file
925 debugindexdot
926 debugindexdot
926 dump an index DAG as a graphviz dot file
927 dump an index DAG as a graphviz dot file
927 debuginstall test Mercurial installation
928 debuginstall test Mercurial installation
928 debugknown test whether node ids are known to a repo
929 debugknown test whether node ids are known to a repo
929 debuglocks show or modify state of locks
930 debuglocks show or modify state of locks
930 debugmergestate
931 debugmergestate
931 print merge state
932 print merge state
932 debugnamecomplete
933 debugnamecomplete
933 complete "names" - tags, open branch names, bookmark names
934 complete "names" - tags, open branch names, bookmark names
934 debugobsolete
935 debugobsolete
935 create arbitrary obsolete marker
936 create arbitrary obsolete marker
936 debugoptADV (no help text available)
937 debugoptADV (no help text available)
937 debugoptDEP (no help text available)
938 debugoptDEP (no help text available)
938 debugoptEXP (no help text available)
939 debugoptEXP (no help text available)
939 debugpathcomplete
940 debugpathcomplete
940 complete part or all of a tracked path
941 complete part or all of a tracked path
941 debugpickmergetool
942 debugpickmergetool
942 examine which merge tool is chosen for specified file
943 examine which merge tool is chosen for specified file
943 debugpushkey access the pushkey key/value protocol
944 debugpushkey access the pushkey key/value protocol
944 debugpvec (no help text available)
945 debugpvec (no help text available)
945 debugrebuilddirstate
946 debugrebuilddirstate
946 rebuild the dirstate as it would look like for the given
947 rebuild the dirstate as it would look like for the given
947 revision
948 revision
948 debugrebuildfncache
949 debugrebuildfncache
949 rebuild the fncache file
950 rebuild the fncache file
950 debugrename dump rename information
951 debugrename dump rename information
951 debugrevlog show data and statistics about a revlog
952 debugrevlog show data and statistics about a revlog
952 debugrevspec parse and apply a revision specification
953 debugrevspec parse and apply a revision specification
953 debugsetparents
954 debugsetparents
954 manually set the parents of the current working directory
955 manually set the parents of the current working directory
955 debugssl test a secure connection to a server
956 debugssl test a secure connection to a server
956 debugsub (no help text available)
957 debugsub (no help text available)
957 debugsuccessorssets
958 debugsuccessorssets
958 show set of successors for revision
959 show set of successors for revision
959 debugtemplate
960 debugtemplate
960 parse and apply a template
961 parse and apply a template
961 debugupdatecaches
962 debugupdatecaches
962 warm all known caches in the repository
963 warm all known caches in the repository
963 debugupgraderepo
964 debugupgraderepo
964 upgrade a repository to use different features
965 upgrade a repository to use different features
965 debugwalk show how files match on given patterns
966 debugwalk show how files match on given patterns
966 debugwireargs
967 debugwireargs
967 (no help text available)
968 (no help text available)
968
969
969 (use 'hg help -v debug' to show built-in aliases and global options)
970 (use 'hg help -v debug' to show built-in aliases and global options)
970
971
971 internals topic renders index of available sub-topics
972 internals topic renders index of available sub-topics
972
973
973 $ hg help internals
974 $ hg help internals
974 Technical implementation topics
975 Technical implementation topics
975 """""""""""""""""""""""""""""""
976 """""""""""""""""""""""""""""""
976
977
977 To access a subtopic, use "hg help internals.{subtopic-name}"
978 To access a subtopic, use "hg help internals.{subtopic-name}"
978
979
979 bundles Bundles
980 bundles Bundles
980 censor Censor
981 censor Censor
981 changegroups Changegroups
982 changegroups Changegroups
982 requirements Repository Requirements
983 requirements Repository Requirements
983 revlogs Revision Logs
984 revlogs Revision Logs
984 wireprotocol Wire Protocol
985 wireprotocol Wire Protocol
985
986
986 sub-topics can be accessed
987 sub-topics can be accessed
987
988
988 $ hg help internals.changegroups
989 $ hg help internals.changegroups
989 Changegroups
990 Changegroups
990 """"""""""""
991 """"""""""""
991
992
992 Changegroups are representations of repository revlog data, specifically
993 Changegroups are representations of repository revlog data, specifically
993 the changelog data, root/flat manifest data, treemanifest data, and
994 the changelog data, root/flat manifest data, treemanifest data, and
994 filelogs.
995 filelogs.
995
996
996 There are 3 versions of changegroups: "1", "2", and "3". From a high-
997 There are 3 versions of changegroups: "1", "2", and "3". From a high-
997 level, versions "1" and "2" are almost exactly the same, with the only
998 level, versions "1" and "2" are almost exactly the same, with the only
998 difference being an additional item in the *delta header*. Version "3"
999 difference being an additional item in the *delta header*. Version "3"
999 adds support for revlog flags in the *delta header* and optionally
1000 adds support for revlog flags in the *delta header* and optionally
1000 exchanging treemanifests (enabled by setting an option on the
1001 exchanging treemanifests (enabled by setting an option on the
1001 "changegroup" part in the bundle2).
1002 "changegroup" part in the bundle2).
1002
1003
1003 Changegroups when not exchanging treemanifests consist of 3 logical
1004 Changegroups when not exchanging treemanifests consist of 3 logical
1004 segments:
1005 segments:
1005
1006
1006 +---------------------------------+
1007 +---------------------------------+
1007 | | | |
1008 | | | |
1008 | changeset | manifest | filelogs |
1009 | changeset | manifest | filelogs |
1009 | | | |
1010 | | | |
1010 | | | |
1011 | | | |
1011 +---------------------------------+
1012 +---------------------------------+
1012
1013
1013 When exchanging treemanifests, there are 4 logical segments:
1014 When exchanging treemanifests, there are 4 logical segments:
1014
1015
1015 +-------------------------------------------------+
1016 +-------------------------------------------------+
1016 | | | | |
1017 | | | | |
1017 | changeset | root | treemanifests | filelogs |
1018 | changeset | root | treemanifests | filelogs |
1018 | | manifest | | |
1019 | | manifest | | |
1019 | | | | |
1020 | | | | |
1020 +-------------------------------------------------+
1021 +-------------------------------------------------+
1021
1022
1022 The principle building block of each segment is a *chunk*. A *chunk* is a
1023 The principle building block of each segment is a *chunk*. A *chunk* is a
1023 framed piece of data:
1024 framed piece of data:
1024
1025
1025 +---------------------------------------+
1026 +---------------------------------------+
1026 | | |
1027 | | |
1027 | length | data |
1028 | length | data |
1028 | (4 bytes) | (<length - 4> bytes) |
1029 | (4 bytes) | (<length - 4> bytes) |
1029 | | |
1030 | | |
1030 +---------------------------------------+
1031 +---------------------------------------+
1031
1032
1032 All integers are big-endian signed integers. Each chunk starts with a
1033 All integers are big-endian signed integers. Each chunk starts with a
1033 32-bit integer indicating the length of the entire chunk (including the
1034 32-bit integer indicating the length of the entire chunk (including the
1034 length field itself).
1035 length field itself).
1035
1036
1036 There is a special case chunk that has a value of 0 for the length
1037 There is a special case chunk that has a value of 0 for the length
1037 ("0x00000000"). We call this an *empty chunk*.
1038 ("0x00000000"). We call this an *empty chunk*.
1038
1039
1039 Delta Groups
1040 Delta Groups
1040 ============
1041 ============
1041
1042
1042 A *delta group* expresses the content of a revlog as a series of deltas,
1043 A *delta group* expresses the content of a revlog as a series of deltas,
1043 or patches against previous revisions.
1044 or patches against previous revisions.
1044
1045
1045 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
1046 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
1046 to signal the end of the delta group:
1047 to signal the end of the delta group:
1047
1048
1048 +------------------------------------------------------------------------+
1049 +------------------------------------------------------------------------+
1049 | | | | | |
1050 | | | | | |
1050 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
1051 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
1051 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
1052 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
1052 | | | | | |
1053 | | | | | |
1053 +------------------------------------------------------------------------+
1054 +------------------------------------------------------------------------+
1054
1055
1055 Each *chunk*'s data consists of the following:
1056 Each *chunk*'s data consists of the following:
1056
1057
1057 +---------------------------------------+
1058 +---------------------------------------+
1058 | | |
1059 | | |
1059 | delta header | delta data |
1060 | delta header | delta data |
1060 | (various by version) | (various) |
1061 | (various by version) | (various) |
1061 | | |
1062 | | |
1062 +---------------------------------------+
1063 +---------------------------------------+
1063
1064
1064 The *delta data* is a series of *delta*s that describe a diff from an
1065 The *delta data* is a series of *delta*s that describe a diff from an
1065 existing entry (either that the recipient already has, or previously
1066 existing entry (either that the recipient already has, or previously
1066 specified in the bundle/changegroup).
1067 specified in the bundle/changegroup).
1067
1068
1068 The *delta header* is different between versions "1", "2", and "3" of the
1069 The *delta header* is different between versions "1", "2", and "3" of the
1069 changegroup format.
1070 changegroup format.
1070
1071
1071 Version 1 (headerlen=80):
1072 Version 1 (headerlen=80):
1072
1073
1073 +------------------------------------------------------+
1074 +------------------------------------------------------+
1074 | | | | |
1075 | | | | |
1075 | node | p1 node | p2 node | link node |
1076 | node | p1 node | p2 node | link node |
1076 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
1077 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
1077 | | | | |
1078 | | | | |
1078 +------------------------------------------------------+
1079 +------------------------------------------------------+
1079
1080
1080 Version 2 (headerlen=100):
1081 Version 2 (headerlen=100):
1081
1082
1082 +------------------------------------------------------------------+
1083 +------------------------------------------------------------------+
1083 | | | | | |
1084 | | | | | |
1084 | node | p1 node | p2 node | base node | link node |
1085 | node | p1 node | p2 node | base node | link node |
1085 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
1086 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
1086 | | | | | |
1087 | | | | | |
1087 +------------------------------------------------------------------+
1088 +------------------------------------------------------------------+
1088
1089
1089 Version 3 (headerlen=102):
1090 Version 3 (headerlen=102):
1090
1091
1091 +------------------------------------------------------------------------------+
1092 +------------------------------------------------------------------------------+
1092 | | | | | | |
1093 | | | | | | |
1093 | node | p1 node | p2 node | base node | link node | flags |
1094 | node | p1 node | p2 node | base node | link node | flags |
1094 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
1095 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
1095 | | | | | | |
1096 | | | | | | |
1096 +------------------------------------------------------------------------------+
1097 +------------------------------------------------------------------------------+
1097
1098
1098 The *delta data* consists of "chunklen - 4 - headerlen" bytes, which
1099 The *delta data* consists of "chunklen - 4 - headerlen" bytes, which
1099 contain a series of *delta*s, densely packed (no separators). These deltas
1100 contain a series of *delta*s, densely packed (no separators). These deltas
1100 describe a diff from an existing entry (either that the recipient already
1101 describe a diff from an existing entry (either that the recipient already
1101 has, or previously specified in the bundle/changegroup). The format is
1102 has, or previously specified in the bundle/changegroup). The format is
1102 described more fully in "hg help internals.bdiff", but briefly:
1103 described more fully in "hg help internals.bdiff", but briefly:
1103
1104
1104 +---------------------------------------------------------------+
1105 +---------------------------------------------------------------+
1105 | | | | |
1106 | | | | |
1106 | start offset | end offset | new length | content |
1107 | start offset | end offset | new length | content |
1107 | (4 bytes) | (4 bytes) | (4 bytes) | (<new length> bytes) |
1108 | (4 bytes) | (4 bytes) | (4 bytes) | (<new length> bytes) |
1108 | | | | |
1109 | | | | |
1109 +---------------------------------------------------------------+
1110 +---------------------------------------------------------------+
1110
1111
1111 Please note that the length field in the delta data does *not* include
1112 Please note that the length field in the delta data does *not* include
1112 itself.
1113 itself.
1113
1114
1114 In version 1, the delta is always applied against the previous node from
1115 In version 1, the delta is always applied against the previous node from
1115 the changegroup or the first parent if this is the first entry in the
1116 the changegroup or the first parent if this is the first entry in the
1116 changegroup.
1117 changegroup.
1117
1118
1118 In version 2 and up, the delta base node is encoded in the entry in the
1119 In version 2 and up, the delta base node is encoded in the entry in the
1119 changegroup. This allows the delta to be expressed against any parent,
1120 changegroup. This allows the delta to be expressed against any parent,
1120 which can result in smaller deltas and more efficient encoding of data.
1121 which can result in smaller deltas and more efficient encoding of data.
1121
1122
1122 Changeset Segment
1123 Changeset Segment
1123 =================
1124 =================
1124
1125
1125 The *changeset segment* consists of a single *delta group* holding
1126 The *changeset segment* consists of a single *delta group* holding
1126 changelog data. The *empty chunk* at the end of the *delta group* denotes
1127 changelog data. The *empty chunk* at the end of the *delta group* denotes
1127 the boundary to the *manifest segment*.
1128 the boundary to the *manifest segment*.
1128
1129
1129 Manifest Segment
1130 Manifest Segment
1130 ================
1131 ================
1131
1132
1132 The *manifest segment* consists of a single *delta group* holding manifest
1133 The *manifest segment* consists of a single *delta group* holding manifest
1133 data. If treemanifests are in use, it contains only the manifest for the
1134 data. If treemanifests are in use, it contains only the manifest for the
1134 root directory of the repository. Otherwise, it contains the entire
1135 root directory of the repository. Otherwise, it contains the entire
1135 manifest data. The *empty chunk* at the end of the *delta group* denotes
1136 manifest data. The *empty chunk* at the end of the *delta group* denotes
1136 the boundary to the next segment (either the *treemanifests segment* or
1137 the boundary to the next segment (either the *treemanifests segment* or
1137 the *filelogs segment*, depending on version and the request options).
1138 the *filelogs segment*, depending on version and the request options).
1138
1139
1139 Treemanifests Segment
1140 Treemanifests Segment
1140 ---------------------
1141 ---------------------
1141
1142
1142 The *treemanifests segment* only exists in changegroup version "3", and
1143 The *treemanifests segment* only exists in changegroup version "3", and
1143 only if the 'treemanifest' param is part of the bundle2 changegroup part
1144 only if the 'treemanifest' param is part of the bundle2 changegroup part
1144 (it is not possible to use changegroup version 3 outside of bundle2).
1145 (it is not possible to use changegroup version 3 outside of bundle2).
1145 Aside from the filenames in the *treemanifests segment* containing a
1146 Aside from the filenames in the *treemanifests segment* containing a
1146 trailing "/" character, it behaves identically to the *filelogs segment*
1147 trailing "/" character, it behaves identically to the *filelogs segment*
1147 (see below). The final sub-segment is followed by an *empty chunk*
1148 (see below). The final sub-segment is followed by an *empty chunk*
1148 (logically, a sub-segment with filename size 0). This denotes the boundary
1149 (logically, a sub-segment with filename size 0). This denotes the boundary
1149 to the *filelogs segment*.
1150 to the *filelogs segment*.
1150
1151
1151 Filelogs Segment
1152 Filelogs Segment
1152 ================
1153 ================
1153
1154
1154 The *filelogs segment* consists of multiple sub-segments, each
1155 The *filelogs segment* consists of multiple sub-segments, each
1155 corresponding to an individual file whose data is being described:
1156 corresponding to an individual file whose data is being described:
1156
1157
1157 +--------------------------------------------------+
1158 +--------------------------------------------------+
1158 | | | | | |
1159 | | | | | |
1159 | filelog0 | filelog1 | filelog2 | ... | 0x0 |
1160 | filelog0 | filelog1 | filelog2 | ... | 0x0 |
1160 | | | | | (4 bytes) |
1161 | | | | | (4 bytes) |
1161 | | | | | |
1162 | | | | | |
1162 +--------------------------------------------------+
1163 +--------------------------------------------------+
1163
1164
1164 The final filelog sub-segment is followed by an *empty chunk* (logically,
1165 The final filelog sub-segment is followed by an *empty chunk* (logically,
1165 a sub-segment with filename size 0). This denotes the end of the segment
1166 a sub-segment with filename size 0). This denotes the end of the segment
1166 and of the overall changegroup.
1167 and of the overall changegroup.
1167
1168
1168 Each filelog sub-segment consists of the following:
1169 Each filelog sub-segment consists of the following:
1169
1170
1170 +------------------------------------------------------+
1171 +------------------------------------------------------+
1171 | | | |
1172 | | | |
1172 | filename length | filename | delta group |
1173 | filename length | filename | delta group |
1173 | (4 bytes) | (<length - 4> bytes) | (various) |
1174 | (4 bytes) | (<length - 4> bytes) | (various) |
1174 | | | |
1175 | | | |
1175 +------------------------------------------------------+
1176 +------------------------------------------------------+
1176
1177
1177 That is, a *chunk* consisting of the filename (not terminated or padded)
1178 That is, a *chunk* consisting of the filename (not terminated or padded)
1178 followed by N chunks constituting the *delta group* for this file. The
1179 followed by N chunks constituting the *delta group* for this file. The
1179 *empty chunk* at the end of each *delta group* denotes the boundary to the
1180 *empty chunk* at the end of each *delta group* denotes the boundary to the
1180 next filelog sub-segment.
1181 next filelog sub-segment.
1181
1182
1182 Test list of commands with command with no help text
1183 Test list of commands with command with no help text
1183
1184
1184 $ hg help helpext
1185 $ hg help helpext
1185 helpext extension - no help text available
1186 helpext extension - no help text available
1186
1187
1187 list of commands:
1188 list of commands:
1188
1189
1189 nohelp (no help text available)
1190 nohelp (no help text available)
1190
1191
1191 (use 'hg help -v helpext' to show built-in aliases and global options)
1192 (use 'hg help -v helpext' to show built-in aliases and global options)
1192
1193
1193
1194
1194 test advanced, deprecated and experimental options are hidden in command help
1195 test advanced, deprecated and experimental options are hidden in command help
1195 $ hg help debugoptADV
1196 $ hg help debugoptADV
1196 hg debugoptADV
1197 hg debugoptADV
1197
1198
1198 (no help text available)
1199 (no help text available)
1199
1200
1200 options:
1201 options:
1201
1202
1202 (some details hidden, use --verbose to show complete help)
1203 (some details hidden, use --verbose to show complete help)
1203 $ hg help debugoptDEP
1204 $ hg help debugoptDEP
1204 hg debugoptDEP
1205 hg debugoptDEP
1205
1206
1206 (no help text available)
1207 (no help text available)
1207
1208
1208 options:
1209 options:
1209
1210
1210 (some details hidden, use --verbose to show complete help)
1211 (some details hidden, use --verbose to show complete help)
1211
1212
1212 $ hg help debugoptEXP
1213 $ hg help debugoptEXP
1213 hg debugoptEXP
1214 hg debugoptEXP
1214
1215
1215 (no help text available)
1216 (no help text available)
1216
1217
1217 options:
1218 options:
1218
1219
1219 (some details hidden, use --verbose to show complete help)
1220 (some details hidden, use --verbose to show complete help)
1220
1221
1221 test advanced, deprecated and experimental options are shown with -v
1222 test advanced, deprecated and experimental options are shown with -v
1222 $ hg help -v debugoptADV | grep aopt
1223 $ hg help -v debugoptADV | grep aopt
1223 --aopt option is (ADVANCED)
1224 --aopt option is (ADVANCED)
1224 $ hg help -v debugoptDEP | grep dopt
1225 $ hg help -v debugoptDEP | grep dopt
1225 --dopt option is (DEPRECATED)
1226 --dopt option is (DEPRECATED)
1226 $ hg help -v debugoptEXP | grep eopt
1227 $ hg help -v debugoptEXP | grep eopt
1227 --eopt option is (EXPERIMENTAL)
1228 --eopt option is (EXPERIMENTAL)
1228
1229
1229 #if gettext
1230 #if gettext
1230 test deprecated option is hidden with translation with untranslated description
1231 test deprecated option is hidden with translation with untranslated description
1231 (use many globy for not failing on changed transaction)
1232 (use many globy for not failing on changed transaction)
1232 $ LANGUAGE=sv hg help debugoptDEP
1233 $ LANGUAGE=sv hg help debugoptDEP
1233 hg debugoptDEP
1234 hg debugoptDEP
1234
1235
1235 (*) (glob)
1236 (*) (glob)
1236
1237
1237 options:
1238 options:
1238
1239
1239 (some details hidden, use --verbose to show complete help)
1240 (some details hidden, use --verbose to show complete help)
1240 #endif
1241 #endif
1241
1242
1242 Test commands that collide with topics (issue4240)
1243 Test commands that collide with topics (issue4240)
1243
1244
1244 $ hg config -hq
1245 $ hg config -hq
1245 hg config [-u] [NAME]...
1246 hg config [-u] [NAME]...
1246
1247
1247 show combined config settings from all hgrc files
1248 show combined config settings from all hgrc files
1248 $ hg showconfig -hq
1249 $ hg showconfig -hq
1249 hg config [-u] [NAME]...
1250 hg config [-u] [NAME]...
1250
1251
1251 show combined config settings from all hgrc files
1252 show combined config settings from all hgrc files
1252
1253
1253 Test a help topic
1254 Test a help topic
1254
1255
1255 $ hg help dates
1256 $ hg help dates
1256 Date Formats
1257 Date Formats
1257 """"""""""""
1258 """"""""""""
1258
1259
1259 Some commands allow the user to specify a date, e.g.:
1260 Some commands allow the user to specify a date, e.g.:
1260
1261
1261 - backout, commit, import, tag: Specify the commit date.
1262 - backout, commit, import, tag: Specify the commit date.
1262 - log, revert, update: Select revision(s) by date.
1263 - log, revert, update: Select revision(s) by date.
1263
1264
1264 Many date formats are valid. Here are some examples:
1265 Many date formats are valid. Here are some examples:
1265
1266
1266 - "Wed Dec 6 13:18:29 2006" (local timezone assumed)
1267 - "Wed Dec 6 13:18:29 2006" (local timezone assumed)
1267 - "Dec 6 13:18 -0600" (year assumed, time offset provided)
1268 - "Dec 6 13:18 -0600" (year assumed, time offset provided)
1268 - "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
1269 - "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
1269 - "Dec 6" (midnight)
1270 - "Dec 6" (midnight)
1270 - "13:18" (today assumed)
1271 - "13:18" (today assumed)
1271 - "3:39" (3:39AM assumed)
1272 - "3:39" (3:39AM assumed)
1272 - "3:39pm" (15:39)
1273 - "3:39pm" (15:39)
1273 - "2006-12-06 13:18:29" (ISO 8601 format)
1274 - "2006-12-06 13:18:29" (ISO 8601 format)
1274 - "2006-12-6 13:18"
1275 - "2006-12-6 13:18"
1275 - "2006-12-6"
1276 - "2006-12-6"
1276 - "12-6"
1277 - "12-6"
1277 - "12/6"
1278 - "12/6"
1278 - "12/6/6" (Dec 6 2006)
1279 - "12/6/6" (Dec 6 2006)
1279 - "today" (midnight)
1280 - "today" (midnight)
1280 - "yesterday" (midnight)
1281 - "yesterday" (midnight)
1281 - "now" - right now
1282 - "now" - right now
1282
1283
1283 Lastly, there is Mercurial's internal format:
1284 Lastly, there is Mercurial's internal format:
1284
1285
1285 - "1165411109 0" (Wed Dec 6 13:18:29 2006 UTC)
1286 - "1165411109 0" (Wed Dec 6 13:18:29 2006 UTC)
1286
1287
1287 This is the internal representation format for dates. The first number is
1288 This is the internal representation format for dates. The first number is
1288 the number of seconds since the epoch (1970-01-01 00:00 UTC). The second
1289 the number of seconds since the epoch (1970-01-01 00:00 UTC). The second
1289 is the offset of the local timezone, in seconds west of UTC (negative if
1290 is the offset of the local timezone, in seconds west of UTC (negative if
1290 the timezone is east of UTC).
1291 the timezone is east of UTC).
1291
1292
1292 The log command also accepts date ranges:
1293 The log command also accepts date ranges:
1293
1294
1294 - "<DATE" - at or before a given date/time
1295 - "<DATE" - at or before a given date/time
1295 - ">DATE" - on or after a given date/time
1296 - ">DATE" - on or after a given date/time
1296 - "DATE to DATE" - a date range, inclusive
1297 - "DATE to DATE" - a date range, inclusive
1297 - "-DAYS" - within a given number of days of today
1298 - "-DAYS" - within a given number of days of today
1298
1299
1299 Test repeated config section name
1300 Test repeated config section name
1300
1301
1301 $ hg help config.host
1302 $ hg help config.host
1302 "http_proxy.host"
1303 "http_proxy.host"
1303 Host name and (optional) port of the proxy server, for example
1304 Host name and (optional) port of the proxy server, for example
1304 "myproxy:8000".
1305 "myproxy:8000".
1305
1306
1306 "smtp.host"
1307 "smtp.host"
1307 Host name of mail server, e.g. "mail.example.com".
1308 Host name of mail server, e.g. "mail.example.com".
1308
1309
1309 Unrelated trailing paragraphs shouldn't be included
1310 Unrelated trailing paragraphs shouldn't be included
1310
1311
1311 $ hg help config.extramsg | grep '^$'
1312 $ hg help config.extramsg | grep '^$'
1312
1313
1313
1314
1314 Test capitalized section name
1315 Test capitalized section name
1315
1316
1316 $ hg help scripting.HGPLAIN > /dev/null
1317 $ hg help scripting.HGPLAIN > /dev/null
1317
1318
1318 Help subsection:
1319 Help subsection:
1319
1320
1320 $ hg help config.charsets |grep "Email example:" > /dev/null
1321 $ hg help config.charsets |grep "Email example:" > /dev/null
1321 [1]
1322 [1]
1322
1323
1323 Show nested definitions
1324 Show nested definitions
1324 ("profiling.type"[break]"ls"[break]"stat"[break])
1325 ("profiling.type"[break]"ls"[break]"stat"[break])
1325
1326
1326 $ hg help config.type | egrep '^$'|wc -l
1327 $ hg help config.type | egrep '^$'|wc -l
1327 \s*3 (re)
1328 \s*3 (re)
1328
1329
1329 Separate sections from subsections
1330 Separate sections from subsections
1330
1331
1331 $ hg help config.format | egrep '^ ("|-)|^\s*$' | uniq
1332 $ hg help config.format | egrep '^ ("|-)|^\s*$' | uniq
1332 "format"
1333 "format"
1333 --------
1334 --------
1334
1335
1335 "usegeneraldelta"
1336 "usegeneraldelta"
1336
1337
1337 "dotencode"
1338 "dotencode"
1338
1339
1339 "usefncache"
1340 "usefncache"
1340
1341
1341 "usestore"
1342 "usestore"
1342
1343
1343 "profiling"
1344 "profiling"
1344 -----------
1345 -----------
1345
1346
1346 "format"
1347 "format"
1347
1348
1348 "progress"
1349 "progress"
1349 ----------
1350 ----------
1350
1351
1351 "format"
1352 "format"
1352
1353
1353
1354
1354 Last item in help config.*:
1355 Last item in help config.*:
1355
1356
1356 $ hg help config.`hg help config|grep '^ "'| \
1357 $ hg help config.`hg help config|grep '^ "'| \
1357 > tail -1|sed 's![ "]*!!g'`| \
1358 > tail -1|sed 's![ "]*!!g'`| \
1358 > grep 'hg help -c config' > /dev/null
1359 > grep 'hg help -c config' > /dev/null
1359 [1]
1360 [1]
1360
1361
1361 note to use help -c for general hg help config:
1362 note to use help -c for general hg help config:
1362
1363
1363 $ hg help config |grep 'hg help -c config' > /dev/null
1364 $ hg help config |grep 'hg help -c config' > /dev/null
1364
1365
1365 Test templating help
1366 Test templating help
1366
1367
1367 $ hg help templating | egrep '(desc|diffstat|firstline|nonempty) '
1368 $ hg help templating | egrep '(desc|diffstat|firstline|nonempty) '
1368 desc String. The text of the changeset description.
1369 desc String. The text of the changeset description.
1369 diffstat String. Statistics of changes with the following format:
1370 diffstat String. Statistics of changes with the following format:
1370 firstline Any text. Returns the first line of text.
1371 firstline Any text. Returns the first line of text.
1371 nonempty Any text. Returns '(none)' if the string is empty.
1372 nonempty Any text. Returns '(none)' if the string is empty.
1372
1373
1373 Test deprecated items
1374 Test deprecated items
1374
1375
1375 $ hg help -v templating | grep currentbookmark
1376 $ hg help -v templating | grep currentbookmark
1376 currentbookmark
1377 currentbookmark
1377 $ hg help templating | (grep currentbookmark || true)
1378 $ hg help templating | (grep currentbookmark || true)
1378
1379
1379 Test help hooks
1380 Test help hooks
1380
1381
1381 $ cat > helphook1.py <<EOF
1382 $ cat > helphook1.py <<EOF
1382 > from mercurial import help
1383 > from mercurial import help
1383 >
1384 >
1384 > def rewrite(ui, topic, doc):
1385 > def rewrite(ui, topic, doc):
1385 > return doc + '\nhelphook1\n'
1386 > return doc + '\nhelphook1\n'
1386 >
1387 >
1387 > def extsetup(ui):
1388 > def extsetup(ui):
1388 > help.addtopichook('revisions', rewrite)
1389 > help.addtopichook('revisions', rewrite)
1389 > EOF
1390 > EOF
1390 $ cat > helphook2.py <<EOF
1391 $ cat > helphook2.py <<EOF
1391 > from mercurial import help
1392 > from mercurial import help
1392 >
1393 >
1393 > def rewrite(ui, topic, doc):
1394 > def rewrite(ui, topic, doc):
1394 > return doc + '\nhelphook2\n'
1395 > return doc + '\nhelphook2\n'
1395 >
1396 >
1396 > def extsetup(ui):
1397 > def extsetup(ui):
1397 > help.addtopichook('revisions', rewrite)
1398 > help.addtopichook('revisions', rewrite)
1398 > EOF
1399 > EOF
1399 $ echo '[extensions]' >> $HGRCPATH
1400 $ echo '[extensions]' >> $HGRCPATH
1400 $ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
1401 $ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
1401 $ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
1402 $ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
1402 $ hg help revsets | grep helphook
1403 $ hg help revsets | grep helphook
1403 helphook1
1404 helphook1
1404 helphook2
1405 helphook2
1405
1406
1406 help -c should only show debug --debug
1407 help -c should only show debug --debug
1407
1408
1408 $ hg help -c --debug|egrep debug|wc -l|egrep '^\s*0\s*$'
1409 $ hg help -c --debug|egrep debug|wc -l|egrep '^\s*0\s*$'
1409 [1]
1410 [1]
1410
1411
1411 help -c should only show deprecated for -v
1412 help -c should only show deprecated for -v
1412
1413
1413 $ hg help -c -v|egrep DEPRECATED|wc -l|egrep '^\s*0\s*$'
1414 $ hg help -c -v|egrep DEPRECATED|wc -l|egrep '^\s*0\s*$'
1414 [1]
1415 [1]
1415
1416
1416 Test -s / --system
1417 Test -s / --system
1417
1418
1418 $ hg help config.files -s windows |grep 'etc/mercurial' | \
1419 $ hg help config.files -s windows |grep 'etc/mercurial' | \
1419 > wc -l | sed -e 's/ //g'
1420 > wc -l | sed -e 's/ //g'
1420 0
1421 0
1421 $ hg help config.files --system unix | grep 'USER' | \
1422 $ hg help config.files --system unix | grep 'USER' | \
1422 > wc -l | sed -e 's/ //g'
1423 > wc -l | sed -e 's/ //g'
1423 0
1424 0
1424
1425
1425 Test -e / -c / -k combinations
1426 Test -e / -c / -k combinations
1426
1427
1427 $ hg help -c|egrep '^[A-Z].*:|^ debug'
1428 $ hg help -c|egrep '^[A-Z].*:|^ debug'
1428 Commands:
1429 Commands:
1429 $ hg help -e|egrep '^[A-Z].*:|^ debug'
1430 $ hg help -e|egrep '^[A-Z].*:|^ debug'
1430 Extensions:
1431 Extensions:
1431 $ hg help -k|egrep '^[A-Z].*:|^ debug'
1432 $ hg help -k|egrep '^[A-Z].*:|^ debug'
1432 Topics:
1433 Topics:
1433 Commands:
1434 Commands:
1434 Extensions:
1435 Extensions:
1435 Extension Commands:
1436 Extension Commands:
1436 $ hg help -c schemes
1437 $ hg help -c schemes
1437 abort: no such help topic: schemes
1438 abort: no such help topic: schemes
1438 (try 'hg help --keyword schemes')
1439 (try 'hg help --keyword schemes')
1439 [255]
1440 [255]
1440 $ hg help -e schemes |head -1
1441 $ hg help -e schemes |head -1
1441 schemes extension - extend schemes with shortcuts to repository swarms
1442 schemes extension - extend schemes with shortcuts to repository swarms
1442 $ hg help -c -k dates |egrep '^(Topics|Extensions|Commands):'
1443 $ hg help -c -k dates |egrep '^(Topics|Extensions|Commands):'
1443 Commands:
1444 Commands:
1444 $ hg help -e -k a |egrep '^(Topics|Extensions|Commands):'
1445 $ hg help -e -k a |egrep '^(Topics|Extensions|Commands):'
1445 Extensions:
1446 Extensions:
1446 $ hg help -e -c -k date |egrep '^(Topics|Extensions|Commands):'
1447 $ hg help -e -c -k date |egrep '^(Topics|Extensions|Commands):'
1447 Extensions:
1448 Extensions:
1448 Commands:
1449 Commands:
1449 $ hg help -c commit > /dev/null
1450 $ hg help -c commit > /dev/null
1450 $ hg help -e -c commit > /dev/null
1451 $ hg help -e -c commit > /dev/null
1451 $ hg help -e commit > /dev/null
1452 $ hg help -e commit > /dev/null
1452 abort: no such help topic: commit
1453 abort: no such help topic: commit
1453 (try 'hg help --keyword commit')
1454 (try 'hg help --keyword commit')
1454 [255]
1455 [255]
1455
1456
1456 Test keyword search help
1457 Test keyword search help
1457
1458
1458 $ cat > prefixedname.py <<EOF
1459 $ cat > prefixedname.py <<EOF
1459 > '''matched against word "clone"
1460 > '''matched against word "clone"
1460 > '''
1461 > '''
1461 > EOF
1462 > EOF
1462 $ echo '[extensions]' >> $HGRCPATH
1463 $ echo '[extensions]' >> $HGRCPATH
1463 $ echo "dot.dot.prefixedname = `pwd`/prefixedname.py" >> $HGRCPATH
1464 $ echo "dot.dot.prefixedname = `pwd`/prefixedname.py" >> $HGRCPATH
1464 $ hg help -k clone
1465 $ hg help -k clone
1465 Topics:
1466 Topics:
1466
1467
1467 config Configuration Files
1468 config Configuration Files
1468 extensions Using Additional Features
1469 extensions Using Additional Features
1469 glossary Glossary
1470 glossary Glossary
1470 phases Working with Phases
1471 phases Working with Phases
1471 subrepos Subrepositories
1472 subrepos Subrepositories
1472 urls URL Paths
1473 urls URL Paths
1473
1474
1474 Commands:
1475 Commands:
1475
1476
1476 bookmarks create a new bookmark or list existing bookmarks
1477 bookmarks create a new bookmark or list existing bookmarks
1477 clone make a copy of an existing repository
1478 clone make a copy of an existing repository
1478 paths show aliases for remote repositories
1479 paths show aliases for remote repositories
1479 update update working directory (or switch revisions)
1480 update update working directory (or switch revisions)
1480
1481
1481 Extensions:
1482 Extensions:
1482
1483
1483 clonebundles advertise pre-generated bundles to seed clones
1484 clonebundles advertise pre-generated bundles to seed clones
1484 prefixedname matched against word "clone"
1485 prefixedname matched against word "clone"
1485 relink recreates hardlinks between repository clones
1486 relink recreates hardlinks between repository clones
1486
1487
1487 Extension Commands:
1488 Extension Commands:
1488
1489
1489 qclone clone main and patch repository at same time
1490 qclone clone main and patch repository at same time
1490
1491
1491 Test unfound topic
1492 Test unfound topic
1492
1493
1493 $ hg help nonexistingtopicthatwillneverexisteverever
1494 $ hg help nonexistingtopicthatwillneverexisteverever
1494 abort: no such help topic: nonexistingtopicthatwillneverexisteverever
1495 abort: no such help topic: nonexistingtopicthatwillneverexisteverever
1495 (try 'hg help --keyword nonexistingtopicthatwillneverexisteverever')
1496 (try 'hg help --keyword nonexistingtopicthatwillneverexisteverever')
1496 [255]
1497 [255]
1497
1498
1498 Test unfound keyword
1499 Test unfound keyword
1499
1500
1500 $ hg help --keyword nonexistingwordthatwillneverexisteverever
1501 $ hg help --keyword nonexistingwordthatwillneverexisteverever
1501 abort: no matches
1502 abort: no matches
1502 (try 'hg help' for a list of topics)
1503 (try 'hg help' for a list of topics)
1503 [255]
1504 [255]
1504
1505
1505 Test omit indicating for help
1506 Test omit indicating for help
1506
1507
1507 $ cat > addverboseitems.py <<EOF
1508 $ cat > addverboseitems.py <<EOF
1508 > '''extension to test omit indicating.
1509 > '''extension to test omit indicating.
1509 >
1510 >
1510 > This paragraph is never omitted (for extension)
1511 > This paragraph is never omitted (for extension)
1511 >
1512 >
1512 > .. container:: verbose
1513 > .. container:: verbose
1513 >
1514 >
1514 > This paragraph is omitted,
1515 > This paragraph is omitted,
1515 > if :hg:\`help\` is invoked without \`\`-v\`\` (for extension)
1516 > if :hg:\`help\` is invoked without \`\`-v\`\` (for extension)
1516 >
1517 >
1517 > This paragraph is never omitted, too (for extension)
1518 > This paragraph is never omitted, too (for extension)
1518 > '''
1519 > '''
1519 >
1520 >
1520 > from mercurial import help, commands
1521 > from mercurial import help, commands
1521 > testtopic = """This paragraph is never omitted (for topic).
1522 > testtopic = """This paragraph is never omitted (for topic).
1522 >
1523 >
1523 > .. container:: verbose
1524 > .. container:: verbose
1524 >
1525 >
1525 > This paragraph is omitted,
1526 > This paragraph is omitted,
1526 > if :hg:\`help\` is invoked without \`\`-v\`\` (for topic)
1527 > if :hg:\`help\` is invoked without \`\`-v\`\` (for topic)
1527 >
1528 >
1528 > This paragraph is never omitted, too (for topic)
1529 > This paragraph is never omitted, too (for topic)
1529 > """
1530 > """
1530 > def extsetup(ui):
1531 > def extsetup(ui):
1531 > help.helptable.append((["topic-containing-verbose"],
1532 > help.helptable.append((["topic-containing-verbose"],
1532 > "This is the topic to test omit indicating.",
1533 > "This is the topic to test omit indicating.",
1533 > lambda ui: testtopic))
1534 > lambda ui: testtopic))
1534 > EOF
1535 > EOF
1535 $ echo '[extensions]' >> $HGRCPATH
1536 $ echo '[extensions]' >> $HGRCPATH
1536 $ echo "addverboseitems = `pwd`/addverboseitems.py" >> $HGRCPATH
1537 $ echo "addverboseitems = `pwd`/addverboseitems.py" >> $HGRCPATH
1537 $ hg help addverboseitems
1538 $ hg help addverboseitems
1538 addverboseitems extension - extension to test omit indicating.
1539 addverboseitems extension - extension to test omit indicating.
1539
1540
1540 This paragraph is never omitted (for extension)
1541 This paragraph is never omitted (for extension)
1541
1542
1542 This paragraph is never omitted, too (for extension)
1543 This paragraph is never omitted, too (for extension)
1543
1544
1544 (some details hidden, use --verbose to show complete help)
1545 (some details hidden, use --verbose to show complete help)
1545
1546
1546 no commands defined
1547 no commands defined
1547 $ hg help -v addverboseitems
1548 $ hg help -v addverboseitems
1548 addverboseitems extension - extension to test omit indicating.
1549 addverboseitems extension - extension to test omit indicating.
1549
1550
1550 This paragraph is never omitted (for extension)
1551 This paragraph is never omitted (for extension)
1551
1552
1552 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
1553 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
1553 extension)
1554 extension)
1554
1555
1555 This paragraph is never omitted, too (for extension)
1556 This paragraph is never omitted, too (for extension)
1556
1557
1557 no commands defined
1558 no commands defined
1558 $ hg help topic-containing-verbose
1559 $ hg help topic-containing-verbose
1559 This is the topic to test omit indicating.
1560 This is the topic to test omit indicating.
1560 """"""""""""""""""""""""""""""""""""""""""
1561 """"""""""""""""""""""""""""""""""""""""""
1561
1562
1562 This paragraph is never omitted (for topic).
1563 This paragraph is never omitted (for topic).
1563
1564
1564 This paragraph is never omitted, too (for topic)
1565 This paragraph is never omitted, too (for topic)
1565
1566
1566 (some details hidden, use --verbose to show complete help)
1567 (some details hidden, use --verbose to show complete help)
1567 $ hg help -v topic-containing-verbose
1568 $ hg help -v topic-containing-verbose
1568 This is the topic to test omit indicating.
1569 This is the topic to test omit indicating.
1569 """"""""""""""""""""""""""""""""""""""""""
1570 """"""""""""""""""""""""""""""""""""""""""
1570
1571
1571 This paragraph is never omitted (for topic).
1572 This paragraph is never omitted (for topic).
1572
1573
1573 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
1574 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
1574 topic)
1575 topic)
1575
1576
1576 This paragraph is never omitted, too (for topic)
1577 This paragraph is never omitted, too (for topic)
1577
1578
1578 Test section lookup
1579 Test section lookup
1579
1580
1580 $ hg help revset.merge
1581 $ hg help revset.merge
1581 "merge()"
1582 "merge()"
1582 Changeset is a merge changeset.
1583 Changeset is a merge changeset.
1583
1584
1584 $ hg help glossary.dag
1585 $ hg help glossary.dag
1585 DAG
1586 DAG
1586 The repository of changesets of a distributed version control system
1587 The repository of changesets of a distributed version control system
1587 (DVCS) can be described as a directed acyclic graph (DAG), consisting
1588 (DVCS) can be described as a directed acyclic graph (DAG), consisting
1588 of nodes and edges, where nodes correspond to changesets and edges
1589 of nodes and edges, where nodes correspond to changesets and edges
1589 imply a parent -> child relation. This graph can be visualized by
1590 imply a parent -> child relation. This graph can be visualized by
1590 graphical tools such as 'hg log --graph'. In Mercurial, the DAG is
1591 graphical tools such as 'hg log --graph'. In Mercurial, the DAG is
1591 limited by the requirement for children to have at most two parents.
1592 limited by the requirement for children to have at most two parents.
1592
1593
1593
1594
1594 $ hg help hgrc.paths
1595 $ hg help hgrc.paths
1595 "paths"
1596 "paths"
1596 -------
1597 -------
1597
1598
1598 Assigns symbolic names and behavior to repositories.
1599 Assigns symbolic names and behavior to repositories.
1599
1600
1600 Options are symbolic names defining the URL or directory that is the
1601 Options are symbolic names defining the URL or directory that is the
1601 location of the repository. Example:
1602 location of the repository. Example:
1602
1603
1603 [paths]
1604 [paths]
1604 my_server = https://example.com/my_repo
1605 my_server = https://example.com/my_repo
1605 local_path = /home/me/repo
1606 local_path = /home/me/repo
1606
1607
1607 These symbolic names can be used from the command line. To pull from
1608 These symbolic names can be used from the command line. To pull from
1608 "my_server": 'hg pull my_server'. To push to "local_path": 'hg push
1609 "my_server": 'hg pull my_server'. To push to "local_path": 'hg push
1609 local_path'.
1610 local_path'.
1610
1611
1611 Options containing colons (":") denote sub-options that can influence
1612 Options containing colons (":") denote sub-options that can influence
1612 behavior for that specific path. Example:
1613 behavior for that specific path. Example:
1613
1614
1614 [paths]
1615 [paths]
1615 my_server = https://example.com/my_path
1616 my_server = https://example.com/my_path
1616 my_server:pushurl = ssh://example.com/my_path
1617 my_server:pushurl = ssh://example.com/my_path
1617
1618
1618 The following sub-options can be defined:
1619 The following sub-options can be defined:
1619
1620
1620 "pushurl"
1621 "pushurl"
1621 The URL to use for push operations. If not defined, the location
1622 The URL to use for push operations. If not defined, the location
1622 defined by the path's main entry is used.
1623 defined by the path's main entry is used.
1623
1624
1624 "pushrev"
1625 "pushrev"
1625 A revset defining which revisions to push by default.
1626 A revset defining which revisions to push by default.
1626
1627
1627 When 'hg push' is executed without a "-r" argument, the revset defined
1628 When 'hg push' is executed without a "-r" argument, the revset defined
1628 by this sub-option is evaluated to determine what to push.
1629 by this sub-option is evaluated to determine what to push.
1629
1630
1630 For example, a value of "." will push the working directory's revision
1631 For example, a value of "." will push the working directory's revision
1631 by default.
1632 by default.
1632
1633
1633 Revsets specifying bookmarks will not result in the bookmark being
1634 Revsets specifying bookmarks will not result in the bookmark being
1634 pushed.
1635 pushed.
1635
1636
1636 The following special named paths exist:
1637 The following special named paths exist:
1637
1638
1638 "default"
1639 "default"
1639 The URL or directory to use when no source or remote is specified.
1640 The URL or directory to use when no source or remote is specified.
1640
1641
1641 'hg clone' will automatically define this path to the location the
1642 'hg clone' will automatically define this path to the location the
1642 repository was cloned from.
1643 repository was cloned from.
1643
1644
1644 "default-push"
1645 "default-push"
1645 (deprecated) The URL or directory for the default 'hg push' location.
1646 (deprecated) The URL or directory for the default 'hg push' location.
1646 "default:pushurl" should be used instead.
1647 "default:pushurl" should be used instead.
1647
1648
1648 $ hg help glossary.mcguffin
1649 $ hg help glossary.mcguffin
1649 abort: help section not found: glossary.mcguffin
1650 abort: help section not found: glossary.mcguffin
1650 [255]
1651 [255]
1651
1652
1652 $ hg help glossary.mc.guffin
1653 $ hg help glossary.mc.guffin
1653 abort: help section not found: glossary.mc.guffin
1654 abort: help section not found: glossary.mc.guffin
1654 [255]
1655 [255]
1655
1656
1656 $ hg help template.files
1657 $ hg help template.files
1657 files List of strings. All files modified, added, or removed by
1658 files List of strings. All files modified, added, or removed by
1658 this changeset.
1659 this changeset.
1659 files(pattern)
1660 files(pattern)
1660 All files of the current changeset matching the pattern. See
1661 All files of the current changeset matching the pattern. See
1661 'hg help patterns'.
1662 'hg help patterns'.
1662
1663
1663 Test section lookup by translated message
1664 Test section lookup by translated message
1664
1665
1665 str.lower() instead of encoding.lower(str) on translated message might
1666 str.lower() instead of encoding.lower(str) on translated message might
1666 make message meaningless, because some encoding uses 0x41(A) - 0x5a(Z)
1667 make message meaningless, because some encoding uses 0x41(A) - 0x5a(Z)
1667 as the second or later byte of multi-byte character.
1668 as the second or later byte of multi-byte character.
1668
1669
1669 For example, "\x8bL\x98^" (translation of "record" in ja_JP.cp932)
1670 For example, "\x8bL\x98^" (translation of "record" in ja_JP.cp932)
1670 contains 0x4c (L). str.lower() replaces 0x4c(L) by 0x6c(l) and this
1671 contains 0x4c (L). str.lower() replaces 0x4c(L) by 0x6c(l) and this
1671 replacement makes message meaningless.
1672 replacement makes message meaningless.
1672
1673
1673 This tests that section lookup by translated string isn't broken by
1674 This tests that section lookup by translated string isn't broken by
1674 such str.lower().
1675 such str.lower().
1675
1676
1676 $ $PYTHON <<EOF
1677 $ $PYTHON <<EOF
1677 > def escape(s):
1678 > def escape(s):
1678 > return ''.join('\u%x' % ord(uc) for uc in s.decode('cp932'))
1679 > return ''.join('\u%x' % ord(uc) for uc in s.decode('cp932'))
1679 > # translation of "record" in ja_JP.cp932
1680 > # translation of "record" in ja_JP.cp932
1680 > upper = "\x8bL\x98^"
1681 > upper = "\x8bL\x98^"
1681 > # str.lower()-ed section name should be treated as different one
1682 > # str.lower()-ed section name should be treated as different one
1682 > lower = "\x8bl\x98^"
1683 > lower = "\x8bl\x98^"
1683 > with open('ambiguous.py', 'w') as fp:
1684 > with open('ambiguous.py', 'w') as fp:
1684 > fp.write("""# ambiguous section names in ja_JP.cp932
1685 > fp.write("""# ambiguous section names in ja_JP.cp932
1685 > u'''summary of extension
1686 > u'''summary of extension
1686 >
1687 >
1687 > %s
1688 > %s
1688 > ----
1689 > ----
1689 >
1690 >
1690 > Upper name should show only this message
1691 > Upper name should show only this message
1691 >
1692 >
1692 > %s
1693 > %s
1693 > ----
1694 > ----
1694 >
1695 >
1695 > Lower name should show only this message
1696 > Lower name should show only this message
1696 >
1697 >
1697 > subsequent section
1698 > subsequent section
1698 > ------------------
1699 > ------------------
1699 >
1700 >
1700 > This should be hidden at 'hg help ambiguous' with section name.
1701 > This should be hidden at 'hg help ambiguous' with section name.
1701 > '''
1702 > '''
1702 > """ % (escape(upper), escape(lower)))
1703 > """ % (escape(upper), escape(lower)))
1703 > EOF
1704 > EOF
1704
1705
1705 $ cat >> $HGRCPATH <<EOF
1706 $ cat >> $HGRCPATH <<EOF
1706 > [extensions]
1707 > [extensions]
1707 > ambiguous = ./ambiguous.py
1708 > ambiguous = ./ambiguous.py
1708 > EOF
1709 > EOF
1709
1710
1710 $ $PYTHON <<EOF | sh
1711 $ $PYTHON <<EOF | sh
1711 > upper = "\x8bL\x98^"
1712 > upper = "\x8bL\x98^"
1712 > print "hg --encoding cp932 help -e ambiguous.%s" % upper
1713 > print "hg --encoding cp932 help -e ambiguous.%s" % upper
1713 > EOF
1714 > EOF
1714 \x8bL\x98^ (esc)
1715 \x8bL\x98^ (esc)
1715 ----
1716 ----
1716
1717
1717 Upper name should show only this message
1718 Upper name should show only this message
1718
1719
1719
1720
1720 $ $PYTHON <<EOF | sh
1721 $ $PYTHON <<EOF | sh
1721 > lower = "\x8bl\x98^"
1722 > lower = "\x8bl\x98^"
1722 > print "hg --encoding cp932 help -e ambiguous.%s" % lower
1723 > print "hg --encoding cp932 help -e ambiguous.%s" % lower
1723 > EOF
1724 > EOF
1724 \x8bl\x98^ (esc)
1725 \x8bl\x98^ (esc)
1725 ----
1726 ----
1726
1727
1727 Lower name should show only this message
1728 Lower name should show only this message
1728
1729
1729
1730
1730 $ cat >> $HGRCPATH <<EOF
1731 $ cat >> $HGRCPATH <<EOF
1731 > [extensions]
1732 > [extensions]
1732 > ambiguous = !
1733 > ambiguous = !
1733 > EOF
1734 > EOF
1734
1735
1735 Show help content of disabled extensions
1736 Show help content of disabled extensions
1736
1737
1737 $ cat >> $HGRCPATH <<EOF
1738 $ cat >> $HGRCPATH <<EOF
1738 > [extensions]
1739 > [extensions]
1739 > ambiguous = !./ambiguous.py
1740 > ambiguous = !./ambiguous.py
1740 > EOF
1741 > EOF
1741 $ hg help -e ambiguous
1742 $ hg help -e ambiguous
1742 ambiguous extension - (no help text available)
1743 ambiguous extension - (no help text available)
1743
1744
1744 (use 'hg help extensions' for information on enabling extensions)
1745 (use 'hg help extensions' for information on enabling extensions)
1745
1746
1746 Test dynamic list of merge tools only shows up once
1747 Test dynamic list of merge tools only shows up once
1747 $ hg help merge-tools
1748 $ hg help merge-tools
1748 Merge Tools
1749 Merge Tools
1749 """""""""""
1750 """""""""""
1750
1751
1751 To merge files Mercurial uses merge tools.
1752 To merge files Mercurial uses merge tools.
1752
1753
1753 A merge tool combines two different versions of a file into a merged file.
1754 A merge tool combines two different versions of a file into a merged file.
1754 Merge tools are given the two files and the greatest common ancestor of
1755 Merge tools are given the two files and the greatest common ancestor of
1755 the two file versions, so they can determine the changes made on both
1756 the two file versions, so they can determine the changes made on both
1756 branches.
1757 branches.
1757
1758
1758 Merge tools are used both for 'hg resolve', 'hg merge', 'hg update', 'hg
1759 Merge tools are used both for 'hg resolve', 'hg merge', 'hg update', 'hg
1759 backout' and in several extensions.
1760 backout' and in several extensions.
1760
1761
1761 Usually, the merge tool tries to automatically reconcile the files by
1762 Usually, the merge tool tries to automatically reconcile the files by
1762 combining all non-overlapping changes that occurred separately in the two
1763 combining all non-overlapping changes that occurred separately in the two
1763 different evolutions of the same initial base file. Furthermore, some
1764 different evolutions of the same initial base file. Furthermore, some
1764 interactive merge programs make it easier to manually resolve conflicting
1765 interactive merge programs make it easier to manually resolve conflicting
1765 merges, either in a graphical way, or by inserting some conflict markers.
1766 merges, either in a graphical way, or by inserting some conflict markers.
1766 Mercurial does not include any interactive merge programs but relies on
1767 Mercurial does not include any interactive merge programs but relies on
1767 external tools for that.
1768 external tools for that.
1768
1769
1769 Available merge tools
1770 Available merge tools
1770 =====================
1771 =====================
1771
1772
1772 External merge tools and their properties are configured in the merge-
1773 External merge tools and their properties are configured in the merge-
1773 tools configuration section - see hgrc(5) - but they can often just be
1774 tools configuration section - see hgrc(5) - but they can often just be
1774 named by their executable.
1775 named by their executable.
1775
1776
1776 A merge tool is generally usable if its executable can be found on the
1777 A merge tool is generally usable if its executable can be found on the
1777 system and if it can handle the merge. The executable is found if it is an
1778 system and if it can handle the merge. The executable is found if it is an
1778 absolute or relative executable path or the name of an application in the
1779 absolute or relative executable path or the name of an application in the
1779 executable search path. The tool is assumed to be able to handle the merge
1780 executable search path. The tool is assumed to be able to handle the merge
1780 if it can handle symlinks if the file is a symlink, if it can handle
1781 if it can handle symlinks if the file is a symlink, if it can handle
1781 binary files if the file is binary, and if a GUI is available if the tool
1782 binary files if the file is binary, and if a GUI is available if the tool
1782 requires a GUI.
1783 requires a GUI.
1783
1784
1784 There are some internal merge tools which can be used. The internal merge
1785 There are some internal merge tools which can be used. The internal merge
1785 tools are:
1786 tools are:
1786
1787
1787 ":dump"
1788 ":dump"
1788 Creates three versions of the files to merge, containing the contents of
1789 Creates three versions of the files to merge, containing the contents of
1789 local, other and base. These files can then be used to perform a merge
1790 local, other and base. These files can then be used to perform a merge
1790 manually. If the file to be merged is named "a.txt", these files will
1791 manually. If the file to be merged is named "a.txt", these files will
1791 accordingly be named "a.txt.local", "a.txt.other" and "a.txt.base" and
1792 accordingly be named "a.txt.local", "a.txt.other" and "a.txt.base" and
1792 they will be placed in the same directory as "a.txt".
1793 they will be placed in the same directory as "a.txt".
1793
1794
1794 This implies permerge. Therefore, files aren't dumped, if premerge runs
1795 This implies permerge. Therefore, files aren't dumped, if premerge runs
1795 successfully. Use :forcedump to forcibly write files out.
1796 successfully. Use :forcedump to forcibly write files out.
1796
1797
1797 ":fail"
1798 ":fail"
1798 Rather than attempting to merge files that were modified on both
1799 Rather than attempting to merge files that were modified on both
1799 branches, it marks them as unresolved. The resolve command must be used
1800 branches, it marks them as unresolved. The resolve command must be used
1800 to resolve these conflicts.
1801 to resolve these conflicts.
1801
1802
1802 ":forcedump"
1803 ":forcedump"
1803 Creates three versions of the files as same as :dump, but omits
1804 Creates three versions of the files as same as :dump, but omits
1804 premerge.
1805 premerge.
1805
1806
1806 ":local"
1807 ":local"
1807 Uses the local 'p1()' version of files as the merged version.
1808 Uses the local 'p1()' version of files as the merged version.
1808
1809
1809 ":merge"
1810 ":merge"
1810 Uses the internal non-interactive simple merge algorithm for merging
1811 Uses the internal non-interactive simple merge algorithm for merging
1811 files. It will fail if there are any conflicts and leave markers in the
1812 files. It will fail if there are any conflicts and leave markers in the
1812 partially merged file. Markers will have two sections, one for each side
1813 partially merged file. Markers will have two sections, one for each side
1813 of merge.
1814 of merge.
1814
1815
1815 ":merge-local"
1816 ":merge-local"
1816 Like :merge, but resolve all conflicts non-interactively in favor of the
1817 Like :merge, but resolve all conflicts non-interactively in favor of the
1817 local 'p1()' changes.
1818 local 'p1()' changes.
1818
1819
1819 ":merge-other"
1820 ":merge-other"
1820 Like :merge, but resolve all conflicts non-interactively in favor of the
1821 Like :merge, but resolve all conflicts non-interactively in favor of the
1821 other 'p2()' changes.
1822 other 'p2()' changes.
1822
1823
1823 ":merge3"
1824 ":merge3"
1824 Uses the internal non-interactive simple merge algorithm for merging
1825 Uses the internal non-interactive simple merge algorithm for merging
1825 files. It will fail if there are any conflicts and leave markers in the
1826 files. It will fail if there are any conflicts and leave markers in the
1826 partially merged file. Marker will have three sections, one from each
1827 partially merged file. Marker will have three sections, one from each
1827 side of the merge and one for the base content.
1828 side of the merge and one for the base content.
1828
1829
1829 ":other"
1830 ":other"
1830 Uses the other 'p2()' version of files as the merged version.
1831 Uses the other 'p2()' version of files as the merged version.
1831
1832
1832 ":prompt"
1833 ":prompt"
1833 Asks the user which of the local 'p1()' or the other 'p2()' version to
1834 Asks the user which of the local 'p1()' or the other 'p2()' version to
1834 keep as the merged version.
1835 keep as the merged version.
1835
1836
1836 ":tagmerge"
1837 ":tagmerge"
1837 Uses the internal tag merge algorithm (experimental).
1838 Uses the internal tag merge algorithm (experimental).
1838
1839
1839 ":union"
1840 ":union"
1840 Uses the internal non-interactive simple merge algorithm for merging
1841 Uses the internal non-interactive simple merge algorithm for merging
1841 files. It will use both left and right sides for conflict regions. No
1842 files. It will use both left and right sides for conflict regions. No
1842 markers are inserted.
1843 markers are inserted.
1843
1844
1844 Internal tools are always available and do not require a GUI but will by
1845 Internal tools are always available and do not require a GUI but will by
1845 default not handle symlinks or binary files.
1846 default not handle symlinks or binary files.
1846
1847
1847 Choosing a merge tool
1848 Choosing a merge tool
1848 =====================
1849 =====================
1849
1850
1850 Mercurial uses these rules when deciding which merge tool to use:
1851 Mercurial uses these rules when deciding which merge tool to use:
1851
1852
1852 1. If a tool has been specified with the --tool option to merge or
1853 1. If a tool has been specified with the --tool option to merge or
1853 resolve, it is used. If it is the name of a tool in the merge-tools
1854 resolve, it is used. If it is the name of a tool in the merge-tools
1854 configuration, its configuration is used. Otherwise the specified tool
1855 configuration, its configuration is used. Otherwise the specified tool
1855 must be executable by the shell.
1856 must be executable by the shell.
1856 2. If the "HGMERGE" environment variable is present, its value is used and
1857 2. If the "HGMERGE" environment variable is present, its value is used and
1857 must be executable by the shell.
1858 must be executable by the shell.
1858 3. If the filename of the file to be merged matches any of the patterns in
1859 3. If the filename of the file to be merged matches any of the patterns in
1859 the merge-patterns configuration section, the first usable merge tool
1860 the merge-patterns configuration section, the first usable merge tool
1860 corresponding to a matching pattern is used. Here, binary capabilities
1861 corresponding to a matching pattern is used. Here, binary capabilities
1861 of the merge tool are not considered.
1862 of the merge tool are not considered.
1862 4. If ui.merge is set it will be considered next. If the value is not the
1863 4. If ui.merge is set it will be considered next. If the value is not the
1863 name of a configured tool, the specified value is used and must be
1864 name of a configured tool, the specified value is used and must be
1864 executable by the shell. Otherwise the named tool is used if it is
1865 executable by the shell. Otherwise the named tool is used if it is
1865 usable.
1866 usable.
1866 5. If any usable merge tools are present in the merge-tools configuration
1867 5. If any usable merge tools are present in the merge-tools configuration
1867 section, the one with the highest priority is used.
1868 section, the one with the highest priority is used.
1868 6. If a program named "hgmerge" can be found on the system, it is used -
1869 6. If a program named "hgmerge" can be found on the system, it is used -
1869 but it will by default not be used for symlinks and binary files.
1870 but it will by default not be used for symlinks and binary files.
1870 7. If the file to be merged is not binary and is not a symlink, then
1871 7. If the file to be merged is not binary and is not a symlink, then
1871 internal ":merge" is used.
1872 internal ":merge" is used.
1872 8. Otherwise, ":prompt" is used.
1873 8. Otherwise, ":prompt" is used.
1873
1874
1874 Note:
1875 Note:
1875 After selecting a merge program, Mercurial will by default attempt to
1876 After selecting a merge program, Mercurial will by default attempt to
1876 merge the files using a simple merge algorithm first. Only if it
1877 merge the files using a simple merge algorithm first. Only if it
1877 doesn't succeed because of conflicting changes Mercurial will actually
1878 doesn't succeed because of conflicting changes Mercurial will actually
1878 execute the merge program. Whether to use the simple merge algorithm
1879 execute the merge program. Whether to use the simple merge algorithm
1879 first can be controlled by the premerge setting of the merge tool.
1880 first can be controlled by the premerge setting of the merge tool.
1880 Premerge is enabled by default unless the file is binary or a symlink.
1881 Premerge is enabled by default unless the file is binary or a symlink.
1881
1882
1882 See the merge-tools and ui sections of hgrc(5) for details on the
1883 See the merge-tools and ui sections of hgrc(5) for details on the
1883 configuration of merge tools.
1884 configuration of merge tools.
1884
1885
1885 Compression engines listed in `hg help bundlespec`
1886 Compression engines listed in `hg help bundlespec`
1886
1887
1887 $ hg help bundlespec | grep gzip
1888 $ hg help bundlespec | grep gzip
1888 "v1" bundles can only use the "gzip", "bzip2", and "none" compression
1889 "v1" bundles can only use the "gzip", "bzip2", and "none" compression
1889 An algorithm that produces smaller bundles than "gzip".
1890 An algorithm that produces smaller bundles than "gzip".
1890 This engine will likely produce smaller bundles than "gzip" but will be
1891 This engine will likely produce smaller bundles than "gzip" but will be
1891 "gzip"
1892 "gzip"
1892 better compression than "gzip". It also frequently yields better (?)
1893 better compression than "gzip". It also frequently yields better (?)
1893
1894
1894 Test usage of section marks in help documents
1895 Test usage of section marks in help documents
1895
1896
1896 $ cd "$TESTDIR"/../doc
1897 $ cd "$TESTDIR"/../doc
1897 $ $PYTHON check-seclevel.py
1898 $ $PYTHON check-seclevel.py
1898 $ cd $TESTTMP
1899 $ cd $TESTTMP
1899
1900
1900 #if serve
1901 #if serve
1901
1902
1902 Test the help pages in hgweb.
1903 Test the help pages in hgweb.
1903
1904
1904 Dish up an empty repo; serve it cold.
1905 Dish up an empty repo; serve it cold.
1905
1906
1906 $ hg init "$TESTTMP/test"
1907 $ hg init "$TESTTMP/test"
1907 $ hg serve -R "$TESTTMP/test" -n test -p $HGPORT -d --pid-file=hg.pid
1908 $ hg serve -R "$TESTTMP/test" -n test -p $HGPORT -d --pid-file=hg.pid
1908 $ cat hg.pid >> $DAEMON_PIDS
1909 $ cat hg.pid >> $DAEMON_PIDS
1909
1910
1910 $ get-with-headers.py $LOCALIP:$HGPORT "help"
1911 $ get-with-headers.py $LOCALIP:$HGPORT "help"
1911 200 Script output follows
1912 200 Script output follows
1912
1913
1913 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
1914 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
1914 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
1915 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
1915 <head>
1916 <head>
1916 <link rel="icon" href="/static/hgicon.png" type="image/png" />
1917 <link rel="icon" href="/static/hgicon.png" type="image/png" />
1917 <meta name="robots" content="index, nofollow" />
1918 <meta name="robots" content="index, nofollow" />
1918 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
1919 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
1919 <script type="text/javascript" src="/static/mercurial.js"></script>
1920 <script type="text/javascript" src="/static/mercurial.js"></script>
1920
1921
1921 <title>Help: Index</title>
1922 <title>Help: Index</title>
1922 </head>
1923 </head>
1923 <body>
1924 <body>
1924
1925
1925 <div class="container">
1926 <div class="container">
1926 <div class="menu">
1927 <div class="menu">
1927 <div class="logo">
1928 <div class="logo">
1928 <a href="https://mercurial-scm.org/">
1929 <a href="https://mercurial-scm.org/">
1929 <img src="/static/hglogo.png" alt="mercurial" /></a>
1930 <img src="/static/hglogo.png" alt="mercurial" /></a>
1930 </div>
1931 </div>
1931 <ul>
1932 <ul>
1932 <li><a href="/shortlog">log</a></li>
1933 <li><a href="/shortlog">log</a></li>
1933 <li><a href="/graph">graph</a></li>
1934 <li><a href="/graph">graph</a></li>
1934 <li><a href="/tags">tags</a></li>
1935 <li><a href="/tags">tags</a></li>
1935 <li><a href="/bookmarks">bookmarks</a></li>
1936 <li><a href="/bookmarks">bookmarks</a></li>
1936 <li><a href="/branches">branches</a></li>
1937 <li><a href="/branches">branches</a></li>
1937 </ul>
1938 </ul>
1938 <ul>
1939 <ul>
1939 <li class="active">help</li>
1940 <li class="active">help</li>
1940 </ul>
1941 </ul>
1941 </div>
1942 </div>
1942
1943
1943 <div class="main">
1944 <div class="main">
1944 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
1945 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
1945
1946
1946 <form class="search" action="/log">
1947 <form class="search" action="/log">
1947
1948
1948 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
1949 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
1949 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
1950 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
1950 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
1951 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
1951 </form>
1952 </form>
1952 <table class="bigtable">
1953 <table class="bigtable">
1953 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
1954 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
1954
1955
1955 <tr><td>
1956 <tr><td>
1956 <a href="/help/bundlespec">
1957 <a href="/help/bundlespec">
1957 bundlespec
1958 bundlespec
1958 </a>
1959 </a>
1959 </td><td>
1960 </td><td>
1960 Bundle File Formats
1961 Bundle File Formats
1961 </td></tr>
1962 </td></tr>
1962 <tr><td>
1963 <tr><td>
1963 <a href="/help/color">
1964 <a href="/help/color">
1964 color
1965 color
1965 </a>
1966 </a>
1966 </td><td>
1967 </td><td>
1967 Colorizing Outputs
1968 Colorizing Outputs
1968 </td></tr>
1969 </td></tr>
1969 <tr><td>
1970 <tr><td>
1970 <a href="/help/config">
1971 <a href="/help/config">
1971 config
1972 config
1972 </a>
1973 </a>
1973 </td><td>
1974 </td><td>
1974 Configuration Files
1975 Configuration Files
1975 </td></tr>
1976 </td></tr>
1976 <tr><td>
1977 <tr><td>
1977 <a href="/help/dates">
1978 <a href="/help/dates">
1978 dates
1979 dates
1979 </a>
1980 </a>
1980 </td><td>
1981 </td><td>
1981 Date Formats
1982 Date Formats
1982 </td></tr>
1983 </td></tr>
1983 <tr><td>
1984 <tr><td>
1984 <a href="/help/diffs">
1985 <a href="/help/diffs">
1985 diffs
1986 diffs
1986 </a>
1987 </a>
1987 </td><td>
1988 </td><td>
1988 Diff Formats
1989 Diff Formats
1989 </td></tr>
1990 </td></tr>
1990 <tr><td>
1991 <tr><td>
1991 <a href="/help/environment">
1992 <a href="/help/environment">
1992 environment
1993 environment
1993 </a>
1994 </a>
1994 </td><td>
1995 </td><td>
1995 Environment Variables
1996 Environment Variables
1996 </td></tr>
1997 </td></tr>
1997 <tr><td>
1998 <tr><td>
1998 <a href="/help/extensions">
1999 <a href="/help/extensions">
1999 extensions
2000 extensions
2000 </a>
2001 </a>
2001 </td><td>
2002 </td><td>
2002 Using Additional Features
2003 Using Additional Features
2003 </td></tr>
2004 </td></tr>
2004 <tr><td>
2005 <tr><td>
2005 <a href="/help/filesets">
2006 <a href="/help/filesets">
2006 filesets
2007 filesets
2007 </a>
2008 </a>
2008 </td><td>
2009 </td><td>
2009 Specifying File Sets
2010 Specifying File Sets
2010 </td></tr>
2011 </td></tr>
2011 <tr><td>
2012 <tr><td>
2012 <a href="/help/glossary">
2013 <a href="/help/glossary">
2013 glossary
2014 glossary
2014 </a>
2015 </a>
2015 </td><td>
2016 </td><td>
2016 Glossary
2017 Glossary
2017 </td></tr>
2018 </td></tr>
2018 <tr><td>
2019 <tr><td>
2019 <a href="/help/hgignore">
2020 <a href="/help/hgignore">
2020 hgignore
2021 hgignore
2021 </a>
2022 </a>
2022 </td><td>
2023 </td><td>
2023 Syntax for Mercurial Ignore Files
2024 Syntax for Mercurial Ignore Files
2024 </td></tr>
2025 </td></tr>
2025 <tr><td>
2026 <tr><td>
2026 <a href="/help/hgweb">
2027 <a href="/help/hgweb">
2027 hgweb
2028 hgweb
2028 </a>
2029 </a>
2029 </td><td>
2030 </td><td>
2030 Configuring hgweb
2031 Configuring hgweb
2031 </td></tr>
2032 </td></tr>
2032 <tr><td>
2033 <tr><td>
2033 <a href="/help/internals">
2034 <a href="/help/internals">
2034 internals
2035 internals
2035 </a>
2036 </a>
2036 </td><td>
2037 </td><td>
2037 Technical implementation topics
2038 Technical implementation topics
2038 </td></tr>
2039 </td></tr>
2039 <tr><td>
2040 <tr><td>
2040 <a href="/help/merge-tools">
2041 <a href="/help/merge-tools">
2041 merge-tools
2042 merge-tools
2042 </a>
2043 </a>
2043 </td><td>
2044 </td><td>
2044 Merge Tools
2045 Merge Tools
2045 </td></tr>
2046 </td></tr>
2046 <tr><td>
2047 <tr><td>
2047 <a href="/help/pager">
2048 <a href="/help/pager">
2048 pager
2049 pager
2049 </a>
2050 </a>
2050 </td><td>
2051 </td><td>
2051 Pager Support
2052 Pager Support
2052 </td></tr>
2053 </td></tr>
2053 <tr><td>
2054 <tr><td>
2054 <a href="/help/patterns">
2055 <a href="/help/patterns">
2055 patterns
2056 patterns
2056 </a>
2057 </a>
2057 </td><td>
2058 </td><td>
2058 File Name Patterns
2059 File Name Patterns
2059 </td></tr>
2060 </td></tr>
2060 <tr><td>
2061 <tr><td>
2061 <a href="/help/phases">
2062 <a href="/help/phases">
2062 phases
2063 phases
2063 </a>
2064 </a>
2064 </td><td>
2065 </td><td>
2065 Working with Phases
2066 Working with Phases
2066 </td></tr>
2067 </td></tr>
2067 <tr><td>
2068 <tr><td>
2068 <a href="/help/revisions">
2069 <a href="/help/revisions">
2069 revisions
2070 revisions
2070 </a>
2071 </a>
2071 </td><td>
2072 </td><td>
2072 Specifying Revisions
2073 Specifying Revisions
2073 </td></tr>
2074 </td></tr>
2074 <tr><td>
2075 <tr><td>
2075 <a href="/help/scripting">
2076 <a href="/help/scripting">
2076 scripting
2077 scripting
2077 </a>
2078 </a>
2078 </td><td>
2079 </td><td>
2079 Using Mercurial from scripts and automation
2080 Using Mercurial from scripts and automation
2080 </td></tr>
2081 </td></tr>
2081 <tr><td>
2082 <tr><td>
2082 <a href="/help/subrepos">
2083 <a href="/help/subrepos">
2083 subrepos
2084 subrepos
2084 </a>
2085 </a>
2085 </td><td>
2086 </td><td>
2086 Subrepositories
2087 Subrepositories
2087 </td></tr>
2088 </td></tr>
2088 <tr><td>
2089 <tr><td>
2089 <a href="/help/templating">
2090 <a href="/help/templating">
2090 templating
2091 templating
2091 </a>
2092 </a>
2092 </td><td>
2093 </td><td>
2093 Template Usage
2094 Template Usage
2094 </td></tr>
2095 </td></tr>
2095 <tr><td>
2096 <tr><td>
2096 <a href="/help/urls">
2097 <a href="/help/urls">
2097 urls
2098 urls
2098 </a>
2099 </a>
2099 </td><td>
2100 </td><td>
2100 URL Paths
2101 URL Paths
2101 </td></tr>
2102 </td></tr>
2102 <tr><td>
2103 <tr><td>
2103 <a href="/help/topic-containing-verbose">
2104 <a href="/help/topic-containing-verbose">
2104 topic-containing-verbose
2105 topic-containing-verbose
2105 </a>
2106 </a>
2106 </td><td>
2107 </td><td>
2107 This is the topic to test omit indicating.
2108 This is the topic to test omit indicating.
2108 </td></tr>
2109 </td></tr>
2109
2110
2110
2111
2111 <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
2112 <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
2112
2113
2113 <tr><td>
2114 <tr><td>
2114 <a href="/help/add">
2115 <a href="/help/add">
2115 add
2116 add
2116 </a>
2117 </a>
2117 </td><td>
2118 </td><td>
2118 add the specified files on the next commit
2119 add the specified files on the next commit
2119 </td></tr>
2120 </td></tr>
2120 <tr><td>
2121 <tr><td>
2121 <a href="/help/annotate">
2122 <a href="/help/annotate">
2122 annotate
2123 annotate
2123 </a>
2124 </a>
2124 </td><td>
2125 </td><td>
2125 show changeset information by line for each file
2126 show changeset information by line for each file
2126 </td></tr>
2127 </td></tr>
2127 <tr><td>
2128 <tr><td>
2128 <a href="/help/clone">
2129 <a href="/help/clone">
2129 clone
2130 clone
2130 </a>
2131 </a>
2131 </td><td>
2132 </td><td>
2132 make a copy of an existing repository
2133 make a copy of an existing repository
2133 </td></tr>
2134 </td></tr>
2134 <tr><td>
2135 <tr><td>
2135 <a href="/help/commit">
2136 <a href="/help/commit">
2136 commit
2137 commit
2137 </a>
2138 </a>
2138 </td><td>
2139 </td><td>
2139 commit the specified files or all outstanding changes
2140 commit the specified files or all outstanding changes
2140 </td></tr>
2141 </td></tr>
2141 <tr><td>
2142 <tr><td>
2142 <a href="/help/diff">
2143 <a href="/help/diff">
2143 diff
2144 diff
2144 </a>
2145 </a>
2145 </td><td>
2146 </td><td>
2146 diff repository (or selected files)
2147 diff repository (or selected files)
2147 </td></tr>
2148 </td></tr>
2148 <tr><td>
2149 <tr><td>
2149 <a href="/help/export">
2150 <a href="/help/export">
2150 export
2151 export
2151 </a>
2152 </a>
2152 </td><td>
2153 </td><td>
2153 dump the header and diffs for one or more changesets
2154 dump the header and diffs for one or more changesets
2154 </td></tr>
2155 </td></tr>
2155 <tr><td>
2156 <tr><td>
2156 <a href="/help/forget">
2157 <a href="/help/forget">
2157 forget
2158 forget
2158 </a>
2159 </a>
2159 </td><td>
2160 </td><td>
2160 forget the specified files on the next commit
2161 forget the specified files on the next commit
2161 </td></tr>
2162 </td></tr>
2162 <tr><td>
2163 <tr><td>
2163 <a href="/help/init">
2164 <a href="/help/init">
2164 init
2165 init
2165 </a>
2166 </a>
2166 </td><td>
2167 </td><td>
2167 create a new repository in the given directory
2168 create a new repository in the given directory
2168 </td></tr>
2169 </td></tr>
2169 <tr><td>
2170 <tr><td>
2170 <a href="/help/log">
2171 <a href="/help/log">
2171 log
2172 log
2172 </a>
2173 </a>
2173 </td><td>
2174 </td><td>
2174 show revision history of entire repository or files
2175 show revision history of entire repository or files
2175 </td></tr>
2176 </td></tr>
2176 <tr><td>
2177 <tr><td>
2177 <a href="/help/merge">
2178 <a href="/help/merge">
2178 merge
2179 merge
2179 </a>
2180 </a>
2180 </td><td>
2181 </td><td>
2181 merge another revision into working directory
2182 merge another revision into working directory
2182 </td></tr>
2183 </td></tr>
2183 <tr><td>
2184 <tr><td>
2184 <a href="/help/pull">
2185 <a href="/help/pull">
2185 pull
2186 pull
2186 </a>
2187 </a>
2187 </td><td>
2188 </td><td>
2188 pull changes from the specified source
2189 pull changes from the specified source
2189 </td></tr>
2190 </td></tr>
2190 <tr><td>
2191 <tr><td>
2191 <a href="/help/push">
2192 <a href="/help/push">
2192 push
2193 push
2193 </a>
2194 </a>
2194 </td><td>
2195 </td><td>
2195 push changes to the specified destination
2196 push changes to the specified destination
2196 </td></tr>
2197 </td></tr>
2197 <tr><td>
2198 <tr><td>
2198 <a href="/help/remove">
2199 <a href="/help/remove">
2199 remove
2200 remove
2200 </a>
2201 </a>
2201 </td><td>
2202 </td><td>
2202 remove the specified files on the next commit
2203 remove the specified files on the next commit
2203 </td></tr>
2204 </td></tr>
2204 <tr><td>
2205 <tr><td>
2205 <a href="/help/serve">
2206 <a href="/help/serve">
2206 serve
2207 serve
2207 </a>
2208 </a>
2208 </td><td>
2209 </td><td>
2209 start stand-alone webserver
2210 start stand-alone webserver
2210 </td></tr>
2211 </td></tr>
2211 <tr><td>
2212 <tr><td>
2212 <a href="/help/status">
2213 <a href="/help/status">
2213 status
2214 status
2214 </a>
2215 </a>
2215 </td><td>
2216 </td><td>
2216 show changed files in the working directory
2217 show changed files in the working directory
2217 </td></tr>
2218 </td></tr>
2218 <tr><td>
2219 <tr><td>
2219 <a href="/help/summary">
2220 <a href="/help/summary">
2220 summary
2221 summary
2221 </a>
2222 </a>
2222 </td><td>
2223 </td><td>
2223 summarize working directory state
2224 summarize working directory state
2224 </td></tr>
2225 </td></tr>
2225 <tr><td>
2226 <tr><td>
2226 <a href="/help/update">
2227 <a href="/help/update">
2227 update
2228 update
2228 </a>
2229 </a>
2229 </td><td>
2230 </td><td>
2230 update working directory (or switch revisions)
2231 update working directory (or switch revisions)
2231 </td></tr>
2232 </td></tr>
2232
2233
2233
2234
2234
2235
2235 <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
2236 <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
2236
2237
2237 <tr><td>
2238 <tr><td>
2238 <a href="/help/addremove">
2239 <a href="/help/addremove">
2239 addremove
2240 addremove
2240 </a>
2241 </a>
2241 </td><td>
2242 </td><td>
2242 add all new files, delete all missing files
2243 add all new files, delete all missing files
2243 </td></tr>
2244 </td></tr>
2244 <tr><td>
2245 <tr><td>
2245 <a href="/help/archive">
2246 <a href="/help/archive">
2246 archive
2247 archive
2247 </a>
2248 </a>
2248 </td><td>
2249 </td><td>
2249 create an unversioned archive of a repository revision
2250 create an unversioned archive of a repository revision
2250 </td></tr>
2251 </td></tr>
2251 <tr><td>
2252 <tr><td>
2252 <a href="/help/backout">
2253 <a href="/help/backout">
2253 backout
2254 backout
2254 </a>
2255 </a>
2255 </td><td>
2256 </td><td>
2256 reverse effect of earlier changeset
2257 reverse effect of earlier changeset
2257 </td></tr>
2258 </td></tr>
2258 <tr><td>
2259 <tr><td>
2259 <a href="/help/bisect">
2260 <a href="/help/bisect">
2260 bisect
2261 bisect
2261 </a>
2262 </a>
2262 </td><td>
2263 </td><td>
2263 subdivision search of changesets
2264 subdivision search of changesets
2264 </td></tr>
2265 </td></tr>
2265 <tr><td>
2266 <tr><td>
2266 <a href="/help/bookmarks">
2267 <a href="/help/bookmarks">
2267 bookmarks
2268 bookmarks
2268 </a>
2269 </a>
2269 </td><td>
2270 </td><td>
2270 create a new bookmark or list existing bookmarks
2271 create a new bookmark or list existing bookmarks
2271 </td></tr>
2272 </td></tr>
2272 <tr><td>
2273 <tr><td>
2273 <a href="/help/branch">
2274 <a href="/help/branch">
2274 branch
2275 branch
2275 </a>
2276 </a>
2276 </td><td>
2277 </td><td>
2277 set or show the current branch name
2278 set or show the current branch name
2278 </td></tr>
2279 </td></tr>
2279 <tr><td>
2280 <tr><td>
2280 <a href="/help/branches">
2281 <a href="/help/branches">
2281 branches
2282 branches
2282 </a>
2283 </a>
2283 </td><td>
2284 </td><td>
2284 list repository named branches
2285 list repository named branches
2285 </td></tr>
2286 </td></tr>
2286 <tr><td>
2287 <tr><td>
2287 <a href="/help/bundle">
2288 <a href="/help/bundle">
2288 bundle
2289 bundle
2289 </a>
2290 </a>
2290 </td><td>
2291 </td><td>
2291 create a bundle file
2292 create a bundle file
2292 </td></tr>
2293 </td></tr>
2293 <tr><td>
2294 <tr><td>
2294 <a href="/help/cat">
2295 <a href="/help/cat">
2295 cat
2296 cat
2296 </a>
2297 </a>
2297 </td><td>
2298 </td><td>
2298 output the current or given revision of files
2299 output the current or given revision of files
2299 </td></tr>
2300 </td></tr>
2300 <tr><td>
2301 <tr><td>
2301 <a href="/help/config">
2302 <a href="/help/config">
2302 config
2303 config
2303 </a>
2304 </a>
2304 </td><td>
2305 </td><td>
2305 show combined config settings from all hgrc files
2306 show combined config settings from all hgrc files
2306 </td></tr>
2307 </td></tr>
2307 <tr><td>
2308 <tr><td>
2308 <a href="/help/copy">
2309 <a href="/help/copy">
2309 copy
2310 copy
2310 </a>
2311 </a>
2311 </td><td>
2312 </td><td>
2312 mark files as copied for the next commit
2313 mark files as copied for the next commit
2313 </td></tr>
2314 </td></tr>
2314 <tr><td>
2315 <tr><td>
2315 <a href="/help/files">
2316 <a href="/help/files">
2316 files
2317 files
2317 </a>
2318 </a>
2318 </td><td>
2319 </td><td>
2319 list tracked files
2320 list tracked files
2320 </td></tr>
2321 </td></tr>
2321 <tr><td>
2322 <tr><td>
2322 <a href="/help/graft">
2323 <a href="/help/graft">
2323 graft
2324 graft
2324 </a>
2325 </a>
2325 </td><td>
2326 </td><td>
2326 copy changes from other branches onto the current branch
2327 copy changes from other branches onto the current branch
2327 </td></tr>
2328 </td></tr>
2328 <tr><td>
2329 <tr><td>
2329 <a href="/help/grep">
2330 <a href="/help/grep">
2330 grep
2331 grep
2331 </a>
2332 </a>
2332 </td><td>
2333 </td><td>
2333 search revision history for a pattern in specified files
2334 search revision history for a pattern in specified files
2334 </td></tr>
2335 </td></tr>
2335 <tr><td>
2336 <tr><td>
2336 <a href="/help/heads">
2337 <a href="/help/heads">
2337 heads
2338 heads
2338 </a>
2339 </a>
2339 </td><td>
2340 </td><td>
2340 show branch heads
2341 show branch heads
2341 </td></tr>
2342 </td></tr>
2342 <tr><td>
2343 <tr><td>
2343 <a href="/help/help">
2344 <a href="/help/help">
2344 help
2345 help
2345 </a>
2346 </a>
2346 </td><td>
2347 </td><td>
2347 show help for a given topic or a help overview
2348 show help for a given topic or a help overview
2348 </td></tr>
2349 </td></tr>
2349 <tr><td>
2350 <tr><td>
2350 <a href="/help/hgalias">
2351 <a href="/help/hgalias">
2351 hgalias
2352 hgalias
2352 </a>
2353 </a>
2353 </td><td>
2354 </td><td>
2354 summarize working directory state
2355 summarize working directory state
2355 </td></tr>
2356 </td></tr>
2356 <tr><td>
2357 <tr><td>
2357 <a href="/help/identify">
2358 <a href="/help/identify">
2358 identify
2359 identify
2359 </a>
2360 </a>
2360 </td><td>
2361 </td><td>
2361 identify the working directory or specified revision
2362 identify the working directory or specified revision
2362 </td></tr>
2363 </td></tr>
2363 <tr><td>
2364 <tr><td>
2364 <a href="/help/import">
2365 <a href="/help/import">
2365 import
2366 import
2366 </a>
2367 </a>
2367 </td><td>
2368 </td><td>
2368 import an ordered set of patches
2369 import an ordered set of patches
2369 </td></tr>
2370 </td></tr>
2370 <tr><td>
2371 <tr><td>
2371 <a href="/help/incoming">
2372 <a href="/help/incoming">
2372 incoming
2373 incoming
2373 </a>
2374 </a>
2374 </td><td>
2375 </td><td>
2375 show new changesets found in source
2376 show new changesets found in source
2376 </td></tr>
2377 </td></tr>
2377 <tr><td>
2378 <tr><td>
2378 <a href="/help/manifest">
2379 <a href="/help/manifest">
2379 manifest
2380 manifest
2380 </a>
2381 </a>
2381 </td><td>
2382 </td><td>
2382 output the current or given revision of the project manifest
2383 output the current or given revision of the project manifest
2383 </td></tr>
2384 </td></tr>
2384 <tr><td>
2385 <tr><td>
2385 <a href="/help/nohelp">
2386 <a href="/help/nohelp">
2386 nohelp
2387 nohelp
2387 </a>
2388 </a>
2388 </td><td>
2389 </td><td>
2389 (no help text available)
2390 (no help text available)
2390 </td></tr>
2391 </td></tr>
2391 <tr><td>
2392 <tr><td>
2392 <a href="/help/outgoing">
2393 <a href="/help/outgoing">
2393 outgoing
2394 outgoing
2394 </a>
2395 </a>
2395 </td><td>
2396 </td><td>
2396 show changesets not found in the destination
2397 show changesets not found in the destination
2397 </td></tr>
2398 </td></tr>
2398 <tr><td>
2399 <tr><td>
2399 <a href="/help/paths">
2400 <a href="/help/paths">
2400 paths
2401 paths
2401 </a>
2402 </a>
2402 </td><td>
2403 </td><td>
2403 show aliases for remote repositories
2404 show aliases for remote repositories
2404 </td></tr>
2405 </td></tr>
2405 <tr><td>
2406 <tr><td>
2406 <a href="/help/phase">
2407 <a href="/help/phase">
2407 phase
2408 phase
2408 </a>
2409 </a>
2409 </td><td>
2410 </td><td>
2410 set or show the current phase name
2411 set or show the current phase name
2411 </td></tr>
2412 </td></tr>
2412 <tr><td>
2413 <tr><td>
2413 <a href="/help/recover">
2414 <a href="/help/recover">
2414 recover
2415 recover
2415 </a>
2416 </a>
2416 </td><td>
2417 </td><td>
2417 roll back an interrupted transaction
2418 roll back an interrupted transaction
2418 </td></tr>
2419 </td></tr>
2419 <tr><td>
2420 <tr><td>
2420 <a href="/help/rename">
2421 <a href="/help/rename">
2421 rename
2422 rename
2422 </a>
2423 </a>
2423 </td><td>
2424 </td><td>
2424 rename files; equivalent of copy + remove
2425 rename files; equivalent of copy + remove
2425 </td></tr>
2426 </td></tr>
2426 <tr><td>
2427 <tr><td>
2427 <a href="/help/resolve">
2428 <a href="/help/resolve">
2428 resolve
2429 resolve
2429 </a>
2430 </a>
2430 </td><td>
2431 </td><td>
2431 redo merges or set/view the merge status of files
2432 redo merges or set/view the merge status of files
2432 </td></tr>
2433 </td></tr>
2433 <tr><td>
2434 <tr><td>
2434 <a href="/help/revert">
2435 <a href="/help/revert">
2435 revert
2436 revert
2436 </a>
2437 </a>
2437 </td><td>
2438 </td><td>
2438 restore files to their checkout state
2439 restore files to their checkout state
2439 </td></tr>
2440 </td></tr>
2440 <tr><td>
2441 <tr><td>
2441 <a href="/help/root">
2442 <a href="/help/root">
2442 root
2443 root
2443 </a>
2444 </a>
2444 </td><td>
2445 </td><td>
2445 print the root (top) of the current working directory
2446 print the root (top) of the current working directory
2446 </td></tr>
2447 </td></tr>
2447 <tr><td>
2448 <tr><td>
2448 <a href="/help/shellalias">
2449 <a href="/help/shellalias">
2449 shellalias
2450 shellalias
2450 </a>
2451 </a>
2451 </td><td>
2452 </td><td>
2452 (no help text available)
2453 (no help text available)
2453 </td></tr>
2454 </td></tr>
2454 <tr><td>
2455 <tr><td>
2455 <a href="/help/tag">
2456 <a href="/help/tag">
2456 tag
2457 tag
2457 </a>
2458 </a>
2458 </td><td>
2459 </td><td>
2459 add one or more tags for the current or given revision
2460 add one or more tags for the current or given revision
2460 </td></tr>
2461 </td></tr>
2461 <tr><td>
2462 <tr><td>
2462 <a href="/help/tags">
2463 <a href="/help/tags">
2463 tags
2464 tags
2464 </a>
2465 </a>
2465 </td><td>
2466 </td><td>
2466 list repository tags
2467 list repository tags
2467 </td></tr>
2468 </td></tr>
2468 <tr><td>
2469 <tr><td>
2469 <a href="/help/unbundle">
2470 <a href="/help/unbundle">
2470 unbundle
2471 unbundle
2471 </a>
2472 </a>
2472 </td><td>
2473 </td><td>
2473 apply one or more bundle files
2474 apply one or more bundle files
2474 </td></tr>
2475 </td></tr>
2475 <tr><td>
2476 <tr><td>
2476 <a href="/help/verify">
2477 <a href="/help/verify">
2477 verify
2478 verify
2478 </a>
2479 </a>
2479 </td><td>
2480 </td><td>
2480 verify the integrity of the repository
2481 verify the integrity of the repository
2481 </td></tr>
2482 </td></tr>
2482 <tr><td>
2483 <tr><td>
2483 <a href="/help/version">
2484 <a href="/help/version">
2484 version
2485 version
2485 </a>
2486 </a>
2486 </td><td>
2487 </td><td>
2487 output version and copyright information
2488 output version and copyright information
2488 </td></tr>
2489 </td></tr>
2489
2490
2490
2491
2491 </table>
2492 </table>
2492 </div>
2493 </div>
2493 </div>
2494 </div>
2494
2495
2495
2496
2496
2497
2497 </body>
2498 </body>
2498 </html>
2499 </html>
2499
2500
2500
2501
2501 $ get-with-headers.py $LOCALIP:$HGPORT "help/add"
2502 $ get-with-headers.py $LOCALIP:$HGPORT "help/add"
2502 200 Script output follows
2503 200 Script output follows
2503
2504
2504 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2505 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2505 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2506 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2506 <head>
2507 <head>
2507 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2508 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2508 <meta name="robots" content="index, nofollow" />
2509 <meta name="robots" content="index, nofollow" />
2509 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2510 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2510 <script type="text/javascript" src="/static/mercurial.js"></script>
2511 <script type="text/javascript" src="/static/mercurial.js"></script>
2511
2512
2512 <title>Help: add</title>
2513 <title>Help: add</title>
2513 </head>
2514 </head>
2514 <body>
2515 <body>
2515
2516
2516 <div class="container">
2517 <div class="container">
2517 <div class="menu">
2518 <div class="menu">
2518 <div class="logo">
2519 <div class="logo">
2519 <a href="https://mercurial-scm.org/">
2520 <a href="https://mercurial-scm.org/">
2520 <img src="/static/hglogo.png" alt="mercurial" /></a>
2521 <img src="/static/hglogo.png" alt="mercurial" /></a>
2521 </div>
2522 </div>
2522 <ul>
2523 <ul>
2523 <li><a href="/shortlog">log</a></li>
2524 <li><a href="/shortlog">log</a></li>
2524 <li><a href="/graph">graph</a></li>
2525 <li><a href="/graph">graph</a></li>
2525 <li><a href="/tags">tags</a></li>
2526 <li><a href="/tags">tags</a></li>
2526 <li><a href="/bookmarks">bookmarks</a></li>
2527 <li><a href="/bookmarks">bookmarks</a></li>
2527 <li><a href="/branches">branches</a></li>
2528 <li><a href="/branches">branches</a></li>
2528 </ul>
2529 </ul>
2529 <ul>
2530 <ul>
2530 <li class="active"><a href="/help">help</a></li>
2531 <li class="active"><a href="/help">help</a></li>
2531 </ul>
2532 </ul>
2532 </div>
2533 </div>
2533
2534
2534 <div class="main">
2535 <div class="main">
2535 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2536 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2536 <h3>Help: add</h3>
2537 <h3>Help: add</h3>
2537
2538
2538 <form class="search" action="/log">
2539 <form class="search" action="/log">
2539
2540
2540 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2541 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2541 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2542 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2542 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2543 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2543 </form>
2544 </form>
2544 <div id="doc">
2545 <div id="doc">
2545 <p>
2546 <p>
2546 hg add [OPTION]... [FILE]...
2547 hg add [OPTION]... [FILE]...
2547 </p>
2548 </p>
2548 <p>
2549 <p>
2549 add the specified files on the next commit
2550 add the specified files on the next commit
2550 </p>
2551 </p>
2551 <p>
2552 <p>
2552 Schedule files to be version controlled and added to the
2553 Schedule files to be version controlled and added to the
2553 repository.
2554 repository.
2554 </p>
2555 </p>
2555 <p>
2556 <p>
2556 The files will be added to the repository at the next commit. To
2557 The files will be added to the repository at the next commit. To
2557 undo an add before that, see 'hg forget'.
2558 undo an add before that, see 'hg forget'.
2558 </p>
2559 </p>
2559 <p>
2560 <p>
2560 If no names are given, add all files to the repository (except
2561 If no names are given, add all files to the repository (except
2561 files matching &quot;.hgignore&quot;).
2562 files matching &quot;.hgignore&quot;).
2562 </p>
2563 </p>
2563 <p>
2564 <p>
2564 Examples:
2565 Examples:
2565 </p>
2566 </p>
2566 <ul>
2567 <ul>
2567 <li> New (unknown) files are added automatically by 'hg add':
2568 <li> New (unknown) files are added automatically by 'hg add':
2568 <pre>
2569 <pre>
2569 \$ ls (re)
2570 \$ ls (re)
2570 foo.c
2571 foo.c
2571 \$ hg status (re)
2572 \$ hg status (re)
2572 ? foo.c
2573 ? foo.c
2573 \$ hg add (re)
2574 \$ hg add (re)
2574 adding foo.c
2575 adding foo.c
2575 \$ hg status (re)
2576 \$ hg status (re)
2576 A foo.c
2577 A foo.c
2577 </pre>
2578 </pre>
2578 <li> Specific files to be added can be specified:
2579 <li> Specific files to be added can be specified:
2579 <pre>
2580 <pre>
2580 \$ ls (re)
2581 \$ ls (re)
2581 bar.c foo.c
2582 bar.c foo.c
2582 \$ hg status (re)
2583 \$ hg status (re)
2583 ? bar.c
2584 ? bar.c
2584 ? foo.c
2585 ? foo.c
2585 \$ hg add bar.c (re)
2586 \$ hg add bar.c (re)
2586 \$ hg status (re)
2587 \$ hg status (re)
2587 A bar.c
2588 A bar.c
2588 ? foo.c
2589 ? foo.c
2589 </pre>
2590 </pre>
2590 </ul>
2591 </ul>
2591 <p>
2592 <p>
2592 Returns 0 if all files are successfully added.
2593 Returns 0 if all files are successfully added.
2593 </p>
2594 </p>
2594 <p>
2595 <p>
2595 options ([+] can be repeated):
2596 options ([+] can be repeated):
2596 </p>
2597 </p>
2597 <table>
2598 <table>
2598 <tr><td>-I</td>
2599 <tr><td>-I</td>
2599 <td>--include PATTERN [+]</td>
2600 <td>--include PATTERN [+]</td>
2600 <td>include names matching the given patterns</td></tr>
2601 <td>include names matching the given patterns</td></tr>
2601 <tr><td>-X</td>
2602 <tr><td>-X</td>
2602 <td>--exclude PATTERN [+]</td>
2603 <td>--exclude PATTERN [+]</td>
2603 <td>exclude names matching the given patterns</td></tr>
2604 <td>exclude names matching the given patterns</td></tr>
2604 <tr><td>-S</td>
2605 <tr><td>-S</td>
2605 <td>--subrepos</td>
2606 <td>--subrepos</td>
2606 <td>recurse into subrepositories</td></tr>
2607 <td>recurse into subrepositories</td></tr>
2607 <tr><td>-n</td>
2608 <tr><td>-n</td>
2608 <td>--dry-run</td>
2609 <td>--dry-run</td>
2609 <td>do not perform actions, just print output</td></tr>
2610 <td>do not perform actions, just print output</td></tr>
2610 </table>
2611 </table>
2611 <p>
2612 <p>
2612 global options ([+] can be repeated):
2613 global options ([+] can be repeated):
2613 </p>
2614 </p>
2614 <table>
2615 <table>
2615 <tr><td>-R</td>
2616 <tr><td>-R</td>
2616 <td>--repository REPO</td>
2617 <td>--repository REPO</td>
2617 <td>repository root directory or name of overlay bundle file</td></tr>
2618 <td>repository root directory or name of overlay bundle file</td></tr>
2618 <tr><td></td>
2619 <tr><td></td>
2619 <td>--cwd DIR</td>
2620 <td>--cwd DIR</td>
2620 <td>change working directory</td></tr>
2621 <td>change working directory</td></tr>
2621 <tr><td>-y</td>
2622 <tr><td>-y</td>
2622 <td>--noninteractive</td>
2623 <td>--noninteractive</td>
2623 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2624 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2624 <tr><td>-q</td>
2625 <tr><td>-q</td>
2625 <td>--quiet</td>
2626 <td>--quiet</td>
2626 <td>suppress output</td></tr>
2627 <td>suppress output</td></tr>
2627 <tr><td>-v</td>
2628 <tr><td>-v</td>
2628 <td>--verbose</td>
2629 <td>--verbose</td>
2629 <td>enable additional output</td></tr>
2630 <td>enable additional output</td></tr>
2630 <tr><td></td>
2631 <tr><td></td>
2631 <td>--color TYPE</td>
2632 <td>--color TYPE</td>
2632 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
2633 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
2633 <tr><td></td>
2634 <tr><td></td>
2634 <td>--config CONFIG [+]</td>
2635 <td>--config CONFIG [+]</td>
2635 <td>set/override config option (use 'section.name=value')</td></tr>
2636 <td>set/override config option (use 'section.name=value')</td></tr>
2636 <tr><td></td>
2637 <tr><td></td>
2637 <td>--debug</td>
2638 <td>--debug</td>
2638 <td>enable debugging output</td></tr>
2639 <td>enable debugging output</td></tr>
2639 <tr><td></td>
2640 <tr><td></td>
2640 <td>--debugger</td>
2641 <td>--debugger</td>
2641 <td>start debugger</td></tr>
2642 <td>start debugger</td></tr>
2642 <tr><td></td>
2643 <tr><td></td>
2643 <td>--encoding ENCODE</td>
2644 <td>--encoding ENCODE</td>
2644 <td>set the charset encoding (default: ascii)</td></tr>
2645 <td>set the charset encoding (default: ascii)</td></tr>
2645 <tr><td></td>
2646 <tr><td></td>
2646 <td>--encodingmode MODE</td>
2647 <td>--encodingmode MODE</td>
2647 <td>set the charset encoding mode (default: strict)</td></tr>
2648 <td>set the charset encoding mode (default: strict)</td></tr>
2648 <tr><td></td>
2649 <tr><td></td>
2649 <td>--traceback</td>
2650 <td>--traceback</td>
2650 <td>always print a traceback on exception</td></tr>
2651 <td>always print a traceback on exception</td></tr>
2651 <tr><td></td>
2652 <tr><td></td>
2652 <td>--time</td>
2653 <td>--time</td>
2653 <td>time how long the command takes</td></tr>
2654 <td>time how long the command takes</td></tr>
2654 <tr><td></td>
2655 <tr><td></td>
2655 <td>--profile</td>
2656 <td>--profile</td>
2656 <td>print command execution profile</td></tr>
2657 <td>print command execution profile</td></tr>
2657 <tr><td></td>
2658 <tr><td></td>
2658 <td>--version</td>
2659 <td>--version</td>
2659 <td>output version information and exit</td></tr>
2660 <td>output version information and exit</td></tr>
2660 <tr><td>-h</td>
2661 <tr><td>-h</td>
2661 <td>--help</td>
2662 <td>--help</td>
2662 <td>display help and exit</td></tr>
2663 <td>display help and exit</td></tr>
2663 <tr><td></td>
2664 <tr><td></td>
2664 <td>--hidden</td>
2665 <td>--hidden</td>
2665 <td>consider hidden changesets</td></tr>
2666 <td>consider hidden changesets</td></tr>
2666 <tr><td></td>
2667 <tr><td></td>
2667 <td>--pager TYPE</td>
2668 <td>--pager TYPE</td>
2668 <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
2669 <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
2669 </table>
2670 </table>
2670
2671
2671 </div>
2672 </div>
2672 </div>
2673 </div>
2673 </div>
2674 </div>
2674
2675
2675
2676
2676
2677
2677 </body>
2678 </body>
2678 </html>
2679 </html>
2679
2680
2680
2681
2681 $ get-with-headers.py $LOCALIP:$HGPORT "help/remove"
2682 $ get-with-headers.py $LOCALIP:$HGPORT "help/remove"
2682 200 Script output follows
2683 200 Script output follows
2683
2684
2684 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2685 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2685 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2686 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2686 <head>
2687 <head>
2687 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2688 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2688 <meta name="robots" content="index, nofollow" />
2689 <meta name="robots" content="index, nofollow" />
2689 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2690 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2690 <script type="text/javascript" src="/static/mercurial.js"></script>
2691 <script type="text/javascript" src="/static/mercurial.js"></script>
2691
2692
2692 <title>Help: remove</title>
2693 <title>Help: remove</title>
2693 </head>
2694 </head>
2694 <body>
2695 <body>
2695
2696
2696 <div class="container">
2697 <div class="container">
2697 <div class="menu">
2698 <div class="menu">
2698 <div class="logo">
2699 <div class="logo">
2699 <a href="https://mercurial-scm.org/">
2700 <a href="https://mercurial-scm.org/">
2700 <img src="/static/hglogo.png" alt="mercurial" /></a>
2701 <img src="/static/hglogo.png" alt="mercurial" /></a>
2701 </div>
2702 </div>
2702 <ul>
2703 <ul>
2703 <li><a href="/shortlog">log</a></li>
2704 <li><a href="/shortlog">log</a></li>
2704 <li><a href="/graph">graph</a></li>
2705 <li><a href="/graph">graph</a></li>
2705 <li><a href="/tags">tags</a></li>
2706 <li><a href="/tags">tags</a></li>
2706 <li><a href="/bookmarks">bookmarks</a></li>
2707 <li><a href="/bookmarks">bookmarks</a></li>
2707 <li><a href="/branches">branches</a></li>
2708 <li><a href="/branches">branches</a></li>
2708 </ul>
2709 </ul>
2709 <ul>
2710 <ul>
2710 <li class="active"><a href="/help">help</a></li>
2711 <li class="active"><a href="/help">help</a></li>
2711 </ul>
2712 </ul>
2712 </div>
2713 </div>
2713
2714
2714 <div class="main">
2715 <div class="main">
2715 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2716 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2716 <h3>Help: remove</h3>
2717 <h3>Help: remove</h3>
2717
2718
2718 <form class="search" action="/log">
2719 <form class="search" action="/log">
2719
2720
2720 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2721 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2721 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2722 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2722 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2723 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2723 </form>
2724 </form>
2724 <div id="doc">
2725 <div id="doc">
2725 <p>
2726 <p>
2726 hg remove [OPTION]... FILE...
2727 hg remove [OPTION]... FILE...
2727 </p>
2728 </p>
2728 <p>
2729 <p>
2729 aliases: rm
2730 aliases: rm
2730 </p>
2731 </p>
2731 <p>
2732 <p>
2732 remove the specified files on the next commit
2733 remove the specified files on the next commit
2733 </p>
2734 </p>
2734 <p>
2735 <p>
2735 Schedule the indicated files for removal from the current branch.
2736 Schedule the indicated files for removal from the current branch.
2736 </p>
2737 </p>
2737 <p>
2738 <p>
2738 This command schedules the files to be removed at the next commit.
2739 This command schedules the files to be removed at the next commit.
2739 To undo a remove before that, see 'hg revert'. To undo added
2740 To undo a remove before that, see 'hg revert'. To undo added
2740 files, see 'hg forget'.
2741 files, see 'hg forget'.
2741 </p>
2742 </p>
2742 <p>
2743 <p>
2743 -A/--after can be used to remove only files that have already
2744 -A/--after can be used to remove only files that have already
2744 been deleted, -f/--force can be used to force deletion, and -Af
2745 been deleted, -f/--force can be used to force deletion, and -Af
2745 can be used to remove files from the next revision without
2746 can be used to remove files from the next revision without
2746 deleting them from the working directory.
2747 deleting them from the working directory.
2747 </p>
2748 </p>
2748 <p>
2749 <p>
2749 The following table details the behavior of remove for different
2750 The following table details the behavior of remove for different
2750 file states (columns) and option combinations (rows). The file
2751 file states (columns) and option combinations (rows). The file
2751 states are Added [A], Clean [C], Modified [M] and Missing [!]
2752 states are Added [A], Clean [C], Modified [M] and Missing [!]
2752 (as reported by 'hg status'). The actions are Warn, Remove
2753 (as reported by 'hg status'). The actions are Warn, Remove
2753 (from branch) and Delete (from disk):
2754 (from branch) and Delete (from disk):
2754 </p>
2755 </p>
2755 <table>
2756 <table>
2756 <tr><td>opt/state</td>
2757 <tr><td>opt/state</td>
2757 <td>A</td>
2758 <td>A</td>
2758 <td>C</td>
2759 <td>C</td>
2759 <td>M</td>
2760 <td>M</td>
2760 <td>!</td></tr>
2761 <td>!</td></tr>
2761 <tr><td>none</td>
2762 <tr><td>none</td>
2762 <td>W</td>
2763 <td>W</td>
2763 <td>RD</td>
2764 <td>RD</td>
2764 <td>W</td>
2765 <td>W</td>
2765 <td>R</td></tr>
2766 <td>R</td></tr>
2766 <tr><td>-f</td>
2767 <tr><td>-f</td>
2767 <td>R</td>
2768 <td>R</td>
2768 <td>RD</td>
2769 <td>RD</td>
2769 <td>RD</td>
2770 <td>RD</td>
2770 <td>R</td></tr>
2771 <td>R</td></tr>
2771 <tr><td>-A</td>
2772 <tr><td>-A</td>
2772 <td>W</td>
2773 <td>W</td>
2773 <td>W</td>
2774 <td>W</td>
2774 <td>W</td>
2775 <td>W</td>
2775 <td>R</td></tr>
2776 <td>R</td></tr>
2776 <tr><td>-Af</td>
2777 <tr><td>-Af</td>
2777 <td>R</td>
2778 <td>R</td>
2778 <td>R</td>
2779 <td>R</td>
2779 <td>R</td>
2780 <td>R</td>
2780 <td>R</td></tr>
2781 <td>R</td></tr>
2781 </table>
2782 </table>
2782 <p>
2783 <p>
2783 <b>Note:</b>
2784 <b>Note:</b>
2784 </p>
2785 </p>
2785 <p>
2786 <p>
2786 'hg remove' never deletes files in Added [A] state from the
2787 'hg remove' never deletes files in Added [A] state from the
2787 working directory, not even if &quot;--force&quot; is specified.
2788 working directory, not even if &quot;--force&quot; is specified.
2788 </p>
2789 </p>
2789 <p>
2790 <p>
2790 Returns 0 on success, 1 if any warnings encountered.
2791 Returns 0 on success, 1 if any warnings encountered.
2791 </p>
2792 </p>
2792 <p>
2793 <p>
2793 options ([+] can be repeated):
2794 options ([+] can be repeated):
2794 </p>
2795 </p>
2795 <table>
2796 <table>
2796 <tr><td>-A</td>
2797 <tr><td>-A</td>
2797 <td>--after</td>
2798 <td>--after</td>
2798 <td>record delete for missing files</td></tr>
2799 <td>record delete for missing files</td></tr>
2799 <tr><td>-f</td>
2800 <tr><td>-f</td>
2800 <td>--force</td>
2801 <td>--force</td>
2801 <td>forget added files, delete modified files</td></tr>
2802 <td>forget added files, delete modified files</td></tr>
2802 <tr><td>-S</td>
2803 <tr><td>-S</td>
2803 <td>--subrepos</td>
2804 <td>--subrepos</td>
2804 <td>recurse into subrepositories</td></tr>
2805 <td>recurse into subrepositories</td></tr>
2805 <tr><td>-I</td>
2806 <tr><td>-I</td>
2806 <td>--include PATTERN [+]</td>
2807 <td>--include PATTERN [+]</td>
2807 <td>include names matching the given patterns</td></tr>
2808 <td>include names matching the given patterns</td></tr>
2808 <tr><td>-X</td>
2809 <tr><td>-X</td>
2809 <td>--exclude PATTERN [+]</td>
2810 <td>--exclude PATTERN [+]</td>
2810 <td>exclude names matching the given patterns</td></tr>
2811 <td>exclude names matching the given patterns</td></tr>
2811 </table>
2812 </table>
2812 <p>
2813 <p>
2813 global options ([+] can be repeated):
2814 global options ([+] can be repeated):
2814 </p>
2815 </p>
2815 <table>
2816 <table>
2816 <tr><td>-R</td>
2817 <tr><td>-R</td>
2817 <td>--repository REPO</td>
2818 <td>--repository REPO</td>
2818 <td>repository root directory or name of overlay bundle file</td></tr>
2819 <td>repository root directory or name of overlay bundle file</td></tr>
2819 <tr><td></td>
2820 <tr><td></td>
2820 <td>--cwd DIR</td>
2821 <td>--cwd DIR</td>
2821 <td>change working directory</td></tr>
2822 <td>change working directory</td></tr>
2822 <tr><td>-y</td>
2823 <tr><td>-y</td>
2823 <td>--noninteractive</td>
2824 <td>--noninteractive</td>
2824 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2825 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2825 <tr><td>-q</td>
2826 <tr><td>-q</td>
2826 <td>--quiet</td>
2827 <td>--quiet</td>
2827 <td>suppress output</td></tr>
2828 <td>suppress output</td></tr>
2828 <tr><td>-v</td>
2829 <tr><td>-v</td>
2829 <td>--verbose</td>
2830 <td>--verbose</td>
2830 <td>enable additional output</td></tr>
2831 <td>enable additional output</td></tr>
2831 <tr><td></td>
2832 <tr><td></td>
2832 <td>--color TYPE</td>
2833 <td>--color TYPE</td>
2833 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
2834 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
2834 <tr><td></td>
2835 <tr><td></td>
2835 <td>--config CONFIG [+]</td>
2836 <td>--config CONFIG [+]</td>
2836 <td>set/override config option (use 'section.name=value')</td></tr>
2837 <td>set/override config option (use 'section.name=value')</td></tr>
2837 <tr><td></td>
2838 <tr><td></td>
2838 <td>--debug</td>
2839 <td>--debug</td>
2839 <td>enable debugging output</td></tr>
2840 <td>enable debugging output</td></tr>
2840 <tr><td></td>
2841 <tr><td></td>
2841 <td>--debugger</td>
2842 <td>--debugger</td>
2842 <td>start debugger</td></tr>
2843 <td>start debugger</td></tr>
2843 <tr><td></td>
2844 <tr><td></td>
2844 <td>--encoding ENCODE</td>
2845 <td>--encoding ENCODE</td>
2845 <td>set the charset encoding (default: ascii)</td></tr>
2846 <td>set the charset encoding (default: ascii)</td></tr>
2846 <tr><td></td>
2847 <tr><td></td>
2847 <td>--encodingmode MODE</td>
2848 <td>--encodingmode MODE</td>
2848 <td>set the charset encoding mode (default: strict)</td></tr>
2849 <td>set the charset encoding mode (default: strict)</td></tr>
2849 <tr><td></td>
2850 <tr><td></td>
2850 <td>--traceback</td>
2851 <td>--traceback</td>
2851 <td>always print a traceback on exception</td></tr>
2852 <td>always print a traceback on exception</td></tr>
2852 <tr><td></td>
2853 <tr><td></td>
2853 <td>--time</td>
2854 <td>--time</td>
2854 <td>time how long the command takes</td></tr>
2855 <td>time how long the command takes</td></tr>
2855 <tr><td></td>
2856 <tr><td></td>
2856 <td>--profile</td>
2857 <td>--profile</td>
2857 <td>print command execution profile</td></tr>
2858 <td>print command execution profile</td></tr>
2858 <tr><td></td>
2859 <tr><td></td>
2859 <td>--version</td>
2860 <td>--version</td>
2860 <td>output version information and exit</td></tr>
2861 <td>output version information and exit</td></tr>
2861 <tr><td>-h</td>
2862 <tr><td>-h</td>
2862 <td>--help</td>
2863 <td>--help</td>
2863 <td>display help and exit</td></tr>
2864 <td>display help and exit</td></tr>
2864 <tr><td></td>
2865 <tr><td></td>
2865 <td>--hidden</td>
2866 <td>--hidden</td>
2866 <td>consider hidden changesets</td></tr>
2867 <td>consider hidden changesets</td></tr>
2867 <tr><td></td>
2868 <tr><td></td>
2868 <td>--pager TYPE</td>
2869 <td>--pager TYPE</td>
2869 <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
2870 <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
2870 </table>
2871 </table>
2871
2872
2872 </div>
2873 </div>
2873 </div>
2874 </div>
2874 </div>
2875 </div>
2875
2876
2876
2877
2877
2878
2878 </body>
2879 </body>
2879 </html>
2880 </html>
2880
2881
2881
2882
2882 $ get-with-headers.py $LOCALIP:$HGPORT "help/dates"
2883 $ get-with-headers.py $LOCALIP:$HGPORT "help/dates"
2883 200 Script output follows
2884 200 Script output follows
2884
2885
2885 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2886 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2886 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2887 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2887 <head>
2888 <head>
2888 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2889 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2889 <meta name="robots" content="index, nofollow" />
2890 <meta name="robots" content="index, nofollow" />
2890 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2891 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2891 <script type="text/javascript" src="/static/mercurial.js"></script>
2892 <script type="text/javascript" src="/static/mercurial.js"></script>
2892
2893
2893 <title>Help: dates</title>
2894 <title>Help: dates</title>
2894 </head>
2895 </head>
2895 <body>
2896 <body>
2896
2897
2897 <div class="container">
2898 <div class="container">
2898 <div class="menu">
2899 <div class="menu">
2899 <div class="logo">
2900 <div class="logo">
2900 <a href="https://mercurial-scm.org/">
2901 <a href="https://mercurial-scm.org/">
2901 <img src="/static/hglogo.png" alt="mercurial" /></a>
2902 <img src="/static/hglogo.png" alt="mercurial" /></a>
2902 </div>
2903 </div>
2903 <ul>
2904 <ul>
2904 <li><a href="/shortlog">log</a></li>
2905 <li><a href="/shortlog">log</a></li>
2905 <li><a href="/graph">graph</a></li>
2906 <li><a href="/graph">graph</a></li>
2906 <li><a href="/tags">tags</a></li>
2907 <li><a href="/tags">tags</a></li>
2907 <li><a href="/bookmarks">bookmarks</a></li>
2908 <li><a href="/bookmarks">bookmarks</a></li>
2908 <li><a href="/branches">branches</a></li>
2909 <li><a href="/branches">branches</a></li>
2909 </ul>
2910 </ul>
2910 <ul>
2911 <ul>
2911 <li class="active"><a href="/help">help</a></li>
2912 <li class="active"><a href="/help">help</a></li>
2912 </ul>
2913 </ul>
2913 </div>
2914 </div>
2914
2915
2915 <div class="main">
2916 <div class="main">
2916 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2917 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2917 <h3>Help: dates</h3>
2918 <h3>Help: dates</h3>
2918
2919
2919 <form class="search" action="/log">
2920 <form class="search" action="/log">
2920
2921
2921 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2922 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2922 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2923 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2923 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2924 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2924 </form>
2925 </form>
2925 <div id="doc">
2926 <div id="doc">
2926 <h1>Date Formats</h1>
2927 <h1>Date Formats</h1>
2927 <p>
2928 <p>
2928 Some commands allow the user to specify a date, e.g.:
2929 Some commands allow the user to specify a date, e.g.:
2929 </p>
2930 </p>
2930 <ul>
2931 <ul>
2931 <li> backout, commit, import, tag: Specify the commit date.
2932 <li> backout, commit, import, tag: Specify the commit date.
2932 <li> log, revert, update: Select revision(s) by date.
2933 <li> log, revert, update: Select revision(s) by date.
2933 </ul>
2934 </ul>
2934 <p>
2935 <p>
2935 Many date formats are valid. Here are some examples:
2936 Many date formats are valid. Here are some examples:
2936 </p>
2937 </p>
2937 <ul>
2938 <ul>
2938 <li> &quot;Wed Dec 6 13:18:29 2006&quot; (local timezone assumed)
2939 <li> &quot;Wed Dec 6 13:18:29 2006&quot; (local timezone assumed)
2939 <li> &quot;Dec 6 13:18 -0600&quot; (year assumed, time offset provided)
2940 <li> &quot;Dec 6 13:18 -0600&quot; (year assumed, time offset provided)
2940 <li> &quot;Dec 6 13:18 UTC&quot; (UTC and GMT are aliases for +0000)
2941 <li> &quot;Dec 6 13:18 UTC&quot; (UTC and GMT are aliases for +0000)
2941 <li> &quot;Dec 6&quot; (midnight)
2942 <li> &quot;Dec 6&quot; (midnight)
2942 <li> &quot;13:18&quot; (today assumed)
2943 <li> &quot;13:18&quot; (today assumed)
2943 <li> &quot;3:39&quot; (3:39AM assumed)
2944 <li> &quot;3:39&quot; (3:39AM assumed)
2944 <li> &quot;3:39pm&quot; (15:39)
2945 <li> &quot;3:39pm&quot; (15:39)
2945 <li> &quot;2006-12-06 13:18:29&quot; (ISO 8601 format)
2946 <li> &quot;2006-12-06 13:18:29&quot; (ISO 8601 format)
2946 <li> &quot;2006-12-6 13:18&quot;
2947 <li> &quot;2006-12-6 13:18&quot;
2947 <li> &quot;2006-12-6&quot;
2948 <li> &quot;2006-12-6&quot;
2948 <li> &quot;12-6&quot;
2949 <li> &quot;12-6&quot;
2949 <li> &quot;12/6&quot;
2950 <li> &quot;12/6&quot;
2950 <li> &quot;12/6/6&quot; (Dec 6 2006)
2951 <li> &quot;12/6/6&quot; (Dec 6 2006)
2951 <li> &quot;today&quot; (midnight)
2952 <li> &quot;today&quot; (midnight)
2952 <li> &quot;yesterday&quot; (midnight)
2953 <li> &quot;yesterday&quot; (midnight)
2953 <li> &quot;now&quot; - right now
2954 <li> &quot;now&quot; - right now
2954 </ul>
2955 </ul>
2955 <p>
2956 <p>
2956 Lastly, there is Mercurial's internal format:
2957 Lastly, there is Mercurial's internal format:
2957 </p>
2958 </p>
2958 <ul>
2959 <ul>
2959 <li> &quot;1165411109 0&quot; (Wed Dec 6 13:18:29 2006 UTC)
2960 <li> &quot;1165411109 0&quot; (Wed Dec 6 13:18:29 2006 UTC)
2960 </ul>
2961 </ul>
2961 <p>
2962 <p>
2962 This is the internal representation format for dates. The first number
2963 This is the internal representation format for dates. The first number
2963 is the number of seconds since the epoch (1970-01-01 00:00 UTC). The
2964 is the number of seconds since the epoch (1970-01-01 00:00 UTC). The
2964 second is the offset of the local timezone, in seconds west of UTC
2965 second is the offset of the local timezone, in seconds west of UTC
2965 (negative if the timezone is east of UTC).
2966 (negative if the timezone is east of UTC).
2966 </p>
2967 </p>
2967 <p>
2968 <p>
2968 The log command also accepts date ranges:
2969 The log command also accepts date ranges:
2969 </p>
2970 </p>
2970 <ul>
2971 <ul>
2971 <li> &quot;&lt;DATE&quot; - at or before a given date/time
2972 <li> &quot;&lt;DATE&quot; - at or before a given date/time
2972 <li> &quot;&gt;DATE&quot; - on or after a given date/time
2973 <li> &quot;&gt;DATE&quot; - on or after a given date/time
2973 <li> &quot;DATE to DATE&quot; - a date range, inclusive
2974 <li> &quot;DATE to DATE&quot; - a date range, inclusive
2974 <li> &quot;-DAYS&quot; - within a given number of days of today
2975 <li> &quot;-DAYS&quot; - within a given number of days of today
2975 </ul>
2976 </ul>
2976
2977
2977 </div>
2978 </div>
2978 </div>
2979 </div>
2979 </div>
2980 </div>
2980
2981
2981
2982
2982
2983
2983 </body>
2984 </body>
2984 </html>
2985 </html>
2985
2986
2986
2987
2987 Sub-topic indexes rendered properly
2988 Sub-topic indexes rendered properly
2988
2989
2989 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals"
2990 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals"
2990 200 Script output follows
2991 200 Script output follows
2991
2992
2992 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2993 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2993 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2994 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2994 <head>
2995 <head>
2995 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2996 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2996 <meta name="robots" content="index, nofollow" />
2997 <meta name="robots" content="index, nofollow" />
2997 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2998 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2998 <script type="text/javascript" src="/static/mercurial.js"></script>
2999 <script type="text/javascript" src="/static/mercurial.js"></script>
2999
3000
3000 <title>Help: internals</title>
3001 <title>Help: internals</title>
3001 </head>
3002 </head>
3002 <body>
3003 <body>
3003
3004
3004 <div class="container">
3005 <div class="container">
3005 <div class="menu">
3006 <div class="menu">
3006 <div class="logo">
3007 <div class="logo">
3007 <a href="https://mercurial-scm.org/">
3008 <a href="https://mercurial-scm.org/">
3008 <img src="/static/hglogo.png" alt="mercurial" /></a>
3009 <img src="/static/hglogo.png" alt="mercurial" /></a>
3009 </div>
3010 </div>
3010 <ul>
3011 <ul>
3011 <li><a href="/shortlog">log</a></li>
3012 <li><a href="/shortlog">log</a></li>
3012 <li><a href="/graph">graph</a></li>
3013 <li><a href="/graph">graph</a></li>
3013 <li><a href="/tags">tags</a></li>
3014 <li><a href="/tags">tags</a></li>
3014 <li><a href="/bookmarks">bookmarks</a></li>
3015 <li><a href="/bookmarks">bookmarks</a></li>
3015 <li><a href="/branches">branches</a></li>
3016 <li><a href="/branches">branches</a></li>
3016 </ul>
3017 </ul>
3017 <ul>
3018 <ul>
3018 <li><a href="/help">help</a></li>
3019 <li><a href="/help">help</a></li>
3019 </ul>
3020 </ul>
3020 </div>
3021 </div>
3021
3022
3022 <div class="main">
3023 <div class="main">
3023 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3024 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3024
3025
3025 <form class="search" action="/log">
3026 <form class="search" action="/log">
3026
3027
3027 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3028 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3028 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3029 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3029 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3030 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3030 </form>
3031 </form>
3031 <table class="bigtable">
3032 <table class="bigtable">
3032 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
3033 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
3033
3034
3034 <tr><td>
3035 <tr><td>
3035 <a href="/help/internals.bundles">
3036 <a href="/help/internals.bundles">
3036 bundles
3037 bundles
3037 </a>
3038 </a>
3038 </td><td>
3039 </td><td>
3039 Bundles
3040 Bundles
3040 </td></tr>
3041 </td></tr>
3041 <tr><td>
3042 <tr><td>
3042 <a href="/help/internals.censor">
3043 <a href="/help/internals.censor">
3043 censor
3044 censor
3044 </a>
3045 </a>
3045 </td><td>
3046 </td><td>
3046 Censor
3047 Censor
3047 </td></tr>
3048 </td></tr>
3048 <tr><td>
3049 <tr><td>
3049 <a href="/help/internals.changegroups">
3050 <a href="/help/internals.changegroups">
3050 changegroups
3051 changegroups
3051 </a>
3052 </a>
3052 </td><td>
3053 </td><td>
3053 Changegroups
3054 Changegroups
3054 </td></tr>
3055 </td></tr>
3055 <tr><td>
3056 <tr><td>
3056 <a href="/help/internals.requirements">
3057 <a href="/help/internals.requirements">
3057 requirements
3058 requirements
3058 </a>
3059 </a>
3059 </td><td>
3060 </td><td>
3060 Repository Requirements
3061 Repository Requirements
3061 </td></tr>
3062 </td></tr>
3062 <tr><td>
3063 <tr><td>
3063 <a href="/help/internals.revlogs">
3064 <a href="/help/internals.revlogs">
3064 revlogs
3065 revlogs
3065 </a>
3066 </a>
3066 </td><td>
3067 </td><td>
3067 Revision Logs
3068 Revision Logs
3068 </td></tr>
3069 </td></tr>
3069 <tr><td>
3070 <tr><td>
3070 <a href="/help/internals.wireprotocol">
3071 <a href="/help/internals.wireprotocol">
3071 wireprotocol
3072 wireprotocol
3072 </a>
3073 </a>
3073 </td><td>
3074 </td><td>
3074 Wire Protocol
3075 Wire Protocol
3075 </td></tr>
3076 </td></tr>
3076
3077
3077
3078
3078
3079
3079
3080
3080
3081
3081 </table>
3082 </table>
3082 </div>
3083 </div>
3083 </div>
3084 </div>
3084
3085
3085
3086
3086
3087
3087 </body>
3088 </body>
3088 </html>
3089 </html>
3089
3090
3090
3091
3091 Sub-topic topics rendered properly
3092 Sub-topic topics rendered properly
3092
3093
3093 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals.changegroups"
3094 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals.changegroups"
3094 200 Script output follows
3095 200 Script output follows
3095
3096
3096 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3097 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3097 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3098 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3098 <head>
3099 <head>
3099 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3100 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3100 <meta name="robots" content="index, nofollow" />
3101 <meta name="robots" content="index, nofollow" />
3101 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3102 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3102 <script type="text/javascript" src="/static/mercurial.js"></script>
3103 <script type="text/javascript" src="/static/mercurial.js"></script>
3103
3104
3104 <title>Help: internals.changegroups</title>
3105 <title>Help: internals.changegroups</title>
3105 </head>
3106 </head>
3106 <body>
3107 <body>
3107
3108
3108 <div class="container">
3109 <div class="container">
3109 <div class="menu">
3110 <div class="menu">
3110 <div class="logo">
3111 <div class="logo">
3111 <a href="https://mercurial-scm.org/">
3112 <a href="https://mercurial-scm.org/">
3112 <img src="/static/hglogo.png" alt="mercurial" /></a>
3113 <img src="/static/hglogo.png" alt="mercurial" /></a>
3113 </div>
3114 </div>
3114 <ul>
3115 <ul>
3115 <li><a href="/shortlog">log</a></li>
3116 <li><a href="/shortlog">log</a></li>
3116 <li><a href="/graph">graph</a></li>
3117 <li><a href="/graph">graph</a></li>
3117 <li><a href="/tags">tags</a></li>
3118 <li><a href="/tags">tags</a></li>
3118 <li><a href="/bookmarks">bookmarks</a></li>
3119 <li><a href="/bookmarks">bookmarks</a></li>
3119 <li><a href="/branches">branches</a></li>
3120 <li><a href="/branches">branches</a></li>
3120 </ul>
3121 </ul>
3121 <ul>
3122 <ul>
3122 <li class="active"><a href="/help">help</a></li>
3123 <li class="active"><a href="/help">help</a></li>
3123 </ul>
3124 </ul>
3124 </div>
3125 </div>
3125
3126
3126 <div class="main">
3127 <div class="main">
3127 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3128 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3128 <h3>Help: internals.changegroups</h3>
3129 <h3>Help: internals.changegroups</h3>
3129
3130
3130 <form class="search" action="/log">
3131 <form class="search" action="/log">
3131
3132
3132 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3133 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3133 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3134 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3134 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3135 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3135 </form>
3136 </form>
3136 <div id="doc">
3137 <div id="doc">
3137 <h1>Changegroups</h1>
3138 <h1>Changegroups</h1>
3138 <p>
3139 <p>
3139 Changegroups are representations of repository revlog data, specifically
3140 Changegroups are representations of repository revlog data, specifically
3140 the changelog data, root/flat manifest data, treemanifest data, and
3141 the changelog data, root/flat manifest data, treemanifest data, and
3141 filelogs.
3142 filelogs.
3142 </p>
3143 </p>
3143 <p>
3144 <p>
3144 There are 3 versions of changegroups: &quot;1&quot;, &quot;2&quot;, and &quot;3&quot;. From a
3145 There are 3 versions of changegroups: &quot;1&quot;, &quot;2&quot;, and &quot;3&quot;. From a
3145 high-level, versions &quot;1&quot; and &quot;2&quot; are almost exactly the same, with the
3146 high-level, versions &quot;1&quot; and &quot;2&quot; are almost exactly the same, with the
3146 only difference being an additional item in the *delta header*. Version
3147 only difference being an additional item in the *delta header*. Version
3147 &quot;3&quot; adds support for revlog flags in the *delta header* and optionally
3148 &quot;3&quot; adds support for revlog flags in the *delta header* and optionally
3148 exchanging treemanifests (enabled by setting an option on the
3149 exchanging treemanifests (enabled by setting an option on the
3149 &quot;changegroup&quot; part in the bundle2).
3150 &quot;changegroup&quot; part in the bundle2).
3150 </p>
3151 </p>
3151 <p>
3152 <p>
3152 Changegroups when not exchanging treemanifests consist of 3 logical
3153 Changegroups when not exchanging treemanifests consist of 3 logical
3153 segments:
3154 segments:
3154 </p>
3155 </p>
3155 <pre>
3156 <pre>
3156 +---------------------------------+
3157 +---------------------------------+
3157 | | | |
3158 | | | |
3158 | changeset | manifest | filelogs |
3159 | changeset | manifest | filelogs |
3159 | | | |
3160 | | | |
3160 | | | |
3161 | | | |
3161 +---------------------------------+
3162 +---------------------------------+
3162 </pre>
3163 </pre>
3163 <p>
3164 <p>
3164 When exchanging treemanifests, there are 4 logical segments:
3165 When exchanging treemanifests, there are 4 logical segments:
3165 </p>
3166 </p>
3166 <pre>
3167 <pre>
3167 +-------------------------------------------------+
3168 +-------------------------------------------------+
3168 | | | | |
3169 | | | | |
3169 | changeset | root | treemanifests | filelogs |
3170 | changeset | root | treemanifests | filelogs |
3170 | | manifest | | |
3171 | | manifest | | |
3171 | | | | |
3172 | | | | |
3172 +-------------------------------------------------+
3173 +-------------------------------------------------+
3173 </pre>
3174 </pre>
3174 <p>
3175 <p>
3175 The principle building block of each segment is a *chunk*. A *chunk*
3176 The principle building block of each segment is a *chunk*. A *chunk*
3176 is a framed piece of data:
3177 is a framed piece of data:
3177 </p>
3178 </p>
3178 <pre>
3179 <pre>
3179 +---------------------------------------+
3180 +---------------------------------------+
3180 | | |
3181 | | |
3181 | length | data |
3182 | length | data |
3182 | (4 bytes) | (&lt;length - 4&gt; bytes) |
3183 | (4 bytes) | (&lt;length - 4&gt; bytes) |
3183 | | |
3184 | | |
3184 +---------------------------------------+
3185 +---------------------------------------+
3185 </pre>
3186 </pre>
3186 <p>
3187 <p>
3187 All integers are big-endian signed integers. Each chunk starts with a 32-bit
3188 All integers are big-endian signed integers. Each chunk starts with a 32-bit
3188 integer indicating the length of the entire chunk (including the length field
3189 integer indicating the length of the entire chunk (including the length field
3189 itself).
3190 itself).
3190 </p>
3191 </p>
3191 <p>
3192 <p>
3192 There is a special case chunk that has a value of 0 for the length
3193 There is a special case chunk that has a value of 0 for the length
3193 (&quot;0x00000000&quot;). We call this an *empty chunk*.
3194 (&quot;0x00000000&quot;). We call this an *empty chunk*.
3194 </p>
3195 </p>
3195 <h2>Delta Groups</h2>
3196 <h2>Delta Groups</h2>
3196 <p>
3197 <p>
3197 A *delta group* expresses the content of a revlog as a series of deltas,
3198 A *delta group* expresses the content of a revlog as a series of deltas,
3198 or patches against previous revisions.
3199 or patches against previous revisions.
3199 </p>
3200 </p>
3200 <p>
3201 <p>
3201 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
3202 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
3202 to signal the end of the delta group:
3203 to signal the end of the delta group:
3203 </p>
3204 </p>
3204 <pre>
3205 <pre>
3205 +------------------------------------------------------------------------+
3206 +------------------------------------------------------------------------+
3206 | | | | | |
3207 | | | | | |
3207 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
3208 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
3208 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
3209 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
3209 | | | | | |
3210 | | | | | |
3210 +------------------------------------------------------------------------+
3211 +------------------------------------------------------------------------+
3211 </pre>
3212 </pre>
3212 <p>
3213 <p>
3213 Each *chunk*'s data consists of the following:
3214 Each *chunk*'s data consists of the following:
3214 </p>
3215 </p>
3215 <pre>
3216 <pre>
3216 +---------------------------------------+
3217 +---------------------------------------+
3217 | | |
3218 | | |
3218 | delta header | delta data |
3219 | delta header | delta data |
3219 | (various by version) | (various) |
3220 | (various by version) | (various) |
3220 | | |
3221 | | |
3221 +---------------------------------------+
3222 +---------------------------------------+
3222 </pre>
3223 </pre>
3223 <p>
3224 <p>
3224 The *delta data* is a series of *delta*s that describe a diff from an existing
3225 The *delta data* is a series of *delta*s that describe a diff from an existing
3225 entry (either that the recipient already has, or previously specified in the
3226 entry (either that the recipient already has, or previously specified in the
3226 bundle/changegroup).
3227 bundle/changegroup).
3227 </p>
3228 </p>
3228 <p>
3229 <p>
3229 The *delta header* is different between versions &quot;1&quot;, &quot;2&quot;, and
3230 The *delta header* is different between versions &quot;1&quot;, &quot;2&quot;, and
3230 &quot;3&quot; of the changegroup format.
3231 &quot;3&quot; of the changegroup format.
3231 </p>
3232 </p>
3232 <p>
3233 <p>
3233 Version 1 (headerlen=80):
3234 Version 1 (headerlen=80):
3234 </p>
3235 </p>
3235 <pre>
3236 <pre>
3236 +------------------------------------------------------+
3237 +------------------------------------------------------+
3237 | | | | |
3238 | | | | |
3238 | node | p1 node | p2 node | link node |
3239 | node | p1 node | p2 node | link node |
3239 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
3240 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
3240 | | | | |
3241 | | | | |
3241 +------------------------------------------------------+
3242 +------------------------------------------------------+
3242 </pre>
3243 </pre>
3243 <p>
3244 <p>
3244 Version 2 (headerlen=100):
3245 Version 2 (headerlen=100):
3245 </p>
3246 </p>
3246 <pre>
3247 <pre>
3247 +------------------------------------------------------------------+
3248 +------------------------------------------------------------------+
3248 | | | | | |
3249 | | | | | |
3249 | node | p1 node | p2 node | base node | link node |
3250 | node | p1 node | p2 node | base node | link node |
3250 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
3251 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
3251 | | | | | |
3252 | | | | | |
3252 +------------------------------------------------------------------+
3253 +------------------------------------------------------------------+
3253 </pre>
3254 </pre>
3254 <p>
3255 <p>
3255 Version 3 (headerlen=102):
3256 Version 3 (headerlen=102):
3256 </p>
3257 </p>
3257 <pre>
3258 <pre>
3258 +------------------------------------------------------------------------------+
3259 +------------------------------------------------------------------------------+
3259 | | | | | | |
3260 | | | | | | |
3260 | node | p1 node | p2 node | base node | link node | flags |
3261 | node | p1 node | p2 node | base node | link node | flags |
3261 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
3262 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
3262 | | | | | | |
3263 | | | | | | |
3263 +------------------------------------------------------------------------------+
3264 +------------------------------------------------------------------------------+
3264 </pre>
3265 </pre>
3265 <p>
3266 <p>
3266 The *delta data* consists of &quot;chunklen - 4 - headerlen&quot; bytes, which contain a
3267 The *delta data* consists of &quot;chunklen - 4 - headerlen&quot; bytes, which contain a
3267 series of *delta*s, densely packed (no separators). These deltas describe a diff
3268 series of *delta*s, densely packed (no separators). These deltas describe a diff
3268 from an existing entry (either that the recipient already has, or previously
3269 from an existing entry (either that the recipient already has, or previously
3269 specified in the bundle/changegroup). The format is described more fully in
3270 specified in the bundle/changegroup). The format is described more fully in
3270 &quot;hg help internals.bdiff&quot;, but briefly:
3271 &quot;hg help internals.bdiff&quot;, but briefly:
3271 </p>
3272 </p>
3272 <pre>
3273 <pre>
3273 +---------------------------------------------------------------+
3274 +---------------------------------------------------------------+
3274 | | | | |
3275 | | | | |
3275 | start offset | end offset | new length | content |
3276 | start offset | end offset | new length | content |
3276 | (4 bytes) | (4 bytes) | (4 bytes) | (&lt;new length&gt; bytes) |
3277 | (4 bytes) | (4 bytes) | (4 bytes) | (&lt;new length&gt; bytes) |
3277 | | | | |
3278 | | | | |
3278 +---------------------------------------------------------------+
3279 +---------------------------------------------------------------+
3279 </pre>
3280 </pre>
3280 <p>
3281 <p>
3281 Please note that the length field in the delta data does *not* include itself.
3282 Please note that the length field in the delta data does *not* include itself.
3282 </p>
3283 </p>
3283 <p>
3284 <p>
3284 In version 1, the delta is always applied against the previous node from
3285 In version 1, the delta is always applied against the previous node from
3285 the changegroup or the first parent if this is the first entry in the
3286 the changegroup or the first parent if this is the first entry in the
3286 changegroup.
3287 changegroup.
3287 </p>
3288 </p>
3288 <p>
3289 <p>
3289 In version 2 and up, the delta base node is encoded in the entry in the
3290 In version 2 and up, the delta base node is encoded in the entry in the
3290 changegroup. This allows the delta to be expressed against any parent,
3291 changegroup. This allows the delta to be expressed against any parent,
3291 which can result in smaller deltas and more efficient encoding of data.
3292 which can result in smaller deltas and more efficient encoding of data.
3292 </p>
3293 </p>
3293 <h2>Changeset Segment</h2>
3294 <h2>Changeset Segment</h2>
3294 <p>
3295 <p>
3295 The *changeset segment* consists of a single *delta group* holding
3296 The *changeset segment* consists of a single *delta group* holding
3296 changelog data. The *empty chunk* at the end of the *delta group* denotes
3297 changelog data. The *empty chunk* at the end of the *delta group* denotes
3297 the boundary to the *manifest segment*.
3298 the boundary to the *manifest segment*.
3298 </p>
3299 </p>
3299 <h2>Manifest Segment</h2>
3300 <h2>Manifest Segment</h2>
3300 <p>
3301 <p>
3301 The *manifest segment* consists of a single *delta group* holding manifest
3302 The *manifest segment* consists of a single *delta group* holding manifest
3302 data. If treemanifests are in use, it contains only the manifest for the
3303 data. If treemanifests are in use, it contains only the manifest for the
3303 root directory of the repository. Otherwise, it contains the entire
3304 root directory of the repository. Otherwise, it contains the entire
3304 manifest data. The *empty chunk* at the end of the *delta group* denotes
3305 manifest data. The *empty chunk* at the end of the *delta group* denotes
3305 the boundary to the next segment (either the *treemanifests segment* or the
3306 the boundary to the next segment (either the *treemanifests segment* or the
3306 *filelogs segment*, depending on version and the request options).
3307 *filelogs segment*, depending on version and the request options).
3307 </p>
3308 </p>
3308 <h3>Treemanifests Segment</h3>
3309 <h3>Treemanifests Segment</h3>
3309 <p>
3310 <p>
3310 The *treemanifests segment* only exists in changegroup version &quot;3&quot;, and
3311 The *treemanifests segment* only exists in changegroup version &quot;3&quot;, and
3311 only if the 'treemanifest' param is part of the bundle2 changegroup part
3312 only if the 'treemanifest' param is part of the bundle2 changegroup part
3312 (it is not possible to use changegroup version 3 outside of bundle2).
3313 (it is not possible to use changegroup version 3 outside of bundle2).
3313 Aside from the filenames in the *treemanifests segment* containing a
3314 Aside from the filenames in the *treemanifests segment* containing a
3314 trailing &quot;/&quot; character, it behaves identically to the *filelogs segment*
3315 trailing &quot;/&quot; character, it behaves identically to the *filelogs segment*
3315 (see below). The final sub-segment is followed by an *empty chunk* (logically,
3316 (see below). The final sub-segment is followed by an *empty chunk* (logically,
3316 a sub-segment with filename size 0). This denotes the boundary to the
3317 a sub-segment with filename size 0). This denotes the boundary to the
3317 *filelogs segment*.
3318 *filelogs segment*.
3318 </p>
3319 </p>
3319 <h2>Filelogs Segment</h2>
3320 <h2>Filelogs Segment</h2>
3320 <p>
3321 <p>
3321 The *filelogs segment* consists of multiple sub-segments, each
3322 The *filelogs segment* consists of multiple sub-segments, each
3322 corresponding to an individual file whose data is being described:
3323 corresponding to an individual file whose data is being described:
3323 </p>
3324 </p>
3324 <pre>
3325 <pre>
3325 +--------------------------------------------------+
3326 +--------------------------------------------------+
3326 | | | | | |
3327 | | | | | |
3327 | filelog0 | filelog1 | filelog2 | ... | 0x0 |
3328 | filelog0 | filelog1 | filelog2 | ... | 0x0 |
3328 | | | | | (4 bytes) |
3329 | | | | | (4 bytes) |
3329 | | | | | |
3330 | | | | | |
3330 +--------------------------------------------------+
3331 +--------------------------------------------------+
3331 </pre>
3332 </pre>
3332 <p>
3333 <p>
3333 The final filelog sub-segment is followed by an *empty chunk* (logically,
3334 The final filelog sub-segment is followed by an *empty chunk* (logically,
3334 a sub-segment with filename size 0). This denotes the end of the segment
3335 a sub-segment with filename size 0). This denotes the end of the segment
3335 and of the overall changegroup.
3336 and of the overall changegroup.
3336 </p>
3337 </p>
3337 <p>
3338 <p>
3338 Each filelog sub-segment consists of the following:
3339 Each filelog sub-segment consists of the following:
3339 </p>
3340 </p>
3340 <pre>
3341 <pre>
3341 +------------------------------------------------------+
3342 +------------------------------------------------------+
3342 | | | |
3343 | | | |
3343 | filename length | filename | delta group |
3344 | filename length | filename | delta group |
3344 | (4 bytes) | (&lt;length - 4&gt; bytes) | (various) |
3345 | (4 bytes) | (&lt;length - 4&gt; bytes) | (various) |
3345 | | | |
3346 | | | |
3346 +------------------------------------------------------+
3347 +------------------------------------------------------+
3347 </pre>
3348 </pre>
3348 <p>
3349 <p>
3349 That is, a *chunk* consisting of the filename (not terminated or padded)
3350 That is, a *chunk* consisting of the filename (not terminated or padded)
3350 followed by N chunks constituting the *delta group* for this file. The
3351 followed by N chunks constituting the *delta group* for this file. The
3351 *empty chunk* at the end of each *delta group* denotes the boundary to the
3352 *empty chunk* at the end of each *delta group* denotes the boundary to the
3352 next filelog sub-segment.
3353 next filelog sub-segment.
3353 </p>
3354 </p>
3354
3355
3355 </div>
3356 </div>
3356 </div>
3357 </div>
3357 </div>
3358 </div>
3358
3359
3359
3360
3360
3361
3361 </body>
3362 </body>
3362 </html>
3363 </html>
3363
3364
3364
3365
3365 $ killdaemons.py
3366 $ killdaemons.py
3366
3367
3367 #endif
3368 #endif
General Comments 0
You need to be logged in to leave comments. Login now