Changes

Jump to navigation Jump to search
3,446 bytes added ,  11:42, 12 February 2021
no edit summary
Line 15: Line 15:  
* scripts/help/help.m: Describe what you changed to display relevant topics
 
* scripts/help/help.m: Describe what you changed to display relevant topics
 
   first.  The maximal line width is 80 characters.</syntaxhighlight>
 
   first.  The maximal line width is 80 characters.</syntaxhighlight>
# Export the changes <pre>hg export -r tip -o bug42424.patch</pre> The final patch for submission will look like this {{file|bug42424.patch|<syntaxhighlight lang="diff"># HG changeset patch
+
# Export the changes <pre>hg export -r tip -o bug42424.patch</pre> The final patch for submission will look like this  
# User Awesome Hacker <awesome@hacker.com>
+
# Upload {{Path|bug42424.patch}} to the [https://savannah.gnu.org/bugs/?group=octave bug] or [https://savannah.gnu.org/patch/?group=octave patch] tracker. If your patch file is larger than the upload limit, you can compress it before uploading. Please use a free format!
# Date 1591780091 -32400
+
 
#     Wed Jun 10 18:08:11 2020 +0100
+
== Mercurial Tips for SoC students ==
# Node ID 68c698c4f2fd98bf2d48234bd1da99e91763114f
+
 
# Parent f5c9bb5955e7c9fddef5c3c3f115201e11b43b79
+
This section is meant to provide tips for [[Summer of Code]] students working on new Octave features.
help.m: Display relevant topics first (bug #42424)
+
 
 +
Students should publish their work as it progresses in a public repository. In this section we use for example <code>public.server.org/octave</code>.
 +
 
 +
=== Using bookmarks ===
 +
 
 +
[https://www.mercurial-scm.org/wiki/Bookmarks Bookmarks] are useful for identifying a series of commits.  They are a "lightweight" solution to [https://www.mercurial-scm.org/wiki/NamedBranches named branches], which are not automatically updated for example.  To create a bookmark <code>my-gsoc</code> use
 +
 
 +
<syntaxhighlight lang="bash">
 +
hg clone https://www.octave.org/hg/octave
 +
hg bookmark my-gsoc
 +
</syntaxhighlight>
 +
 
 +
To make the bookmark visible in the public repository use
 +
 
 +
<syntaxhighlight lang="bash">
 +
hg push --bookmark ssh://student@public.server.org/octave
 +
</syntaxhighlight>
 +
 
 +
=== Staying up-to-date with the main repository ===
 +
 
 +
Octave development does not stand still while the students development proceeds.  Octave's main repository gets updated, too.  The following commands can be used to get these updated to the students clone of the main repository:
 +
 
 +
<syntaxhighlight lang="bash">
 +
hg pull https://www.octave.org/hg/octave  # Get latest remote "tip"
 +
hg update -r my-gsoc                      # Activate bookmark "my-gsoc"
 +
hg merge tip                              # Merge  "tip" into "my-gsoc"
 +
hg commit -m "maint: merge default to my-gsoc"
 +
hg push ssh://student@public.server.org/octave
 +
</syntaxhighlight>
 +
 
 +
=== 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 repository.
 +
 
 +
# 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:
 +
#* Each touched file should appear only once.
 +
#* Do not mention backed-out commits.
 +
# Prepare a singe patch (changeset) including all code that should be submitted for review <syntaxhighlight lang="bash">
 +
hg pull https://www.octave.org/hg/octave  # Get remote "tip" and "@"
 +
hg update -r @                            # Activate    bookmark "@"
 +
hg merge my-gsoc                          # Merge "my-gsoc" into "@"
 +
hg commit
 +
hg export -r tip -o mid-term-review.patch
 +
</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.
 +
 
 +
== Example Mercurial configuration ==
 +
 
 +
Place the following file in your home directory, e.g. {{Path|/home/username/.hgrc}}.
 +
 
 +
 
 +
 
 +
== Footnotes ==
 +
 
 +
<references/>
 +
 
 +
== External links ==
 +
 
 +
* https://hginit.com/ -- Mercurial tutorial
 +
* https://www.mercurial-scm.org/wiki/Tutorial -- Mercurial tutorial
 +
* https://www.mercurial-scm.org/wiki/QuickStart -- Mercurial quick start
 +
* https://tortoisehg.bitbucket.io/ -- TortoiseHg is a GUI for Mercurial (Linux, macOS, MS Windows)
 +
 
 +
[[Category:Development]]

Navigation menu