62
edits
Changes
Jump to navigation
Jump to search
Line 5:
Line 5: − + Line 12:
Line 12: − + + Line 22:
Line 23: − cd criu − + Line 36:
Line 36: − + Line 51:
Line 51: − + − − == Make a patch == − − To create a patch, run − − git format-patch − − You might need to read GIT documentation on how to prepare patches − for mail submission. Take a look at http://book.git-scm.com/ and/or − http://git-scm.com/documentation for details. It should not be hard − at all. Line 75:
Line 64: − + Line 113:
Line 102: − + Line 128:
Line 117: − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − + + + + + + + + + + + + + − + + + + + + + + + + +
no edit summary
== Get the source code ==
== Get the source code ==
The CRIU sources are tracked by Git. Official CRIU repo is at [https://github.com/xemul/criu https://github.com/xemul/criu].
The CRIU sources are tracked by Git. Official CRIU repo is at [https://github.com/checkpoint-restore/criu https://github.com/checkpoint-restore/criu].
The repository may contain multiple branches. Development happens in the '''criu-dev''' branch.
The repository may contain multiple branches. Development happens in the '''criu-dev''' branch.
<pre><nowiki>
<pre><nowiki>
git clone https://github.com/xemul/criu
git clone https://github.com/checkpoint-restore/criu criu
cd criu
git checkout criu-dev
git checkout criu-dev
</nowiki></pre>
</nowiki></pre>
To compile CRIU, run:
To compile CRIU, run:
make
make
This should make the ./criu executable.
This should create the <code>./criu/criu</code> executable.
== Edit the source code ==
== Edit the source code ==
* we prefer tabs and indentations to be 8 characters width
* we prefer tabs and indentations to be 8 characters width
* consider reading [https://www.kernel.org/doc/Documentation/CodingStyle Linux kernel coding style].
* CRIU mostly follows [https://www.kernel.org/doc/Documentation/process/coding-style.rst Linux kernel coding style], but we are less strict than the kernel community.
Other conventions can be learned from the source code itself. In short, make sure your new code
Other conventions can be learned from the source code itself. In short, make sure your new code
In case you'd rather have someone else run the tests, you can use travis-ci for your
In case you'd rather have someone else run the tests, you can use travis-ci for your
own github fork of CRIU. It will check the compilation for various supported platforms,
own github fork of CRIU. It will check the compilation for various supported platforms,
as well as run most of the tests from the suite. See https://travis-ci.org/xemul/criu
as well as run most of the tests from the suite. See https://travis-ci.org/checkpoint-restore/criu
for more details.
for more details.
== Sign your work ==
== Sign your work ==
can certify the below:
can certify the below:
<div class="toccolours mw-collapsible mw-collapsed" style="width: 64em;">
<div class="toccolours mw-collapsible mw-collapsed" style="width: 46em;">
'''Developer's Certificate of Origin 1.1'''
'''Developer's Certificate of Origin 1.1'''
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
<code>git commit --amend -s</code>.
<code>git commit --amend -s</code>.
<div class="toccolours mw-collapsible mw-collapsed" style="width: 64em;">
<div class="toccolours mw-collapsible mw-collapsed" style="width: 46em;">
'''Example patch message'''
'''Example patch message'''
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
</div></div>
</div></div>
== Mail patches ==
== Submit your work upstream ==
We accept github pull requests and this is the preferred way to contribute to CRIU.
For that you should push your work to your fork of CRIU at [https://github.com GitHub] and create a [https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests pull request]
Historically, CRIU worked with mailing lists and patches so if you still prefer this way continue reading till the end of this section.
=== Make a patch ===
To create a patch, run
git format-patch --signoff origin/criu-dev
You might need to read GIT documentation on how to prepare patches
for mail submission. Take a look at http://book.git-scm.com/ and/or
http://git-scm.com/documentation for details. It should not be hard
at all.
We recommend to post patches using <code>git send-email</code>
git send-email --cover-letter --no-chain-reply-to --annotate \
--confirm=always --to=criu@openvz.org criu-dev
Note that the <code>git send-email</code> subcommand may not be in
the main git package and using it may require installation of a
separate package, for example the "git-email" package in Fedora and
Debian.
If this is your first time using git send-email, you might need to
configure it to point it to your SMTP server with something like:
git config --global sendemail.smtpServer stmp.example.net
If you get tired of typing <code>--to=criu@openvz.org</code> all the time,
you can configure that to be automatically handled as well:
The patches should be sent to [CRIU development mailing list which is located at https://openvz.org/mailman/listinfo/criu].
git config sendemail.to criu@openvz.org
If a developer is sending another version of the patch (e.g. to address
review comments), they are advised to note differences to previous versions
after the <code>---</code> line in the patch so that it helps reviewers but
doesn't become part of git history. Moreover, such patch needs to be prefixed
correctly with <code>--subject-prefix=PATCHv2</code> appended to
<code>git send-email</code> (substitute <code>v2</code> with the correct
version if needed though).
=== Mail patches ===
The patches should be sent to CRIU development mailing list, <code>criu AT openvz.org</code>. Note that you need to be subscribed first in order to post. The list web interface is available at https://openvz.org/mailman/listinfo/criu; you can also use standard mailman aliases to work with it.
Please make sure the email client you're using doesn't screw your patch (line wrapping and so on).
Please make sure the email client you're using doesn't screw your patch (line wrapping and so on).
== Wait for response ==
{{Note| When sending a patch set that consists of more than one patch, please, push your changes in your local repo and provide the URL of the branch in the cover-letter}}
=== Wait for response ===
Be patient. Most CRIU developers are pretty busy people so if
Be patient. Most CRIU developers are pretty busy people so if
there is no immediate response on your patch — don't be surprised,
there is no immediate response on your patch — don't be surprised,
sometimes a patch may fly around a week before it gets reviewed.
sometimes a patch may fly around a week before it gets reviewed.
== Continuous integration ==
''Main article: [[Continuous integration]]''
CRIU tests are run for each series sent to the mailing list. If you get a message from our patchwork that patches failed to pass the tests, you have to investigate what is wrong.
We also recommend you to [[Continuous integration#Enable Travis CI for your repo|enable Travis CI for your repo]] to check patches in your git branch, before sending them to the mailing list.
[[Category:Development]]
[[Category:Development]]