[llvm] bef2658 - [llvm] Proofread Docker.rst (#160448)
via llvm-commits
llvm-commits at lists.llvm.org
Wed Sep 24 15:56:42 PDT 2025
Author: Kazu Hirata
Date: 2025-09-24T15:56:38-07:00
New Revision: bef2658de05f17088b06c7fc84739fb3c05c5ce6
URL: https://github.com/llvm/llvm-project/commit/bef2658de05f17088b06c7fc84739fb3c05c5ce6
DIFF: https://github.com/llvm/llvm-project/commit/bef2658de05f17088b06c7fc84739fb3c05c5ce6.diff
LOG: [llvm] Proofread Docker.rst (#160448)
Added:
Modified:
llvm/docs/Docker.rst
Removed:
################################################################################
diff --git a/llvm/docs/Docker.rst b/llvm/docs/Docker.rst
index 5d976eddb3130..5f8e619d8b5eb 100644
--- a/llvm/docs/Docker.rst
+++ b/llvm/docs/Docker.rst
@@ -27,8 +27,8 @@ to get a very basic explanation of it.
`Docker <https://www.docker.com/>`_ is a popular solution for running programs in
an isolated and reproducible environment, especially to maintain releases for
software deployed to large distributed fleets.
-It uses linux kernel namespaces and cgroups to provide a lightweight isolation
-inside currently running linux kernel.
+It uses Linux kernel namespaces and cgroups to provide a lightweight isolation
+inside currently running Linux kernel.
A single active instance of dockerized environment is called a *docker
container*.
A snapshot of a docker container filesystem is called a *docker image*.
@@ -127,17 +127,17 @@ Which image should I choose?
We currently provide two images: Debian12-based and nvidia-cuda-based. They
diff er in the base image that they use, i.e. they have a
diff erent set of
preinstalled binaries. Debian8 is very minimal, nvidia-cuda is larger, but has
-preinstalled CUDA libraries and allows to access a GPU, installed on your
+preinstalled CUDA libraries and allows access to a GPU, installed on your
machine.
-If you need a minimal linux distribution with only clang and libstdc++ included,
+If you need a minimal Linux distribution with only clang and libstdc++ included,
you should try Debian12-based image.
If you want to use CUDA libraries and have access to a GPU on your machine,
you should choose nvidia-cuda-based image and use `nvidia-docker
<https://github.com/NVIDIA/nvidia-docker>`_ to run your docker containers. Note
that you don't need nvidia-docker to build the images, but you need it in order
-to have an access to GPU from a docker container that is running the built
+to have access to a GPU from a docker container that is running the built
image.
If you have a
diff erent use-case, you could create your own image based on
@@ -176,4 +176,4 @@ The first image is only used during build and does not have a descriptive name,
i.e. it is only accessible via the hash value after the build is finished.
The second image is our resulting image. It contains only the built binaries
and not any build dependencies. It is also accessible via a descriptive name
-(specified by -d and -t flags).
+(specified by ``-d`` and ``-t`` flags).
More information about the llvm-commits
mailing list