349
edits
Mercurial: Difference between revisions
no edit summary
No edit summary |
No edit summary |
||
| Line 45: | Line 45: | ||
* Save the output to a file and upload it tot he patch tracker. | * Save the output to a file and upload it tot he patch tracker. | ||
==== Using the extension ==== | ==== Using the MQ extension ==== | ||
In the repository you can start a patch by doing | In the repository you can start a patch by doing | ||
hg qnew mychangeset | hg qnew mychangeset | ||
| Line 64: | Line 64: | ||
The file mychangeset.patch contains your changes. | The file mychangeset.patch contains your changes. | ||
== Mercurial Tips for SoC students == | |||
<!--This page is addressed to SOCIS or GSoC applicants contributing to Octave.--> | |||
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><code> hg up -r student-bookmark-name </code> <br/> | |||
<!--[[File:Hg-student-flow2.png]] <br/>--> | |||
<code> hg merge @ </code> </li> | |||
<li><code> hg commit -m "periodic merge of default branch into my branch" </code> </li> | |||
<!--[[File:Hg-student-flow3.png]] <br/>--> | |||
<li><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 style="list-style-type: lower-roman;"> | |||
<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> | |||
<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]]. | |||
[[Category:Development]] | [[Category:Development]] | ||