PenaDevops/delve
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
540e63a55e
delve/Documentation/installation/linux/install.md

20 lines
600 B
Markdown
Raw Normal View History

docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
# Installation on Linux
Please use the following steps to build and install Delve on Linux.
There are two ways to install on Linux. First is the standard `go get` method:
```
Documentation: add modules mode note to install documentation 1. Adds a note to the documentation describing how to use 'go get' in modules mode 2. Removes the '-u' option which, when 'go get' is used incorrectly will make 'go' try to compile Delve with unsupported dependencies 3. Removed obsolete note about Go 1.5 vendor experiment. Fixes #1988
2020-04-06 12:34:22 +00:00
go get github.com/go-delve/delve/cmd/dlv
docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
```
Documentation: add modules mode note to install documentation 1. Adds a note to the documentation describing how to use 'go get' in modules mode 2. Removes the '-u' option which, when 'go get' is used incorrectly will make 'go' try to compile Delve with unsupported dependencies 3. Removed obsolete note about Go 1.5 vendor experiment. Fixes #1988
2020-04-06 12:34:22 +00:00
Note: if you are using Go in modules mode you must execute this command outside of a module directory or Delve will be added to your project as a dependency.
Documentation: make install must run in workspace
2018-03-11 16:31:46 +00:00
Alternatively make sure $GOPATH is set (e.g. as `~/.go`) and:
docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
```
*: Update import name to github.com/go-delve/delve The repository is being switched from the personal account github.com/derekparker/delve to the organization account github.com/go-delve/delve. This patch updates imports and docs, while preserving things which should not be changed such as my name in the CHANGELOG and in TODO comments.
2019-01-04 18:39:25 +00:00
$ git clone https://github.com/go-delve/delve.git $GOPATH/src/github.com/go-delve/delve
$ cd $GOPATH/src/github.com/go-delve/delve
docs: Move wiki docs into Documentation dir Going forward, all documentation should be placed in the Documentation directory in the root of the project. This switch allows maintainers to approve updates to documentation before they are committed, as opposed to the pre-existing wiki which anybody could modify. Currently the Documentation directory includes docs on building, usage, and minimal docs around the API. This is just the initial commit, and documentation will continue to improve over time. Some changes have been made (and will continue to be made) to `cmd/dlv` to ensure we can auto-generate documentation for all commands from the newly provided script `scripts/gen-usage-docs.go`, which can be invoked via `go run scripts/gen-usage-docs.go`. Additionally, version has been split into its own package. This was a bit of housekeeping related to the changes made the `cmd/dlv`.
2016-02-19 18:32:24 +00:00
$ make install
```
Reference in New Issue Copy Permalink