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: | ||
[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. | ||
== 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. | |||
== 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 (patches) === | |||
# 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 the bug) and save them. | |||
# 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 how to display relevant topics first.</syntaxhighlight> | |||
# Export the changes <pre>hg export -r tip -o bug42424.patch</pre> The final patch for submission will look like this<syntaxhighlight lang="patch"> | |||
</syntaxhighlight> | |||
# Upload {{Path|bug42424.patch}} to the bug or patch tracker. If your patch file is larger than the upload limit, you can compress it before uploading. Please use a free format! | |||
* scripts/help/help.m: Describe | |||
# Export the changes <pre>hg export -r tip -o bug42424.patch</pre> The final patch for submission will look like this | |||
</syntaxhighlight> | |||
# Upload {{Path|bug42424.patch}} to the | |||
== 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 | 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> | ||
hg pull | <li> Merge the main line of development into the feature branch <br/> | ||
hg | <code> hg up -r student-bookmark-name </code> <br/> | ||
hg merge | <!--[[File:Hg-student-flow2.png]] <br/>--> | ||
hg commit -m " | <code> hg merge @ </code> </li> | ||
hg push ssh://student@public.server.org/octave | <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 | 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> | |||
hg pull | this message should be edited so that | ||
hg | <ol style="list-style-type: lower-roman;"> | ||
hg merge | <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 | </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> | |||
== Example Mercurial configuration == | == Example Mercurial configuration == | ||
Line 121: | Line 114: | ||
Place the following file in your home directory, e.g. {{Path|/home/username/.hgrc}}. | Place the following file in your home directory, e.g. {{Path|/home/username/.hgrc}}. | ||
{{File|.hgrc|< | {{File|.hgrc|<pre> | ||
[ui] | [ui] | ||
username = Your Name <your@email> | username = Your Name <your@email> | ||
Line 156: | Line 149: | ||
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 169: | ||
[alias] | [alias] | ||
glog = log --graph | glog = log --graph | ||
top | top = log --graph -l | ||
</ | </pre>}} | ||
== External links == | == External links == | ||
Line 226: | Line 177: | ||
* 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 | ||
[[Category:Development]] | [[Category:Development]] |