comparison mercurial/commands.py @ 19997:de16c673455b stable

documentation: add an extra newline after note directive Like this no docutils version interprets any line in the following text as argument of note.
author Simon Heimberg <simohe@besonet.ch>
date Tue, 05 Nov 2013 08:59:55 +0100
parents 95304251c376
children 84905561ad41 1dee888b22f7
comparison
equal deleted inserted replaced
19996:52b437586435 19997:de16c673455b
395 If REV is the parent of the working directory, then this new changeset 395 If REV is the parent of the working directory, then this new changeset
396 is committed automatically. Otherwise, hg needs to merge the 396 is committed automatically. Otherwise, hg needs to merge the
397 changes and the merged result is left uncommitted. 397 changes and the merged result is left uncommitted.
398 398
399 .. note:: 399 .. note::
400
400 backout cannot be used to fix either an unwanted or 401 backout cannot be used to fix either an unwanted or
401 incorrect merge. 402 incorrect merge.
402 403
403 .. container:: verbose 404 .. container:: verbose
404 405
935 _('[-fC] [NAME]')) 936 _('[-fC] [NAME]'))
936 def branch(ui, repo, label=None, **opts): 937 def branch(ui, repo, label=None, **opts):
937 """set or show the current branch name 938 """set or show the current branch name
938 939
939 .. note:: 940 .. note::
941
940 Branch names are permanent and global. Use :hg:`bookmark` to create a 942 Branch names are permanent and global. Use :hg:`bookmark` to create a
941 light-weight bookmark instead. See :hg:`help glossary` for more 943 light-weight bookmark instead. See :hg:`help glossary` for more
942 information about named branches and bookmarks. 944 information about named branches and bookmarks.
943 945
944 With no argument, show the current branch name. With one argument, 946 With no argument, show the current branch name. With one argument,
2705 Show differences between revisions for the specified files. 2707 Show differences between revisions for the specified files.
2706 2708
2707 Differences between files are shown using the unified diff format. 2709 Differences between files are shown using the unified diff format.
2708 2710
2709 .. note:: 2711 .. note::
2712
2710 diff may generate unexpected results for merges, as it will 2713 diff may generate unexpected results for merges, as it will
2711 default to comparing against the working directory's first 2714 default to comparing against the working directory's first
2712 parent changeset if no revisions are specified. 2715 parent changeset if no revisions are specified.
2713 2716
2714 When two revision arguments are given, then changes are shown 2717 When two revision arguments are given, then changes are shown
2794 The information shown in the changeset header is: author, date, 2797 The information shown in the changeset header is: author, date,
2795 branch name (if non-default), changeset hash, parent(s) and commit 2798 branch name (if non-default), changeset hash, parent(s) and commit
2796 comment. 2799 comment.
2797 2800
2798 .. note:: 2801 .. note::
2802
2799 export may generate unexpected diff output for merge 2803 export may generate unexpected diff output for merge
2800 changesets, as it will compare the merge changeset against its 2804 changesets, as it will compare the merge changeset against its
2801 first parent only. 2805 first parent only.
2802 2806
2803 Output may be to a file, in which case the name of the file is 2807 Output may be to a file, in which case the name of the file is
2926 interrupted so that the current merge can be manually resolved. 2930 interrupted so that the current merge can be manually resolved.
2927 Once all conflicts are addressed, the graft process can be 2931 Once all conflicts are addressed, the graft process can be
2928 continued with the -c/--continue option. 2932 continued with the -c/--continue option.
2929 2933
2930 .. note:: 2934 .. note::
2935
2931 The -c/--continue option does not reapply earlier options. 2936 The -c/--continue option does not reapply earlier options.
2932 2937
2933 .. container:: verbose 2938 .. container:: verbose
2934 2939
2935 Examples: 2940 Examples:
3977 tags, non-trivial parents, user, date and time, and a summary for 3982 tags, non-trivial parents, user, date and time, and a summary for
3978 each commit. When the -v/--verbose switch is used, the list of 3983 each commit. When the -v/--verbose switch is used, the list of
3979 changed files and full commit message are shown. 3984 changed files and full commit message are shown.
3980 3985
3981 .. note:: 3986 .. note::
3987
3982 log -p/--patch may generate unexpected diff output for merge 3988 log -p/--patch may generate unexpected diff output for merge
3983 changesets, as it will only compare the merge changeset against 3989 changesets, as it will only compare the merge changeset against
3984 its first parent. Also, only files different from BOTH parents 3990 its first parent. Also, only files different from BOTH parents
3985 will appear in files:. 3991 will appear in files:.
3986 3992
3987 .. note:: 3993 .. note::
3994
3988 for performance reasons, log FILE may omit duplicate changes 3995 for performance reasons, log FILE may omit duplicate changes
3989 made on branches and will not show deletions. To see all 3996 made on branches and will not show deletions. To see all
3990 changes including duplicates and deletions, use the --removed 3997 changes including duplicates and deletions, use the --removed
3991 switch. 3998 switch.
3992 3999
4650 Use --new-branch if you want to allow push to create a new named 4657 Use --new-branch if you want to allow push to create a new named
4651 branch that is not present at the destination. This allows you to 4658 branch that is not present at the destination. This allows you to
4652 only create a new branch without forcing other changes. 4659 only create a new branch without forcing other changes.
4653 4660
4654 .. note:: 4661 .. note::
4662
4655 Extra care should be taken with the -f/--force option, 4663 Extra care should be taken with the -f/--force option,
4656 which will push all new heads on all branches, an action which will 4664 which will push all new heads on all branches, an action which will
4657 almost always cause confusion for collaborators. 4665 almost always cause confusion for collaborators.
4658 4666
4659 If -r/--rev is used, the specified revision and all its ancestors 4667 If -r/--rev is used, the specified revision and all its ancestors
4974 _('[OPTION]... [-r REV] [NAME]...')) 4982 _('[OPTION]... [-r REV] [NAME]...'))
4975 def revert(ui, repo, *pats, **opts): 4983 def revert(ui, repo, *pats, **opts):
4976 """restore files to their checkout state 4984 """restore files to their checkout state
4977 4985
4978 .. note:: 4986 .. note::
4987
4979 To check out earlier revisions, you should use :hg:`update REV`. 4988 To check out earlier revisions, you should use :hg:`update REV`.
4980 To cancel an uncommitted merge (and lose your changes), 4989 To cancel an uncommitted merge (and lose your changes),
4981 use :hg:`update --clean .`. 4990 use :hg:`update --clean .`.
4982 4991
4983 With no revision specified, revert the specified files or directories 4992 With no revision specified, revert the specified files or directories
5304 5313
5305 Option -q/--quiet hides untracked (unknown and ignored) files 5314 Option -q/--quiet hides untracked (unknown and ignored) files
5306 unless explicitly requested with -u/--unknown or -i/--ignored. 5315 unless explicitly requested with -u/--unknown or -i/--ignored.
5307 5316
5308 .. note:: 5317 .. note::
5318
5309 status may appear to disagree with diff if permissions have 5319 status may appear to disagree with diff if permissions have
5310 changed or a merge has occurred. The standard diff format does 5320 changed or a merge has occurred. The standard diff format does
5311 not report permission changes and diff only reports changes 5321 not report permission changes and diff only reports changes
5312 relative to one merge parent. 5322 relative to one merge parent.
5313 5323