Changes for style guide compliance

chenopis · chenopis · commit 450819d22906 · 2025-10-15T14:09:04.000-07:00
Signed-off-by: Andrew Chen &lt;andrewch@nvidia.com&gt;
diff --git a/container-toolkit/arch-overview.md b/container-toolkit/arch-overview.md
@@ -78,7 +78,7 @@ This component is included in the `nvidia-container-toolkit` package.
 
 This component includes an executable that implements the interface required by a `runC` `prestart` hook. This script is invoked by `runC`
 after a container has been created, but before it has been started, and is given access to the `config.json` associated with the container
-(e.g. this [config.json](https://github.com/opencontainers/runtime-spec/blob/master/config.md#configuration-schema-example=) ). It then takes
+(such as this [config.json](https://github.com/opencontainers/runtime-spec/blob/master/config.md#configuration-schema-example=) ). It then takes
 information contained in the `config.json` and uses it to invoke the `nvidia-container-cli` CLI with an appropriate set of flags. One of the
 most important flags being which specific GPU devices should be injected into the container.
 
@@ -111,7 +111,7 @@ To use Kubernetes with Docker, you need to configure the Docker `daemon.json` to
 a reference to the NVIDIA Container Runtime and set this runtime as the default. The NVIDIA Container Toolkit contains a utility to update this file
 as highlighted in the `docker`-specific installation instructions.
 
-See the {doc}`install-guide` for more information on installing the NVIDIA Container Toolkit on various Linux distributions.
+Refer to the {doc}`install-guide` for more information on installing the NVIDIA Container Toolkit on various Linux distributions.
 
 ### Package Repository
 
@@ -130,7 +130,7 @@ For the different components:
 
 :::{note}
 As of the release of version `1.6.0` of the NVIDIA Container Toolkit the packages for all components are
-published to the `libnvidia-container` `repository <https://nvidia.github.io/libnvidia-container/>` listed above. For older package versions please see the documentation archives.
+published to the `libnvidia-container` `repository <https://nvidia.github.io/libnvidia-container/>` listed above. For older package versions refer to the documentation archives.
 :::
 
 Releases of the software are also hosted on `experimental` branch of the repository and are graduated to `stable` after test/validation. To get access to the latest
diff --git a/container-toolkit/docker-specialized.md b/container-toolkit/docker-specialized.md
@@ -206,7 +206,7 @@ The supported constraints are provided below:
       - constraint on the compute architectures of the selected GPUs.
 
     * - ``brand``
-      - constraint on the brand of the selected GPUs (e.g. GeForce, Tesla, GRID).
+      - constraint on the brand of the selected GPUs (such as GeForce, Tesla, GRID).
 ```
 
 Multiple constraints can be expressed in a single environment variable: space-separated constraints are ORed,
diff --git a/container-toolkit/index.md b/container-toolkit/index.md
@@ -35,5 +35,5 @@ The NVIDIA Container Toolkit is a collection of libraries and utilities enabling
 ## License
 
 The NVIDIA Container Toolkit (and all included components) is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) and
-contributions are accepted with a Developer Certificate of Origin (DCO). See the [contributing](https://github.com/NVIDIA/nvidia-container-toolkit/blob/master/CONTRIBUTING.md) document for
+contributions are accepted with a Developer Certificate of Origin (DCO). Refer to the [contributing](https://github.com/NVIDIA/nvidia-container-toolkit/blob/master/CONTRIBUTING.md) document for
 more information.
diff --git a/container-toolkit/install-guide.md b/container-toolkit/install-guide.md
@@ -21,7 +21,7 @@ Alternatively, you can install the driver by [downloading](https://www.nvidia.co
 ```{note}
 There is a [known issue](troubleshooting.md#containers-losing-access-to-gpus-with-error-failed-to-initialize-nvml-unknown-error) on systems
 where `systemd` cgroup drivers are used that cause containers to lose access to requested GPUs when
-`systemctl daemon reload` is run. Please see the troubleshooting documentation for more information.
+`systemctl daemon reload` is run. Refer to the troubleshooting documentation for more information.
 ```
 
 (installing-with-apt)=
@@ -201,7 +201,7 @@ No additional configuration is needed.
 You can just run `nerdctl run --gpus=all`, with root or without root.
 You do not need to run the `nvidia-ctk` command mentioned above for Kubernetes.
 
-See also the [nerdctl documentation](https://github.com/containerd/nerdctl/blob/main/docs/gpu.md).
+Refer to the [nerdctl documentation](https://github.com/containerd/nerdctl/blob/main/docs/gpu.md) for more information.
 
 ### Configuring CRI-O
 
diff --git a/container-toolkit/release-notes.md b/container-toolkit/release-notes.md
@@ -103,7 +103,7 @@ This release of the NVIDIA Container Toolkit `v1.17.7` is a bugfix and minor fea
 ### Fixes and Features
 - Fixed mode detection on Thor-based systems. With this change, the runtime mode correctly resolves to `csv`.
 - Fixed the resolution of libraries in the LDCache on ARM. This fixes CDI spec generation on ARM-based systems using NVML.
-- Added a `nvidia-container-runtime-modes.legacy.cuda-compat-mode` option to provide finer control of how CUDA Forward Compatibility is handled. The default value (`ldconfig`) fixes CUDA Compatibility Support in cases where only the NVIDIA Container Runtime Hook is used (e.g. the Docker `--gpus` command line flag).
+- Added a `nvidia-container-runtime-modes.legacy.cuda-compat-mode` option to provide finer control of how CUDA Forward Compatibility is handled. The default value (`ldconfig`) fixes CUDA Compatibility Support in cases where only the NVIDIA Container Runtime Hook is used (such as the Docker `--gpus` command line flag).
 - Improved the `update-ldcache` hook to run in isolated namespaces. This improves hook security.
 
 
@@ -386,7 +386,7 @@ The following `container-toolkit` conatiners are included:
 - Added support for requesting IMEX channels as volume mounts.
 - Added a `disable-imex-channel-creation` feature flag to disable the creation of IMEX channel device nodes when creating a container.
 - Added IMEX channel device nodes to the CDI specifications in `management` mode.
-- Added the creation of select driver symlinks (e.g. `libcuda.so`) in CDI specification generation to match the behavior in the `legacy` mode.
+- Added the creation of select driver symlinks (such as `libcuda.so`) in CDI specification generation to match the behavior in the `legacy` mode.
 
 
 ### Enhancements to container-toolkit Container Images
@@ -429,7 +429,7 @@ The following `container-toolkit` conatiners are included:
 ### Fixes and Features
 
 - Excluded `libnvidia-allocator` from graphics mounts. This fixes a bug that leaks mounts when a container is started with bi-directional mount propagation.
-- Used empty string for default `runtime-config-override`. This removes a redundant warning for runtimes (e.g. Docker) where this is not applicable.
+- Used empty string for default `runtime-config-override`. This removes a redundant warning for runtimes (such as Docker) where this is not applicable.
 
 ### Enhancements to container-toolkit Container Images
 
@@ -866,7 +866,7 @@ The following `container-toolkit` containers are included:
 
 ### Fixes and Features
 
-- Fixed a bug which would cause the update of an ldcache in the container to fail for images that do no use ldconfig (e.g. `busybox`).
+- Fixed a bug which would cause the update of an ldcache in the container to fail for images that do no use ldconfig (such as `busybox`).
 - Fixed a bug where a failure to determine the CUDA driver version would cause the container to fail to start if `NVIDIA_DRIVER_CAPABILITIES` included `graphics` or `display` on Debian systems.
 - Fixed CDI specification generation on Debian systems.
 
@@ -1060,7 +1060,7 @@ Note that this release does not include an update to `nvidia-docker2` and is com
 - Add `cdi` mode to NVIDIA Container Runtime
 - Add discovery of GPUDirect Storage (`nvidia-fs*`) devices if the `NVIDIA_GDS` environment variable of the container is set to `enabled`
 - Add discovery of MOFED Infiniband devices if the `NVIDIA_MOFED` environment variable of the container is set to `enabled`
-- Add `nvidia-ctk runtime configure` command to configure the Docker config file (e.g. `/etc/docker/daemon.json`) for use with the NVIDIA Container Runtime.
+- Add `nvidia-ctk runtime configure` command to configure the Docker config file (such as `/etc/docker/daemon.json`) for use with the NVIDIA Container Runtime.
 
 #### specific to libnvidia-container
 
@@ -1145,7 +1145,7 @@ The following packages have also been updated to depend on `nvidia-container-too
 - Bump `libtirpc` to `1.3.2`
 - Fix bug when running host ldconfig using glibc compiled with a non-standard prefix
 - Add `libcudadebugger.so` to list of compute libraries
-- \[WSL2\] Fix segmentation fault on WSL2s system with no adpaters present (e.g. `/dev/dxg` missing)
+- \[WSL2\] Fix segmentation fault on WSL2s system with no adpaters present (such as `/dev/dxg` missing)
 - Ignore pending MIG mode when checking if a device is MIG enabled
 - \[WSL2\] Fix bug where `/dev/dxg` is not mounted when `NVIDIA_DRIVER_CAPABILITIES` does not include "compute"
 
diff --git a/container-toolkit/supported-platforms.md b/container-toolkit/supported-platforms.md
@@ -22,17 +22,16 @@ Recent NVIDIA Container Toolkit releases are tested and expected to work on thes
 | Ubuntu 24.04             | X              |         | X                        |
 
 
-## Please report issues
+## Report issues
 
 Our qualification-testing procedures are constantly evolving and we might miss
-certain problems. Please
-[report](https://github.com/NVIDIA/nvidia-container-toolkit/issues) issues in
+certain problems. [Report](https://github.com/NVIDIA/nvidia-container-toolkit/issues) issues in
 particular as they occur on a platform listed above.
 
 
 ## Other Linux distributions
 
-Releases may work on more platforms than indicated in the table above (e.g., on distribution versions older and newer than listed).
+Releases may work on more platforms than indicated in the table above (such as on distribution versions older and newer than listed).
 Give things a try and we invite you to [report](https://github.com/NVIDIA/nvidia-container-toolkit/issues) any issue observed even if your Linux distribution is not listed.
 
 ----
diff --git a/container-toolkit/troubleshooting.md b/container-toolkit/troubleshooting.md
@@ -124,9 +124,9 @@ Review the SELinux policies on your system.
 
 ## Containers losing access to GPUs with error: "Failed to initialize NVML: Unknown Error"
 
-When using the NVIDIA Container Runtime Hook (i.e. the Docker `--gpus` flag or
+When using the NVIDIA Container Runtime Hook (that is, the Docker `--gpus` flag or
 the NVIDIA Container Runtime in `legacy` mode) to inject requested GPUs and driver
-libraries into a container, the hook makes modifications, including setting up cgroup access, to the container without the low-level runtime (e.g. `runc`) being aware of these changes.
+libraries into a container, the hook makes modifications, including setting up cgroup access, to the container without the low-level runtime (such as `runc`) being aware of these changes.
 The result is that updates to the container may remove access to the requested GPUs.
 
 When the container loses access to the GPU, you will see the following error message from the console output:
