Browse Source

Clarify relative paths for SPM plugin docs (#1488)

Resolves #1487
George Barnett 3 years ago
parent
commit
04b35de0e2
1 changed files with 3 additions and 1 deletions
  1. 3 1
      Sources/protoc-gen-grpc-swift/Docs.docc/spm-plugin.md

+ 3 - 1
Sources/protoc-gen-grpc-swift/Docs.docc/spm-plugin.md

@@ -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
 source directory. You should also commit these files to your git repository since the generated types
 are now generated on demand.
 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
 ### Adding the plugin to your manifest
 
 
@@ -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.
 > 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
 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.
 is generating Swift types for the `Foo.proto` file with `internal` visibility. Notice the relative path to the `.proto` file.