@@ -7,7 +7,7 @@ Let's revisit the Wordpress example:
7
7
$ kpt pkg get https://github.com/GoogleContainerTools/kpt.git/package-examples/
[email protected]
8
8
```
9
9
10
- A package in a Git repo can be fetched by specifying a branch, tag, or a commit SHA. In this case,
10
+ A package in a Git repo can be fetched by specifying a branch, tag, or commit SHA. In this case,
11
11
we are specifying tag ` v0.1 ` .
12
12
13
13
> Refer to the [ command reference] [ get-doc ] for more details.
@@ -56,7 +56,7 @@ The `Kptfile` contains two sections to keep track of the upstream package:
56
56
contains three pieces of information :
57
57
- `repo` : The Git repository where the package can be found
58
58
- `directory` : The directory within the Git repository where this package can be found
59
- - `ref` : The Git reference for the package. This can be either a brach , tag, or commit SHA.
59
+ - `ref` : The Git reference for the package. This can be either a branch , tag, or commit SHA.
60
60
2. The `upstreamLock` section records the upstream Git reference (exact Git SHA) that was fetched by
61
61
kpt. This section is managed by kpt and should not be changed manually.
62
62
@@ -88,21 +88,22 @@ This is because there are two different package types in kpt:
88
88
In this case, the `mysql` subpackage is a _dependent package_. The upstream package for `mysql` is
89
89
automatically inferred from the parent package. You can think of the `Kptfile` in the `mysql`
90
90
package as implicitly inheriting the `upstream` section of its parent, with the only difference
91
- being that `upstream.directory` points to `/package-examples/wordpress/mysql`.
91
+ being that `upstream.directory` in the subpackage would instead point to
92
+ ` /package-examples/wordpress/mysql` .
92
93
93
94
# # Package Name and Identifier
94
95
95
96
It is possible to specify a different local directory name to the `get` command. For example,
96
- the following fetches the packages to a directory names `mywordpress` :
97
+ the following fetches the packages to a directory named `mywordpress` :
97
98
98
99
` ` ` shell
99
100
$ kpt pkg get https://github.com/GoogleContainerTools/kpt.git/package-examples/[email protected] mywordpress
100
101
` ` `
101
102
102
- The _name_ of a package is given by its directory name. Since the Kptfile is a KRM resource and
103
+ The _name of a package_ is given by its directory name. Since the Kptfile is a KRM resource and
103
104
follows the familiar structure of KRM resources, the name of the package is also available from the
104
- ` metadata.name` field. This must always be the same of the directory name and kpt will update it
105
- automatically when forking a package. In this case, `metadata.name` is set `mywordpress`.
105
+ ` metadata.name` field. This must always be the name of the directory, and kpt will update it
106
+ automatically when forking a package. In this case, `metadata.name` is set to `mywordpress`.
106
107
107
108
The name of a package is unique within its parent package, but it may not be unique in a deeply
108
109
nested package hierarchy (i.e. Depth > 2). The _unique identifier_ for a package is defined as the
0 commit comments