Skip to content

Warn against absolute paths in Documentation/Usage.md #7059

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

Merged
merged 2 commits into from
Nov 7, 2023
Merged

Warn against absolute paths in Documentation/Usage.md #7059

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e75b64
Warn against absolute paths in `Documentation/Usage.md`
MaxDesiatov Nov 7, 2023
825739c
Update Usage.md
MaxDesiatov Nov 7, 2023
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
7 changes: 4 additions & 3 deletions Documentation/Usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,9 +226,10 @@ The header file should look like this:
#include <git2.h>
```

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

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