Mercurial: Difference between revisions

Mercurial (edit)

Revision as of 21:51, 14 June 2022

5,271 bytes added , 14 June 2022

→‎Creating and submitting patches (changesets): more of the same

ArunGiridhar

171

edits

@@ Line 1: / Line 1: @@
 [https://www.mercurial-scm.org Mercurial] (sometimes referred to as {{codeline|hg}}) is the source code management system used for Octave development.
-Everybody is free to '''run, copy, distribute, study, change and improve'''<ref>https://www.gnu.org/philosophy/free-sw.en.html</ref> Octave's source code, given in the main repository at https://www.octave.org/hg/octave.  Use Mercurial to get the latest version of Octave <pre>hg clone https://www.octave.org/hg/octave</pre>
+Everybody is free to '''run, copy, distribute, study, change and improve'''<ref>https://www.gnu.org/philosophy/free-sw.en.html</ref> Octave's source code, given in the main repository at https://www.octave.org/hg/octave.  Use Mercurial to get the latest version of Octave <pre>hg clone https://hg.octave.org/octave</pre>
 {{Note|[https://tortoisehg.bitbucket.io/ TortoiseHg] is a GUI for Mercurial and it is especially recommended for users doing their first steps with source code management systems.  Linux, macOS, and MS Windows are supported.}}
@@ Line 9: / Line 9: @@
 If you want to share your modifications, for example to fix a nasty '''bug #42424''', you cannot just submit your changes to Octave's main repository.  You have to generate a '''patch (or changeset)''' so other Octave developers can include them into Octave's source code.
-# Get the latest version of Octave (or some Octave package) <pre>hg clone https://www.octave.org/hg/octave</pre> or when already cloned <pre>hg pull && hg update</pre>
+# Get the latest version of Octave (or some Octave package) <pre>hg clone https://hg.octave.org/octave</pre> or when already cloned <pre>hg pull && hg update</pre>
 # Make your changes (fix bug #42424) and save them.  '''Make sure that your changes don't introduce new bugs!'''  Thus it is recommended to [[Building | build Octave]] and to [[Tests | run Octave's test suite]] before proceeding.<br>{{Warning|Please follow the [[Contribution guidelines]] for C/C++ or Octave code files!}}
 # Commit your changes <pre>hg commit</pre> Mercurial will open your default editor<ref>To set your default Mercurial editor, read https://www.mercurial-scm.org/wiki/editor .</ref> and ask you for a commit message.  Please follow the [[commit message guidelines]], e.g. <syntaxhighlight lang="text">help.m: Display relevant topics first (bug #42424)
@@ Line 15: / Line 15: @@
 * scripts/help/help.m: Describe what you changed to display relevant topics
    first.  The maximal line width is 80 characters.</syntaxhighlight>
-# Export the changes <pre>hg export -r tip -o bug42424.patch</pre> The final patch for submission will look like this
+# Export the changes <pre>hg export -r tip -o bug42424.patch</pre> The final patch for submission will look like this {{file|bug42424.patch|<syntaxhighlight lang="diff"># HG changeset patch
+# User Awesome Hacker <awesome@hacker.com>
+# Date 1591780091 -32400
+#      Wed Jun 10 18:08:11 2020 +0100
+# Node ID 68c698c4f2fd98bf2d48234bd1da99e91763114f
+# Parent  f5c9bb5955e7c9fddef5c3c3f115201e11b43b79
+help.m: Display relevant topics first (bug #42424)
+* scripts/help/help.m: Describe what you changed to display relevant topics
+  first.  The maximal line width is 80 characters.
+diff -r f5c9bb5955e7 -r 68c698c4f2fd scripts/help/help.m
+--- a/scripts/help/help.m	Tue Jun 09 14:11:13 2020 -0700
++++ b/scripts/help/help.m	Wed Jun 10 18:08:11 2020 +0900
+@@ -99,7 +99,7 @@ function retval = help (name)
+     endif
+     ## Get help text
+-    [text, format] = get_help_text (name);
++    [text, format] = get_better_help_text (name);
+     ## Take action depending on help text format
+     switch (lower (format))
+</syntaxhighlight>}}
 # Upload {{Path|bug42424.patch}} to the [https://savannah.gnu.org/bugs/?group=octave bug] or [https://savannah.gnu.org/patch/?group=octave patch] tracker. If your patch file is larger than the upload limit, you can compress it before uploading. Please use a free format!
@@ Line 70: / Line 95: @@
 Place the following file in your home directory, e.g. {{Path|/home/username/.hgrc}}.
+{{File|.hgrc|<syntaxhighlight lang="ini">
+[ui]
+username = Your Name <your@email>
+[extensions]
+color =
+histedit =
+pager =
+rebase =
+strip =
+[pager]
+pager = LESS='FSRX' less
+attend = help, annotate, cat, diff, export, glog, log, outgoing, incoming
+[diff]
+showfunc = True
+[color]
+mode = terminfo
+## Custom colors
+color.gray = 244
+color.orange = 202
+color.lightyellow = 191
+color.darkorange = 220
+color.brightyellow = 226
+status.modified = magenta bold
+status.added = green bold
+status.removed = red bold
+status.deleted = cyan bold
+status.unknown = gray bold
+status.ignored = gray bold
+## Colors for each label
+log.branch = cyan
+log.summary = lightyellow
+log.description = lightyellow
+log.bookmark = green
+log.tag = darkorange
+log.graph = blue
+## Colors for each phase
+changeset.secret = blue bold
+changeset.draft  = red bold
+changeset.public = orange
+desc.here = bold blue_background
+[bookmarks]
+track.current = True
+[alias]
+glog = log --graph
+top  = log --graph -l
+</syntaxhighlight>}}
+== Tips for working with TortoiseHg ==
+TortoiseHg is a multi-platform graphical user interface for Mercurial repositories. It allows to perform many hg operations using the context menu and toolbar buttons. That might make it easier to get used to working with Mercurial.
+=== Activate the "mq" extension ===
+The "mq" extension allows to modify (local) changesets after they have been committed. It also allows to rebase changes to a new parent or to strip changes completely.
+The "mq" extension does *not* allow to modify pushed changes.
+To activate the "mq" extension in TortoiseSVN, open the settings, select "Extensions" on the global settings tab and activate the checkbox next to "mq".
+The most useful feature of that extension is probably to update an existing changeset. For this, select "Modify History" -> "Import to MQ" in the right click menu of the respective changeset. After updating some local files or changing the commit message, hit the "QRefresh" button. Finish the patch by selecting "Modify History" -> "Finish Patch" from the right click menu of the respective changeset.
+=== Rebase a change to a current tip ===
+Sometimes a change in the upstream repository might make it necessary to rebase a changeset to a new parent. There are several ways to achieve this. The ways described here might not be the most elegant ones. Any editor is welcome to add onto this.
+Strip and commit:
+# Pull changes from the upstream repository.
+# Before updating to the new tip, strip the local changes by selecting "Modify History" -> "Strip..." from the right click menu. In the dialog, select "Do not modify working copy during strip (-k/--keep)".
+# Update to the new tip (maybe in incremental steps).
+# Commit the local changes in a "fresh" changeset. This has the drawback that any commit message might be lost. But it often works even if other approaches fail.
+Un-apply and re-apply:
+# Pull changes from the upstream repository.
+# Before updating to the new tip, import the local changeset to mq by selecting "Modify History" -> "Import to MQ" in the right click menu.
+# You might want to refresh the changeset with local changes.
+# Un-apply the patch by selecting "Modify History" -> "Unapply Patch" from the right click menu. If there are other, un-committed changes in the local repository, you might want to select "Tolerate non-conflicting local changes (--keep-changes)" in the "Modify History" -> "MQ Options" dialog from the right click menu beforehand.
+# Update to the new tip.
+# Select the previously unapplied patch on top of the revision graph and re-apply it by using the "Reapply Patch" option in the right click menu. This has the advantage that a commit message will be retained. But re-applying the patch might fail if there were changes in the upstream repository that made the patch incompatible.
+Rebase:
+# Pull changes from the upstream repository.
+# Select the local changeset that you'd like to rebase.
+# Hold down the Ctrl key and select the changeset that should be the new parent of the local changeset (probably the new tip).
+# Right-click the changeset of the new parent and select "Rebase...".
+# The default settings are often times fine. This process has the advantage that a commit message will be retained and it often times resolves conflicts automatically. But it doesn't work if there are any un-committed local changes.
 == Footnotes ==

Mercurial: Difference between revisions

Mercurial (edit)

Revision as of 21:51, 14 June 2022

Navigation menu

Search