Mercurial: Difference between revisions

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 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.<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 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)

# Export the changes <pre>hg export -r tip -o bug42424.patch</pre> The final patch for submission will look like this<syntaxhighlight lang="diff"># HG changeset patch

</syntaxhighlight>

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  

Here are some useful hg commands that can be used to do this.

=== Getting started ===

<!--[[File:Hg-student-start.png]]-->

<li> Clone the main Octave repository at savannah:<br>

=== Staying up-to-date with the main savannah repository ===

<!-- After working for a while, the public repo should look like the following picture. -->

<code> hg pull http://www.octave.org/hg/octave </code> </li>

<code> hg up -r student-bookmark-name </code> <br/>

<code> hg merge @ </code> </li>

<code> hg commit -m "periodic merge of default branch into my branch" </code> <br/>

<code> hg push ssh://student@public.server.org/octave </code></li>

</ol>

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:

<li> prepare a full log of their changes, listing files that have been touched

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>

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;">

  <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>

  <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>

{{File|.hgrc|<pre>

## Colours for each label

</pre>}}