Skip to content
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

Clarify relative paths for SPM plugin docs #1488

Merged
merged 1 commit into from
Sep 21, 2022
Merged

Clarify relative paths for SPM plugin docs #1488

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion Sources/protoc-gen-grpc-swift/Docs.docc/spm-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ Next, you need to add the `.proto` files for which you want to generate your Swi
source directory. You should also commit these files to your git repository since the generated types
are now generated on demand.

> Note: imports on your `.proto` files will have to include the relative path from the target source to the `.proto` file you wish to import.
> Note: imports on your `.proto` files will have to include the relative path from the target source to the `.proto` file you wish to import.
> Files **must** be contained within the target source directory.

### Adding the plugin to your manifest

Expand Down Expand Up @@ -87,6 +88,7 @@ to the root of your target's source folder. An example configuration file looks
```

> Note: paths to your `.proto` files will have to include the relative path from the target source to the `.proto` file location.
> Files **must** be contained within the target source directory.

In the above configuration, you declared two invocations to the `protoc` compiler. The first invocation
is generating Swift types for the `Foo.proto` file with `internal` visibility. Notice the relative path to the `.proto` file.
Expand Down