From db225f899c74a0baeb23807c0c06fd8ac1f7808e Mon Sep 17 00:00:00 2001 From: Jens Binder Date: Thu, 13 Jul 2023 23:56:26 +0200 Subject: [PATCH] Documentation alignment Aligns the README.md with the changes done in c70f927. Minor spell corrections in documentation and comments. --- README.md | 12 ++++++------ emu/containers/docker_container.py | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c0462469..381aaac8 100644 --- a/README.md +++ b/README.md @@ -185,18 +185,18 @@ and system image. After the two are obtained, we can build a Docker image. Given an emulator zip file and a system image zip file, we can build a directory that can be sent to `docker build` via the following invocation of `emu-docker`: - emu-docker create [--dest docker-src-dir - (getcwd()/src by default)] + emu-docker create [--dest docker-bld-dir + (Path.cwd()/"bld" by default)] -This places all the right elements to run a docker image, but does not build, +This places all elements for a docker image, but does not build, run or publish yet. A Linux emulator zip file must be used. -## Building the Docker image: Setting up the source dir +## Building the Docker image: Setting up the build dir To build the Docker image corresponding to these emulators and system images: - docker build + docker build A Docker image ID will output; save this image ID. diff --git a/emu/containers/docker_container.py b/emu/containers/docker_container.py index 99e0e874..7bc7419a 100644 --- a/emu/containers/docker_container.py +++ b/emu/containers/docker_container.py @@ -65,7 +65,7 @@ def push(self) -> None: logging.warning("docker push %s", image) def launch(self, port_map) -> Image: - """Launches the container with the given sha, publishing abd on port, and gRPC on port 8554 + """Launches the container with the given sha, publishing adb on port 5555, and gRPC on port 8554 Returns the container. """ @@ -198,7 +198,7 @@ def docker_image(self) -> Image: def available(self): """True if this container image is locally available.""" if self.docker_image(): - logging.info("%s is avaliable", self.docker_image().tags) + logging.info("%s is available", self.docker_image().tags) return True return False