2
0
mirror of https://github.com/checkpoint-restore/criu synced 2025-08-29 21:38:16 +00:00

106 Commits

Author SHA1 Message Date
Cyrill Gorcunov
98179fb5a8 docs: Add dedup command description
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2014-02-22 13:31:50 +04:00
Adrian Reber
35763e0b50 Makefile: fix libcriu.so links and man page installation
The links to the versioned libcriu.so.* included $(DESTDIR) and
$(LIBDIR) which will generate wrong links if building criu packages.
Now the links points to the correct file without any path.

For some reason criu.8 was installed with executable permission. Use
'install' with '-m 644' to make sure this does not happen.

Signed-off-by: Adrian Reber <adrian@lisas.de>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2014-02-10 14:27:43 +04:00
Kir Kolyshkin
071312d9d5 Doc/Makefile: error out if req tools absent
Make sure we have a clear message why build it failing, as there are
repeated questions at criu@ mailing list.

Before this patch:

	[kir@kirpad Documentation]$ make
	  GEN      criu.8
	make: *** [criu.8] Error 127

After:

	[kir@kirpad Documentation]$ make
	/bin/sh: line 1: xmltos: command not found
	make: *** [check] Error 1

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Acked-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2014-01-20 14:53:54 +04:00
Kir Kolyshkin
5f9b8794e0 log: only print timestamps when verbosity increased
While timestamps can be handy, they clutter output for normal users.
Let's print them only when verbosity (-v) is increased from default.
Currently, default is 2 (-vv) so for timestamps one should use -vvv
or -v3.

Alternatively, we could introduce a separate --timestamps option.
Personally, I find it more handy for timestamps to be tied to log level.

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2014-01-11 09:18:03 +04:00
Kir Kolyshkin
81ee51f0e8 criu --help, Doc/criu.txt: fix -v option description
Current description of -v[vvv] was taken from criu-log.h comments
and describes specific log levels used by pr_* functions. The problem
is -vX includes all previous X-1, X-2... levels. Say, -vvvv description
says "debug only", while in fact it is not "only". Fix accordingly.

Also, removed -v0 description as it is useless. What -v0 in fact does is
it sets the log level to default -- same as if -vXXX is not used.

In addition, change a delimiter between option alternatives from comma
to a vertical bar in criu --help output, to be in line with the rest
of usage output.

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2014-01-11 09:17:34 +04:00
Kir Kolyshkin
19ea709e1a Doc/Makefile: add ps and pdf generation
It can be handful to check how a man page looks in PDF or Postscript.
Use 'make ps' and 'make pdf' to generate one.

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2014-01-11 09:16:40 +04:00
Kir Kolyshkin
5e10cb7319 Doc/Makefile: make clean less greedy
Only remove the files which we explicitly generate.

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2014-01-11 09:16:28 +04:00
Cyrill Gorcunov
c60c91f3d7 docs: Add 'service' command description
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-11-01 14:29:12 +04:00
Alexander Kartashov
0720fe3de7 Documnetation: added the HOWTO on cross-compilation
Signed-off-by: Alexander Kartashov <alekskartashov@parallels.com>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-11-01 14:27:40 +04:00
Cyrill Gorcunov
c1c9b8f6dc docs: Document -R|--leave-running option
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-11-01 13:36:12 +04:00
Cyrill Gorcunov
4aef183995 doc: make -- Add description for `obj-ext-src-y'
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-09-04 16:16:52 +04:00
Cyrill Gorcunov
4aacfda755 doc: make -- Add lib-so description
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-09-02 16:17:11 +04:00
Cyrill Gorcunov
70d86e08a3 docs: Add 'cleanup-y' description to Makefile.build.txt
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-08-28 17:04:38 +04:00
Kir Kolyshkin
0bc01e798c Documentation/Makefile: fix clean target
...after commit 1e1bf24

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-10 11:01:57 +04:00
Kir Kolyshkin
e516aa0122 Makefiles: add install target
Note to package maintainers:

1 Yes we do support DESTDIR.

2 From packaging scripts, use something like this:

	make install DESTDIR=$RPM_BUILD_ROOT PREFIX=/usr

(v2: add PREFIX, install to /usr/local not /usr by default)
(v3: fix criu man section -- it is 8 not 1)

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-03 01:56:30 +04:00
Kir Kolyshkin
abe3c594de Fix CRTOOLS_SCRIPT_ACTION name
... in quite a few places.

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:48:07 +04:00
Kir Kolyshkin
4eac6c9e6e criu(8): fix English in examples
1. s/pid 1234/pid of 1234/

2. Remove all those "one should type" or "run".

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:43:35 +04:00
Kir Kolyshkin
2ebe1db650 criu(8): remove -t from synopsys
Either we list all options in synopsys, or none.

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:43:30 +04:00
Kir Kolyshkin
d33a01482f criu(8): use list for -v arguments
Also, s/options/arguments/.

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:43:22 +04:00
Kir Kolyshkin
229b86a72c criu(8): it's -> it is
A manual page is formal document, not a chitchat, so use of contracted
forms is not appropriate.

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:43:16 +04:00
Kir Kolyshkin
77c3705a49 criu(8): fix a typo
allpies -> applies

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:43:07 +04:00
Kir Kolyshkin
ec413ac4e0 criu(8): more typesetting fixes.
Literals in bold, variables in italic.

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:43:01 +04:00
Kir Kolyshkin
6dc760b614 criu(8): use bold for options, separate by commas
1. Use *bold* for option names.

2. Separate long and short option by a comma and a space.

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:42:50 +04:00
Kir Kolyshkin
c4f60cea88 criu(8): move commands out of options, reformat
1. Move commands out of OPTIONS subsection.

2. Don't use bulleted list -- definition list (such as in OPTIONS) is
   better.

Also follwong -> following

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:42:32 +04:00
Kir Kolyshkin
091883513e criu(8): fix typesetting
It's actually not very complicated. Just do this:

1 For literals (verbal text, such as command or option name) use *bold*

2 For substitutions (variable parameter name) use 'italic'

3 Do not use <angle brackets> at all.

Example:

	*-f* 'file'

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:42:14 +04:00
Kir Kolyshkin
1e1bf240e6 criu(1): moved to criu(8)
This command is for root, so section 8 of manual is
more appropriate than 1.

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:42:01 +04:00
Kir Kolyshkin
455e1f782e criu(1): change COPYRIGHT section name and years
1 It should be COPYRIGHT not COPYING

2 Happy New Year!

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:40:37 +04:00
Kir Kolyshkin
cfdea52536 criu(1): man page title should be in UPPERCASE
It's a common practice.

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:40:30 +04:00
Kir Kolyshkin
7e43957602 Documentation: rename crtools(1) to criu(1)
Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:38:36 +04:00
Kir Kolyshkin
d32db87462 Doc/Makefile: mark clean target as phony
Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:32:34 +04:00
Kir Kolyshkin
04158bda8f Doc/Makefile: don't build Makefile.build man
This is developers documentation, I doubt any user of crui
is interested in that. So let's not build it by default.

It can still be built manually:

make -C Documentation Makefile.build.1

Signed-off-by: Kir Kolyshkin <kir@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-05-02 22:32:27 +04:00
Cyrill Gorcunov
3ab9ce3d7f docs: \Tabs to \Spaces
We don't use tabs in docs.

Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-04-30 20:14:28 +04:00
Cyrill Gorcunov
60178ffd13 docs: Add --ms option description
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-04-30 20:14:22 +04:00
Cyrill Gorcunov
bec67720cc docs: Add page server parameters explanation
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-04-30 20:14:15 +04:00
Cyrill Gorcunov
80c51eeb09 docs: crtools -- Use bold format for parameters
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-02-18 18:42:07 +04:00
Cyrill Gorcunov
44faee19c1 make: docs -- Append manpages generation
I occasionally used assignments instead of
appending manpages for generation. Fix it.

Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-02-18 18:42:07 +04:00
Cyrill Gorcunov
16c75274a1 docs: Add documentation about scritps/Makefile.build
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-02-18 18:10:42 +04:00
Cyrill Gorcunov
1f0f2cb995 docs: Put a \Backslash where needed
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-01-25 14:58:09 +04:00
Qiang Huang
882005a0ed doc: update the manpage document for file lock c/r
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2013-01-17 14:42:44 +04:00
Pavel Emelyanov
0f58bae4ce doc: Add syscalls execution description
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2012-12-18 00:39:20 +03:00
Cyrill Gorcunov
2f3e52d83f docs: Update documentation
- Drop -c option from "dump" context,
   it is no longer valid

 - Add --link-remap, --shell-job options

Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2012-10-18 19:47:17 +04:00
Cyrill Gorcunov
a0b497e035 docs: Prepare for 0.2
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2012-09-19 17:04:27 +04:00
Cyrill Gorcunov
c60661051d doc: Update -n option
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2012-08-06 18:30:02 +04:00
Cyrill Gorcunov
2f3727f0e2 docs: Add EXAMPLES section
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2012-07-23 07:09:39 +04:00
Cyrill Gorcunov
148273d098 docs: Shrink synopsis
All options are described below, only main arguments
should be there.

Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2012-07-23 07:09:31 +04:00
Cyrill Gorcunov
b4a4ba7ac9 docs: Add long and some new options
To reflect current options we support

Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2012-07-23 07:08:48 +04:00
Pavel Emelyanov
64967eef21 crtools: Kill the ability to work on individual process
We haven't tested it for several monthes and there's no evidence
it is required at all. For dumping a single task -t option works
just fine.

Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2012-07-19 17:55:34 +04:00
Cyrill Gorcunov
05421b2c5a docs: Add -s option
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Signed-off-by: Pavel Emelyanov <xemul@parallels.com>
2012-05-03 16:21:15 +04:00
Cyrill Gorcunov
119cee0d16 docs: Add 'check' option description
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
2012-03-02 14:23:45 +04:00
Cyrill Gorcunov
ef97467da9 log: Add log-levels
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
Acked-by: Pavel Emelyanov <xemul@parallels.com>
2012-02-20 14:23:28 +04:00