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.
[[wikipedia:Mercurial|Mercurial]] (sometimes referred to as {{codeline|hg}})
is the source code management system currently used to develop
Octave.


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>
== Introduction to mercurial ==


== Workflow reference ==
An introduction to mercurial is completely outside the scope of this document.
This section gives several frequently used Mercurial commands and sequences.
There are plenty of available documentation on the topic. Some recommendations
are:


* Initial clone: <pre>hg clone https://hg.savannah.gnu.org/hgweb/octave/</pre>
* [http://hginit.com/ Hg Init]
* [https://mercurial.selenic.com/wiki/Tutorial Mercurial tutorial]
* [https://mercurial.selenic.com/wiki/QuickStart Mercurial Quickstart]


You can then bootstrap, configure and make, make check, maybe make install.
== Contributing to Octave ==


* To update on a regular basis, you can do <pre>hg pull -u</pre> or <pre>hg pull && hg up</pre>
The preferred method to contribute to Octave is with Mercurial changesets.
Other forms of contributions (e.g., simple diff patches) are
also acceptable, but they slow down the review process.


* 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.
If you plan on contributing to Octave:


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.
* See other [[Contribution guidelines]]
* Always include commit messages in changesets.  Please follow the Octave [[commit message guidelines]]
* Follow the style guides for both [[Octave style guide|Octave]] and [[C++ style guide|C++]] languages.


* 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>
== Getting the development sources ==


* 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.
To clone the Octave repository:


* 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.
hg clone http://www.octave.org/hg/octave octave


* 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.
Octave packages like image, signal, control, etc. are not parts of Octave
itself, they belong to the Octave Forge.  Each package has its own
repository, a list of which can be found
[http://sourceforge.net/p/octave/_list/hg?source=navbar here].
You can clone them in a similar way, for example, to clone the signal package


* 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>.
hg clone http://hg.code.sf.net/p/octave/signal octave-signal


==Tutorials==
== Mercurial configuration ==
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.}}
You can use the following to start your hgrc


== Creating and submitting patches (changesets) ==
{{File||<pre>
 
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>
# 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)
 
* 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 {{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!
 
== Mercurial Tips for SoC students ==
 
This section is meant to provide tips for [[Summer of Code]] 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">
hg clone https://www.octave.org/hg/octave
hg bookmark my-gsoc
</syntaxhighlight>
 
To make the bookmark visible in the public repository use
 
<syntaxhighlight lang="bash">
hg push --bookmark ssh://student@public.server.org/octave
</syntaxhighlight>
 
=== Staying up-to-date with the main 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:
 
<syntaxhighlight lang="bash">
hg pull https://www.octave.org/hg/octave  # Get latest remote "tip"
hg update -r my-gsoc                      # Activate bookmark "my-gsoc"
hg merge tip                              # Merge  "tip" into "my-gsoc"
hg commit -m "maint: merge default to my-gsoc"
hg push ssh://student@public.server.org/octave
</syntaxhighlight>
 
=== 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 for review and possibly inclusion into the main repository.
 
# 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:
#* Each touched file should appear only once.
#* Do not mention backed-out commits.
# Prepare a singe patch (changeset) including all code that should be submitted for review <syntaxhighlight lang="bash">
hg pull https://www.octave.org/hg/octave  # Get remote "tip" and "@"
hg update -r @                            # Activate    bookmark "@"
hg merge my-gsoc                          # Merge "my-gsoc" into "@"
hg commit
hg export -r tip -o mid-term-review.patch
</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.
 
== Example Mercurial configuration ==
 
Place the following file in your home directory, e.g. {{Path|/home/username/.hgrc}}.
 
{{File|.hgrc|<syntaxhighlight lang="ini">
[ui]
[ui]
username = Your Name <your@email>
username = Your Name <your@email>
Line 134: Line 56:
[pager]
[pager]
pager = LESS='FSRX' less
pager = LESS='FSRX' less
attend = help, annotate, cat, diff, export, glog, log, outgoing, incoming
attend = help, annotate, cat, diff, export, glog, log, qdiff, status, outgoing, incoming


[diff]
[diff]
git = True
showfunc = True
showfunc = True


[color]
[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.modified = magenta bold
status.added = green bold
status.added = green bold
status.removed = red bold
status.removed = red bold
status.deleted = cyan bold
status.deleted = cyan bold
status.unknown = gray bold
status.unknown = gray bold
status.ignored = gray bold
status.ignored = gray bold


## Colors for each label
[alias]
log.branch = cyan
log = log --graph
log.summary = lightyellow
</pre>}}
log.description = lightyellow
 
log.bookmark = green
== Submitting patches ==
log.tag = darkorange
log.graph = blue


## Colors for each phase
When you do not have push permissions to the repository (you cannot add your changes using mercurial itself) and you have a modification to the current GNU Octave code,  you have to generate a patch (or changeset) so developers with permissions can include them in the code. The overview of the process is as follows
changeset.secret = blue bold
# Change the code and test that your changes do work (write tests, that's the best!).
changeset.draft  = red bold
# Create the changeset (instructions below).  
changeset.public = orange
# Post your patch in the [https://savannah.gnu.org/patch/?group=octave Patch tracker].


desc.here = bold blue_background


[bookmarks]
Patch submissions is done via the [https://savannah.gnu.org/bugs/?group=octave bug]
track.current = True
or [https://savannah.gnu.org/patch/?group=octave patch] trackers.  Either
way, you can submit via two different methods: pull requests on attaching
a changeset file.


[alias]
=== Pull request ===
glog = log --graph
 
top  = log --graph -l
This is the cleaner way.  You push your clone to public site, and ask on the
</syntaxhighlight>}}
bug tracker to pull a specific changeset from it.  It makes special sense if
you plan to send more patches in the future but requires to host the clone
somewhere.  Free mercurial repositories are available on [https://bitbucket.org/ bitbucket]
 
 
=== Creating changesets files with hg ===
==== Simple way ====
* Update to the latest revision.
<pre> hg up </pre>
* Make your changes and save them.
* Commit your code. Mercurial will ask you for a commit message, which should follow the [[commit message guidelines]].
<pre> hg ci </pre>
* Export the modifications. This creates a file (in the case of the example below, it is called mypatch.patch) that contains a description of the changes that you've made. Someone else can then apply the patch and end up with a repository that looks the same as yours.
<pre> hg export -r tip -o mypatch.patch </pre>
* Save the output to a file and upload it to the patch tracker. If your patch file is larger than the upload limit, you can compress it before uploading. Please use a free format!
 
== Mercurial Tips for SoC students ==


== Tips for working with TortoiseHg ==
This section is meant to provide tips for SOCIS or GSoC students working on new Octave features.


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.
Students should publish their work as it progresses in a public repository
merging regularly the main savannah repository to facilitate merging back their
code at the end of the project.  


=== Activate the "mq" extension ===
Here are some useful hg commands that can be used to do this.


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.
=== Getting started ===
The "mq" extension does *not* allow to modify pushed changes.
<!--[[File:Hg-student-start.png]]-->
<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>


To activate the "mq" extension in TortoiseSVN, open the settings, select "Extensions" on the global settings tab and activate the checkbox next to "mq".
=== Staying up-to-date with the main savannah repository ===


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.
<!-- After working for a while, the public repo should look like the following picture. -->
As the students development proceeds,
the savannah repository gets updated, too.
To avoid having the two branches diverging too much, which can
lead to conflicts when the final merge is done, students should
keep their public repo up-to-date with the recent changes,
the following commands can be used for this:<br/>
<ol>
<!--[[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>


=== Rebase a change to a current tip ===
=== 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
for review and possibly inclusion into the main development branch. To this end students should:
<ol>
<li> prepare a full log of their changes, listing files that have been touched
and including a summary of the purpose of those changes. If students have been following
the [[Commit message guidelines]] the following command will give a good starting point<br>
<code> hg log --style=changelog --no-merges --user student-name </code><br>
this message should be edited so that
<ol  style="list-style-type: lower-roman;">
<li> each touched file appears only once </li>
<li> changes that were backed out should not be mentioned <!--(like changeset "H" in the above example)--> </li>
</ol>
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 [[http://savannah.gnu.org/patch/?group=octave  patch tracker]]</li>
  </ol> </li>
</ol>


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.
== Mercurial Tips for SoC mentors ==


Strip and commit:
Will fill in this section after trying out the above procedure at least once with a student and actually pushing his changes to the main repo.
# 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)".
<code>
# Update to the new tip (maybe in incremental steps).
hg pull http://student.repo.url
# 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.
</code>


Un-apply and re-apply:
<code>
# Pull changes from the upstream repository.
hg pull http://www.octave.org/hg/octave
# Before updating to the new tip, import the local changeset to mq by selecting "Modify History" -> "Import to MQ" in the right click menu.
</code>
# 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:
<code>
# Pull changes from the upstream repository.
hg up -r @
# Select the local changeset that you'd like to rebase.
</code>
# 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 ==
<code>
hg merge student_bookmark
</code>


<references/>
<code>
hg log --style=changelog --user student
</code>
-->


== External links ==
==External links==


* https://hginit.com/ -- Mercurial tutorial
* [http://mercurial.selenic.com/ Official website]
* https://www.mercurial-scm.org/wiki/Tutorial -- Mercurial tutorial
* 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"