Skip to content

Commit

Permalink
change doc
Browse files Browse the repository at this point in the history
  • Loading branch information
JoeWang1127 committed Sep 18, 2024
1 parent 855d601 commit c6af16e
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion library_generation/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Generate a repository containing GAPIC Client Libraries

The script, `entry_point.py`, allows you to generate a repository containing
GAPIC client libraries with googleapis commit history (a monorepo, for example,
GAPIC client libraries with change history (a monorepo, for example,
google-cloud-java) from a configuration file.

## Environment
Expand Down Expand Up @@ -54,6 +54,14 @@ The path to where the api definition (proto, service yaml) resides.

The default value is the current working directory when running the script.

Note that you need not only the protos defined the service, but also the transitive
dependencies of those protos.
For example, if your service is defined in `example_service.proto` and it imports
`google/api/annotations.proto`, you need the `annotations.proto` resides in a
folder that has the exact structure of the import statement (`google/api` in this
case), and set `api_definition_path` to the path contains the root folder (`google`
in this case).

## Output of `entry_point.py`

### GAPIC libraries
Expand Down

0 comments on commit c6af16e

Please sign in to comment.