Editing Mercurial

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
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.
[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>
== Workflow reference ==
This section gives several frequently used Mercurial commands and sequences.
* Initial clone: <pre>hg clone https://hg.savannah.gnu.org/hgweb/octave/</pre>
You can then bootstrap, configure and make, make check, maybe make install.
* To update on a regular basis, you can do <pre>hg pull -u</pre> or <pre>hg pull && hg up</pre>
* To make a ''local clone'', you can clone from your main Octave repository on your computer to another directory like this: <pre>hg clone octave myfeature</pre> which will clone the Octave directory into a new directory called "myfeature". You'll need to cd to the correct directory first. Then you can cd into the new directory and run bootstrap, configure, make. To prevent a fresh download of gnulib, you can specify the path to the first Octave directory's gnulib if you want.
It is best practice to make a new clone directory for each feature or bugfix you work on, which makes recovery from mistakes much easier.
* To work on the stable branch instead of the default branch, make a local clone called "stable", then cd to it and <pre>hg update stable</pre>
* To circulate work-in-progress bugfixes: first cd to the relevant local clone, then edit the relevant files, verify that it builds, then <pre>hg diff &gt;/tmp/my.wip.patch</pre> and then upload that file to the bug tracker discussion. You can also copy-paste it into a bug discussion using ''verbatim'' tags if the patch is small enough. Accept feedback from the bug discussion and iterate your patch.
* When you're ready to commit your fix, first pull and update your main Octave directory from Savannah, then pull and update your local clones. Then build again to make sure things haven't broken. Then <pre>hg commit</pre> and type a summary and context for your change. Exit the editor, saving when it prompts. Build again so your build gets the latest hg id. Type <pre>hg export &gt;/tmp/my.patch</pre> and upload that file into the bug discussion. Wait for a maintainer to apply it with your name, then if you do <pre>hg in</pre> in your main Octave directory it'll show up as an incoming change. Do a pull and up to get that, then do a pull and up in your individual clone directories to get it there.
* To merge changes from stable to default <pre>hg merge stable</pre>. It's best to run this only in local clones that are already on the default branch. That way, local clones on stable don't have to switch branches before merging.
* To push to a repository, if you have push rights to that repository, you can see what's going out with <pre>hg out</pre> and then if you're happy with it you can<pre>hg push</pre>.
==Tutorials==
Joel Spolsky's Mercurial tutorial: [https://hginit.github.io/01.html https://hginit.github.io/01.html]
{{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.}}


== Creating and submitting patches (changesets) ==
== Creating and submitting patches (changesets) ==


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.
Everybody is free to obtain, built, and modify Octave's source code, given in the main repository at https://www.octave.org/hg/octave.  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 revision 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>
# 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!}}
# 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)
# Commit your changes <pre>hg commit</pre> Mercurial will open your default editor 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)


* scripts/help/help.m: Describe what you changed to display relevant topics
* scripts/help/help.m: Describe what you changed to display relevant topics
Line 47: Line 17:
# Node ID 68c698c4f2fd98bf2d48234bd1da99e91763114f
# Node ID 68c698c4f2fd98bf2d48234bd1da99e91763114f
# Parent  f5c9bb5955e7c9fddef5c3c3f115201e11b43b79
# Parent  f5c9bb5955e7c9fddef5c3c3f115201e11b43b79
help.m: Display relevant topics first (bug #42424)
help.m: Display relevant topics first (bug #42424)


Line 71: Line 40:
== Mercurial Tips for SoC students ==
== Mercurial Tips for SoC students ==


This section is meant to provide tips for [[Summer of Code]] students working on new Octave features.
This section is meant to provide tips for SOCIS or GSoC students working on new Octave features.
 
Students should publish their work as it progresses in a public repository. In this section we use for example <code>public.server.org/octave</code>.
 
=== Using bookmarks ===
 
[https://www.mercurial-scm.org/wiki/Bookmarks Bookmarks] are useful for identifying a series of commits.  They are a "lightweight" solution to [https://www.mercurial-scm.org/wiki/NamedBranches named branches], which are not automatically updated for example.  To create a bookmark <code>my-gsoc</code> use


<syntaxhighlight lang="bash">
Students should publish their work as it progresses in a public repository
hg clone https://www.octave.org/hg/octave
merging regularly the main savannah repository to facilitate merging back their
hg bookmark my-gsoc
code at the end of the project.  
</syntaxhighlight>


To make the bookmark visible in the public repository use
Here are some useful hg commands that can be used to do this.


<syntaxhighlight lang="bash">
=== Getting started ===
hg push --bookmark ssh://student@public.server.org/octave
<!--[[File:Hg-student-start.png]]-->
</syntaxhighlight>
<ol>
<li> Clone the main Octave repository at savannah:<br>
<code> hg clone http://www.octave.org/hg/octave </code> </li>
<li> Create a new bookmark:<br>
<code> hg bookmark student-bookmark-name </code> </li>
<li> Make the bookmark visible in the public repo, assuming the public repo is at <code>public.server.org/octave</code><br>
<code> hg push --bookmark ssh://student@public.server.org/octave </code> </li>
</ol>


=== Staying up-to-date with the main repository ===
=== Staying up-to-date with the main savannah repository ===


Octave development does not stand still while the students development proceeds.  Octave's main repository gets updated, too. The following commands can be used to get these updated to the students clone of the main repository:
<!-- After working for a while, the public repo should look like the following picture. -->
 
As the students development proceeds,
<syntaxhighlight lang="bash">
the savannah repository gets updated, too.  
hg pull https://www.octave.org/hg/octave   # Get latest remote "tip"
To avoid having the two branches diverging too much, which can
hg update -r my-gsoc                      # Activate bookmark "my-gsoc"
lead to conflicts when the final merge is done, students should
hg merge tip                              # Merge  "tip" into "my-gsoc"
keep their public repo up-to-date with the recent changes,
hg commit -m "maint: merge default to my-gsoc"
the following commands can be used for this:<br/>
hg push ssh://student@public.server.org/octave
<ol>
</syntaxhighlight>
<!--[[File:Hg-student-flow1.png]] <br/>-->
<li> Download new changes from the main line of development <br/>
<code> hg pull http://www.octave.org/hg/octave </code> </li>
<li> Merge the main line of development into the feature branch <br/>
<code> hg up -r student-bookmark-name </code> <br/>
<!--[[File:Hg-student-flow2.png]] <br/>-->
<code> hg merge @ </code> </li>
<li> Apply the change and publish it <br/>
<code> hg commit -m "periodic merge of default branch into my branch" </code> <br/>
<!--[[File:Hg-student-flow3.png]] <br/>-->
<code> hg push ssh://student@public.server.org/octave </code></li>
</ol>


=== Preparing for code reviews ===
=== Preparing for code reviews ===
 
At the time of the mid-term or final review (or whenever the mentor requires it) students should prepare their code  
At the time of the mid-term or final review (or whenever the mentor requires it) students should prepare their code for review and possibly inclusion into the main repository.
for review and possibly inclusion into the main development branch. To this end students should:
 
<ol>
# Create a full log of changes <pre>hg log --template=changelog --no-merges --user student-name</pre> If students have been following the [[Commit message guidelines]] the output is a good starting point for the commit message in the next step. Some manual post-processing might be necessary:
<li> prepare a full log of their changes, listing files that have been touched
#* Each touched file should appear only once.
and including a summary of the purpose of those changes. If students have been following
#* Do not mention backed-out commits.
the [[Commit message guidelines]] the following command will give a good starting point<br>
# Prepare a singe patch (changeset) including all code that should be submitted for review <syntaxhighlight lang="bash">
<code> hg log --style=changelog --no-merges --user student-name </code><br>
hg pull https://www.octave.org/hg/octave  # Get remote "tip" and "@"
this message should be edited so that
hg update -r @                             # Activate    bookmark "@"
  <ol  style="list-style-type: lower-roman;">
hg merge my-gsoc                          # Merge "my-gsoc" into "@"
<li> each touched file appears only once </li>
hg commit
<li> changes that were backed out should not be mentioned <!--(like changeset "H" in the above example)--> </li>
hg export -r tip -o mid-term-review.patch
</ol>
</syntaxhighlight> The file {{Path|mid-term-review.patch}} can uploaded to the [https://savannah.gnu.org/patch/?group=octave patch tracker]. <br/> Finally, there is a subtle difference between <code>"tip"</code>, which is a reference to the (local or remote) changeset added to the repository most recently and the bookmark <code>"@"</code> used by the Octave developers to point to the latest remote changeset.  Often both refer to the very same changeset and they can used interchangeably.
The main  purpose of this log is to make it easy, not only for the main mentor, but also for other developers who
have not been closely following the progress of the project to quickly understand where to look at in the code to evaluate it, but it will also be used as the commit message for the merge changeset, so it should itself comply with the [[Commit message guidelines]].
<li> prepare a merge changeset including all the code that should be submitted for review
  <ol style="list-style-type: lower-roman;">
  <li> pull from the main repository<br/>
  <code>hg pull http://www.octave.org/hg/octave</code></li>
   <li> move to the top of the main line of development and merge in the feature branch<br/>
  <code>hg up -r @</code><br/>
  <code>hg merge student-bookmark-name </code><br/></li>
  <li> create a changeset, export it and send to the mentor for review, remember to use the log created above as a commit message<br/>
  <code>hg commit </code><br/>
  <code>hg export @ > mid-term-review.changeset </code><br/>
  the file mid-term-review.changeset can then be sent to the [mailto:octave-maintainers@octave.org mailing list] or posted
  to the [https://savannah.gnu.org/patch/?group=octave patch tracker]</li>
  </ol> </li>
</ol>


== Example Mercurial configuration ==
== Example Mercurial configuration ==
Line 176: Line 171:
[alias]
[alias]
glog = log --graph
glog = log --graph
top = log --graph -l
top = log --graph -l
</syntaxhighlight>}}
</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 ==
<references/>


== External links ==
== External links ==
Line 226: Line 179:
* https://www.mercurial-scm.org/wiki/Tutorial -- Mercurial tutorial
* https://www.mercurial-scm.org/wiki/Tutorial -- Mercurial tutorial
* https://www.mercurial-scm.org/wiki/QuickStart -- Mercurial quick start
* https://www.mercurial-scm.org/wiki/QuickStart -- Mercurial quick start
* https://tortoisehg.bitbucket.io/ -- TortoiseHg is a GUI for Mercurial (Linux, macOS, MS Windows)


[[Category:Development]]
[[Category:Development]]
Please note that all contributions to Octave may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Octave:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://wiki.octave.org/Mercurial"