Skip to content

Commit 2cd5634

Browse files
docs: fix typos in the DESIGN.md (#299)
Signed-off-by: Nithin Puthenveettil <nithin.puthenveettil@ibm.com>
1 parent 42fa357 commit 2cd5634

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

DESIGN.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ used via the environment variable [`LD_PRELOAD`](https://man7.org/linux/man-page
55
[`/etc/ld.so.preload`](https://man7.org/linux/man-pages/man8/ld.so.8.html#FILES) file, or similar mechanisms to inject
66
environment variables into processes at startup.
77

8-
See [README.me](README.md) for a general purpose overview.
8+
See [README.md](README.md) for a general purpose overview.
99
This document focusses on the technical design and the design constraints leading to the approach taken by this project.
1010

1111
In the remainder of this document `LD_PRELOAD` and `/etc/ld.so.preload` are used interchangeably.
@@ -119,9 +119,9 @@ For environment variables that the injector does not care about, it returns the
119119
In fact, this strategy would get us 99% of the way, and it has been used in previous incarnations of the OpenTelemetry injector.
120120

121121
To make this work, the injector needs to be able to read the process environment on its own, since it cannot rely
122-
on libc functionality to get the enviroment.
122+
on libc functionality to get the environment.
123123
(And it obviously needs to know the environment to be able to return the original values for environment variables it
124-
does not want to modifiy and also for appending to the ones it needs to modify, if they are already set.)
124+
does not want to modify and also for appending to the ones it needs to modify, if they are already set.)
125125
One way of doing that is to declare a dependency on the `__environ` symbol (e.g. `extern char **__environ`), which is a
126126
pointer to the in-memory storage of the environment.
127127
Again, this will crash [binaries](#dynamically-linked-libc-free-binaries) that are subject to dynamic linking but do not
@@ -132,7 +132,7 @@ Another way of getting the environment would be to read the file `/proc/self/env
132132
variables as a null-separated list of `KEY=VALUE` strings.
133133
This would solve the problem of the missing `__environ` symbol at startup.
134134

135-
Unfortunately, there are still isssues with the approach to export `getenv`:
135+
Unfortunately, there are still issues with the approach to export `getenv`:
136136

137137
* Most importantly, a lot of runtimes do not use `getenv` consistently to read environment variables.
138138
Instead, they declare a dependency on the `__environ` symbol (or one of its aliases like `_environ` or `environ`)

0 commit comments

Comments
 (0)