Skip to content

Documentation alignment #350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Documentation alignment #350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <emulator-zip> <system-image-zip> [--dest docker-src-dir
(getcwd()/src by default)]
emu-docker create <emulator-zip> <system-image-zip> [--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-src-dir, either ./src or specified argument to
emu_docker.py>
docker build <docker-bld-dir, either ./bld or the argument to
emu_docker --dest>

A Docker image ID will output; save this image ID.

Expand Down
4 changes: 2 additions & 2 deletions emu/containers/docker_container.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down Expand Up @@ -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

Expand Down