- add the new mode and document it;
- slightly improve the --help output;
- slightly simplify the parsing code.
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Current runc man pages are ugly (no proper man page formatting)
and very short (mostly just a copy-paste from the "runc <command>
--help" output. They are also somewhat obsoleted as not all CLI updates
were propagated to man/*.
This commits makes the first step to solving this.
In short:
- added some more information about some options;
- lots of formatting fixes;
- use references to other man pages and web pages;
- fix SYNOPSYS (formatting, mostly);
- removed the repeated description of <container_id> from every page;
- added SEE ALSO;
- something else I forgot.
Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
The man-pages are using pre-formatted section to display the options for
all commands. The result on my system never looked correct:
OPTIONS
--bundle value, -b value path to the root [...]
--console-socket value path to an AF_UNIX [...]
The first line was always indented less than the other lines.
This commit makes the option block a pre-formatted block (as intended???) by
using 4 spaces instead of 3 spaces.
In addition the man-pages did not specify their name and section
correctly. This adds something like '% runc-run "8"' to all man-pages to
have correct title 'runc-run(8)' instead of 'NAME()' and it also adds
the section to the title: 'System Manager's Manual'.
This also fixes the use of '>' and '<' at multiple places. The markdown
source files were using "<container-id>" and similar which was (most of
the time) rendered as '""'. On some systems it was rendered correctly.
Signed-off-by: Adrian Reber <areber@redhat.com>
CRIU gets pre-dump to complete iterative migration.
pre-dump saves process memory info only. And it need parent-path
to specify the former memory files.
This patch add pre-dump and parent-path arguments to runc checkpoint
Signed-off-by: Deng Guangxing <dengguangxing@huawei.com>
Signed-off-by: Adrian Reber <areber@redhat.com>
The major change is the description of options, change
it as the latest cli help message shows, which specify
a "value" after an option if it takes value, and add
(default: xxx) if the option has a default value.
This also includes some other minor consistency fixes.
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
Reason1:
other runc manual are using word of "SYNOPSIS"
# grep USAGE man/*
# man/runc-checkpoint.8.md:#USAGE
#
# grep SYNOPSIS man/*
man/runc-checkpoint.8.md:# SYNOPSIS
man/runc-delete.8.md:# SYNOPSIS
man/runc-events.8.md:# SYNOPSIS
man/runc-exec.8.md:# SYNOPSIS
man/runc-kill.8.md:# SYNOPSIS
man/runc-list.8.md:# SYNOPSIS
man/runc-pause.8.md:# SYNOPSIS
man/runc-restore.8.md:# SYNOPSIS
man/runc-resume.8.md:# SYNOPSIS
man/runc-spec.8.md:# SYNOPSIS
man/runc-start.8.md:# SYNOPSIS
man/runc-state.8.md:# SYNOPSIS
man/runc-update.8.md:# SYNOPSIS
man/runc.8.md:# SYNOPSIS
#
Reason2:
Most linux commands are using word of "SYNOPSIS"
# man ls
# man find
# ...
Signed-off-by: Zhao Lei <zhaolei@cn.fujitsu.com>
Patrick Stoeckle