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|Mercurial]] (sometimes referred to as {{codeline|hg}}) | ||
is the source code management system currently used to develop | |||
Octave. | |||
== Introduction to Mercurial == | |||
An introduction to Mercurial is completely outside the scope of this document. | |||
There are plenty of available documentation on the topic. Some recommendations | |||
are: | |||
* | * [http://hginit.com/ Hg Init] | ||
* [https://www.mercurial-scm.org/wiki/Tutorial Mercurial tutorial] | |||
* [https://www.mercurial-scm.org/wiki/QuickStart Mercurial quick start] | |||
== Contributing to Octave == | |||
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. | |||
If you plan on contributing to Octave: | |||
* 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. | |||
== Getting the development sources == | |||
To clone the Octave repository: | |||
hg clone http://www.octave.org/hg/octave octave | |||
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 | |||
hg clone http://hg.code.sf.net/p/octave/signal octave-signal | |||
== | == Mercurial configuration == | ||
You can use the following to start your hgrc | |||
{{File||<pre> | |||
[ui] | [ui] | ||
username = Your Name <your@email> | username = Your Name <your@email> | ||
Line 156: | Line 78: | ||
status.ignored = gray bold | status.ignored = gray bold | ||
## | ## Colours for each label | ||
log.branch = cyan | log.branch = cyan | ||
log.summary = lightyellow | log.summary = lightyellow | ||
Line 176: | Line 98: | ||
[alias] | [alias] | ||
glog = log --graph | glog = log --graph | ||
top | top = log --graph -l | ||
</ | </pre>}} | ||
== Submitting 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]. | |||
Patch submissions is done via the [https://savannah.gnu.org/bugs/?group=octave bug] | |||
or [https://savannah.gnu.org/patch/?group=octave patch] trackers. Either | |||
way, you can submit via two different methods: pull requests or attaching | |||
a changeset file. | |||
=== 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 == | |||
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 === | |||
<!--[[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 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. | |||
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> | |||
=== | === 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 [https://savannah.gnu.org/patch/?group=octave patch tracker]</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> | |||
--> | |||
== External links == | ==External links== | ||
* | * [https://www.mercurial-scm.org/ Official website] | ||
[[Category:Development]] | [[Category:Development]] |