Mercurial: Difference between revisions

Jump to navigation Jump to search
680 bytes removed ,  11 June 2020
(Overhaul intro.)
(6 intermediate revisions by the same user not shown)
Line 68: Line 68:


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
hg pull https://www.octave.org/hg/octave       # Get latest changes from main repo, bookmark "@"
hg pull https://www.octave.org/hg/octave   # Get latest remote "tip"
hg update -r my-gsoc                           # Select my bookmark
hg update -r my-gsoc                       # Activate bookmark "my-gsoc"
hg merge @                                    # Merge changes of bookmark "@" to bookmark "my-gsoc"
hg merge tip                              # Merge "tip" into "my-gsoc"
hg commit -m "maint: merge default to my-gsoc"
hg commit -m "maint: merge default to my-gsoc"
hg push ssh://student@public.server.org/octave
hg push ssh://student@public.server.org/octave
Line 77: Line 77:
=== 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 repository.
for review and possibly inclusion into the main development branch. To this end students should:
 
<ol>
# Create a full log of changes <pre>hg log --template=changelog --no-merges --user student-name</pre> If students have been following the [[Commit message guidelines]] the output is a good starting point for the commit message in the next step. Some manual post-processing might be necessary:
<li> prepare a full log of their changes, listing files that have been touched
#* Each touched file should appear only once.
and including a summary of the purpose of those changes. If students have been following
#* Do not mention backed-out commits.
the [[Commit message guidelines]] the following command will give a good starting point<br>
# Prepare a singe patch (changeset) including all code that should be submitted for review <syntaxhighlight lang="bash">
<code> hg log --style=changelog --no-merges --user student-name </code><br>
hg pull https://www.octave.org/hg/octave  # Get remote "tip" and "@"
this message should be edited so that
hg update -r @                             # Activate    bookmark "@"
  <ol  style="list-style-type: lower-roman;">
hg merge my-gsoc                          # Merge "my-gsoc" into "@"
<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 -r tip -o mid-term-review.patch
</ol>
</syntaxhighlight> The file {{Path|mid-term-review.patch}} can uploaded to the [https://savannah.gnu.org/patch/?group=octave patch tracker]. <br/> Finally, there is a subtle difference between <code>"tip"</code>, which is a reference to the (local or remote) changeset added to the repository most recently and the bookmark <code>"@"</code> used by the Octave developers to point to the latest remote changeset.  Often both refer to the very same changeset and they can used interchangeably.
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 ==

Navigation menu