Skip to content

Commit

Permalink
README.md: Don't call alternative main packages "variants".
Browse files Browse the repository at this point in the history
The term "build variant" has a different meaning defined in PACKAGING.md, so
avoid using that term.
  • Loading branch information
xiaq committed Jun 8, 2024
1 parent 1e3549f commit 1fed020
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,15 +98,16 @@ The installation directory is probably not in your OS's default `$PATH`. You
should either either add it to `$PATH`, or manually copy the Elvish binary to a
directory already in `$PATH`.

### Building a variant
### Building an alternative entrypoint

Elvish has several *build variants* with slightly different feature sets. For
example, the `withpprof` build variant has
[profiling support](https://pkg.go.dev/runtime/pprof).
In additional to `src.elv.sh/cmd/elvish` (which corresponds to the
[`cmd/elvish`](./cmd/elvish) directory in the repo), there are a few alternative
entrypoints, all named liked `cmd/*/elvish`, with slightly different feature
sets. (From the perspective of Go, these are just different `main` packages.)

These build variants are just alternative main packages. For example, to build
the `withpprof` variant, run the following command (change the part after `@` to
get different versions):
For example, install the `cmd/withpprof/elvish` entrypoint to get
[profiling support](https://pkg.go.dev/runtime/pprof) (change the part after `@`
to get different versions):

```sh
go install src.elv.sh/cmd/withpprof/elvish@master
Expand Down

0 comments on commit 1fed020

Please sign in to comment.