Editing Mercurial
Jump to navigation
Jump to search
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: | ||
[ | [[wikipedia:Mercurial]] (sometimes referred to as {{codeline|hg}}) is the version control tool used by Octave. | ||
This page contains some helpful commands to use when interacting with the GNU Octave mercurial repository. | |||
== Patches == | |||
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 | |||
# Change the code and test that your changes do work (write tests, that's the best!). | |||
# Create the changeset (instructions below). | |||
# Post your patch in the [https://savannah.gnu.org/patch/?group=octave Patch tracker]. | |||
== | === Before starting === | ||
The way patches are generated uses an [http://mercurial.selenic.com/wiki/MqExtension extension] of mercurial and therefore you need to prepare your .hgrc file to use it. | |||
If you do not have a .hgrc file, just create one in your home directory. In Windows, this is something like "C:\Documents and Settings\your_name\Mercurial.ini" | |||
Add the following code to that file: | |||
[extensions] | |||
hgext.mq = | |||
hgext.pager = | |||
color = | |||
[pager] | |||
pager = LESS='FSRX' less | |||
attend = help, annotate, cat, diff, export, glog, log, qdiff, status, outgoing, incoming | |||
## Colours I like | |||
[color] | |||
status.modified = magenta bold | |||
status.added = green bold | |||
status.removed = red bold | |||
status.deleted = cyan bold | |||
status.unknown = gray bold | |||
status.ignored = gray bold | |||
The only part that is important is the extensions. The rest is to make hg behave in a fancy way (recommended). | |||
* | === Creating changesets with hg === | ||
==== Simple way ==== | |||
* Update to the latest revision. | |||
<pre> hg up </pre> | |||
* Make your changes and save. | |||
* Commit your code following the [[commit message guidelines]]. | |||
<pre> hg ci </pre> | |||
* Export the modifications. | |||
<pre> hg export -r tip -o mypatch.patch </pre> | |||
* Save the output to a file and upload it tot he patch tracker. | |||
==== Using the MQ extension ==== | |||
In the repository you can start a patch by doing | |||
hg qnew mychangeset | |||
You can further edit your files... if you do, you need your patch to know about these changes. To do that execute | |||
hg qrefresh | |||
Once you think you have all the changes that make your patch complete you can export your patch | |||
hg qdiff > mychangeset.patch | |||
* | Now you can do (at least) two things | ||
* Apply your patch to your copy (it will differ form the repository and you will have to merge somehow...). To do it run | |||
hg qfinish tip | |||
* Forget the changes and go back to the unpatched version of the code. | |||
hg qrefresh | |||
hg qpop | |||
hg qfinish tip | |||
The file mychangeset.patch contains your changes. | |||
== Mercurial Tips for SoC students == | == Mercurial Tips for SoC students == | ||
This section is meant to provide tips for | 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 | |||
merging regularly the main savannah repository to facilitate merging back their | |||
code at the end of the project. | |||
Here are some useful hg commands that can be used to do this. | |||
< | === Getting started === | ||
hg push --bookmark ssh://student@public.server.org/octave | <!--[[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> | |||
=== Staying up-to-date with the main repository === | === Staying up-to-date with the main savannah repository === | ||
<!-- 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. | ||
hg pull | To avoid having the two branches diverging too much, which can | ||
hg | lead to conflicts when the final merge is done, students should | ||
hg merge | keep their public repo up-to-date with the recent changes, | ||
hg commit -m " | the following commands can be used for this:<br/> | ||
hg push ssh://student@public.server.org/octave | <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> | |||
=== 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 | |||
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 -r </code><br/> | |||
</li> | |||
</ol> </li> | |||
</ol> | |||
== Mercurial Tips for SoC mentors == | |||
== | |||
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. | |||
<!--- | |||
<code> | |||
hg pull http://student.repo.url | |||
</code> | |||
<code> | |||
hg pull http://www.octave.org/hg/octave | |||
</code> | |||
< | <code> | ||
hg up -r @ | |||
</code> | |||
<code> | |||
hg merge student_bookmark | |||
</code> | |||
<code> | |||
hg log --style=changelog --user student | |||
</code> | |||
--> | |||
[[Category:Development]] | [[Category:Development]] |