summaryrefslogtreecommitdiff
path: root/vendor/github.com/checkpoint-restore/go-criu/README.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2018-10-23 07:53:11 -0700
committerGitHub <noreply@github.com>2018-10-23 07:53:11 -0700
commit2e6bc3c7af261228ae7a75cb5749062928fa24b3 (patch)
tree94b3af23e8f5d774be0e4846698fac685a5f56f3 /vendor/github.com/checkpoint-restore/go-criu/README.md
parent79befd5158c8f01a88e4d14e46851ddcc11d51c4 (diff)
parenta14155917baa577bebbbc0c5983a7a90bf35c2b5 (diff)
downloadpodman-2e6bc3c7af261228ae7a75cb5749062928fa24b3.tar.gz
podman-2e6bc3c7af261228ae7a75cb5749062928fa24b3.tar.bz2
podman-2e6bc3c7af261228ae7a75cb5749062928fa24b3.zip
Merge pull request #1627 from adrianreber/criu
Add CRIU version check for checkpoint and restore
Diffstat (limited to 'vendor/github.com/checkpoint-restore/go-criu/README.md')
-rw-r--r--vendor/github.com/checkpoint-restore/go-criu/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/vendor/github.com/checkpoint-restore/go-criu/README.md b/vendor/github.com/checkpoint-restore/go-criu/README.md
new file mode 100644
index 000000000..a79b4d7fb
--- /dev/null
+++ b/vendor/github.com/checkpoint-restore/go-criu/README.md
@@ -0,0 +1,27 @@
+[![master](https://travis-ci.org/checkpoint-restore/go-criu.svg?branch=master)](https://travis-ci.org/checkpoint-restore/go-criu)
+
+## go-criu -- Go bindings for [CRIU](https://criu.org/)
+
+This repository provides Go bindings for CRIU. The code is based on the Go based PHaul
+implementation from the CRIU repository. For easier inclusion into other Go projects the
+CRIU Go bindings have been moved to this repository.
+
+The Go bindings provide an easy way to use the CRIU RPC calls from Go without the need
+to set up all the infrastructure to make the actual RPC connection to CRIU.
+
+The following example would print the version of CRIU:
+```
+ c := criu.MakeCriu()
+ version, err := c.GetCriuVersion()
+ fmt.Println(version)
+```
+or to just check if at least a certain CRIU version is installed:
+```
+ c := criu.MakeCriu()
+ result, err := c.IsCriuAtLeast(31100)
+```
+
+### License
+
+The license of go-criu is the Apache 2.0 license.
+