From 5b8296782b35983ff672851c52f4797e3c9d869f Mon Sep 17 00:00:00 2001 From: Daniel Frederick Crisman Date: Thu, 16 Mar 2023 15:11:06 -0400 Subject: [PATCH] Documentation: expand project layout to match usage (#3304) The tree view of the project layout seemed to show that "github.com", "cmd", and "pkg" were all in the same directory. The usage later in the document (and normal go layout) would have them as subdirectories. The new tree output was generated with the below: (cd `mktemp -d` mkdir -p github.com/me/foo/{cmd/foo,pkg/baz} touch github.com/me/foo/{cmd/foo/main,pkg/baz/bar{_test,}}.go tree -n --noreport github.com/me/foo ) --- Documentation/cli/getting_started.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/Documentation/cli/getting_started.md b/Documentation/cli/getting_started.md index 504a287e..039239dc 100644 --- a/Documentation/cli/getting_started.md +++ b/Documentation/cli/getting_started.md @@ -14,15 +14,14 @@ otherwise it optionally accepts a package path. For example given this project layout: ``` -. -├── github.com/me/foo +github.com/me/foo ├── cmd -│ └── foo -│ └── main.go -├── pkg -│ └── baz -│ ├── bar.go -│ └── bar_test.go +│   └── foo +│   └── main.go +└── pkg + └── baz + ├── bar.go + └── bar_test.go ``` If you are in the directory `github.com/me/foo/cmd/foo` you can simply run `dlv debug`