summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Bajao <ebajao@gitlab.com>2022-06-03 11:07:24 +0000
committerIgor Drozdov <idrozdov@gitlab.com>2022-08-03 16:25:47 +0200
commit3183c96d9c18ba9a7863fd8c5ced3f3a53d0cae8 (patch)
tree5b69ba8df142f5cb74129f0a65c1175fe22a6042
parent253679bd0d010db18b8a701ef5bb48ceb0ab4242 (diff)
downloadgitlab-shell-3183c96d9c18ba9a7863fd8c5ced3f3a53d0cae8.tar.gz
Specify all packages that use commands
-rw-r--r--internal/command/README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/internal/command/README.md b/internal/command/README.md
index 418fbaa..06551e1 100644
--- a/internal/command/README.md
+++ b/internal/command/README.md
@@ -23,4 +23,8 @@ A command is executed by running the `Execute` method. The execution logic mostl
- If a command is related to Git operations, establish a connection with Gitaly using [handler](https://gitlab.com/gitlab-org/gitlab-shell/-/tree/main/internal/handler) and [gitaly](https://gitlab.com/gitlab-org/gitlab-shell/-/tree/main/internal/gitaly) packages and provide two-way communication between Gitaly and the client.
- Return results to the client.
-[cmd/gitlab-shell/command](https://gitlab.com/gitlab-org/gitlab-shell/-/tree/main/cmd/gitlab-shell/command) is using this package to build a particular command based on the passed arguments.
+This package is being used to build a particular command based on the passed arguments in the following files that are under `cmd` directory:
+- [cmd/gitlab-shell/command](https://gitlab.com/gitlab-org/gitlab-shell/-/tree/main/cmd/gitlab-shell/command)
+- [cmd/check/command](https://gitlab.com/gitlab-org/gitlab-shell/-/tree/main/cmd/check/command)
+- [cmd/gitlab-shell-authorized-keys-check/command](https://gitlab.com/gitlab-org/gitlab-shell/-/tree/main/cmd/gitlab-shell-authorized-keys-check/command)
+- [cmd/gitlab-shell-authorized-principals-check/command](https://gitlab.com/gitlab-org/gitlab-shell/-/tree/main/cmd/gitlab-shell-authorized-principals-check/command)