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. | ||
== 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 | # 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<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) | ||
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 | 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 https://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 https://www.octave.org/hg/octave | 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 https://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 | 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 https://www.octave.org/hg/octave | 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 https://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 | top = log --graph -l | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
== 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 | ||
[[Category:Development]] | [[Category:Development]] |