mirror of https://github.com/docker/docker-py.git
Docstring fixes for init and init_path
Signed-off-by: Joffrey F <joffrey@docker.com>
This commit is contained in:
parent
8c6534d7be
commit
c0c3cb4497
|
|
@ -498,6 +498,9 @@ class ContainerApiMixin(object):
|
||||||
container, as a mapping of hostname to IP address.
|
container, as a mapping of hostname to IP address.
|
||||||
group_add (:py:class:`list`): List of additional group names and/or
|
group_add (:py:class:`list`): List of additional group names and/or
|
||||||
IDs that the container process will run as.
|
IDs that the container process will run as.
|
||||||
|
init (bool): Run an init inside the container that forwards
|
||||||
|
signals and reaps processes
|
||||||
|
init_path (str): Path to the docker-init binary
|
||||||
ipc_mode (str): Set the IPC mode for the container.
|
ipc_mode (str): Set the IPC mode for the container.
|
||||||
isolation (str): Isolation technology to use. Default: `None`.
|
isolation (str): Isolation technology to use. Default: `None`.
|
||||||
links (dict or list of tuples): Either a dictionary mapping name
|
links (dict or list of tuples): Either a dictionary mapping name
|
||||||
|
|
|
||||||
|
|
@ -493,7 +493,7 @@ class ContainerCollection(Collection):
|
||||||
hostname (str): Optional hostname for the container.
|
hostname (str): Optional hostname for the container.
|
||||||
init (bool): Run an init inside the container that forwards
|
init (bool): Run an init inside the container that forwards
|
||||||
signals and reaps processes
|
signals and reaps processes
|
||||||
init_path (bool): Path to the docker-init binary
|
init_path (str): Path to the docker-init binary
|
||||||
ipc_mode (str): Set the IPC mode for the container.
|
ipc_mode (str): Set the IPC mode for the container.
|
||||||
isolation (str): Isolation technology to use. Default: `None`.
|
isolation (str): Isolation technology to use. Default: `None`.
|
||||||
labels (dict or list): A dictionary of name-value labels (e.g.
|
labels (dict or list): A dictionary of name-value labels (e.g.
|
||||||
|
|
|
||||||
|
|
@ -423,9 +423,9 @@ class HostConfig(dict):
|
||||||
raise host_config_version_error('init', '1.25')
|
raise host_config_version_error('init', '1.25')
|
||||||
self['Init'] = init
|
self['Init'] = init
|
||||||
|
|
||||||
if init_path:
|
if init_path is not None:
|
||||||
if version_lt(version, '1.25'):
|
if version_lt(version, '1.25'):
|
||||||
raise host_config_version_error('init', '1.25')
|
raise host_config_version_error('init_path', '1.25')
|
||||||
self['InitPath'] = init_path
|
self['InitPath'] = init_path
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue