Skip to content

Commit 27d1f0d

Browse files
authored
Warn against absolute paths in Documentation/Usage.md (#7059)
Resolves rdar://115726598.
1 parent f3bc3b7 commit 27d1f0d

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

Documentation/Usage.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,9 +226,10 @@ The header file should look like this:
226226
#include <git2.h>
227227
```
228228

229-
**Note:** Alternatively, you can provide an absolute path to `git2.h` provided
230-
by the library in the `modile.modulemap`. However, doing so might break
231-
cross-platform compatibility of your project.
229+
**Note:** Avoiding specifying an absolute path to `git2.h` provided
230+
by the library in the `module.modulemap`. Doing so will break compatibility of
231+
your project between machines that may use a different file system layout or
232+
install libraries to different paths.
232233

233234
> The convention we hope the community will adopt is to prefix such modules
234235
> with `C` and to camelcase the modules as per Swift module name conventions.

0 commit comments

Comments
 (0)