Merge branch 'jmd/move-gpg-binary-doc-comment' into 'master'

Move doc comment relating to gpg-signing to relevant binary

See merge request https://gitlab.com/gitlab-org/gitaly/-/merge_requests/6335

Merged-by: John Cai <jcai@gitlab.com>
Approved-by: John Cai <jcai@gitlab.com>
Co-authored-by: John McDonnell <jmcdonnell@gitlab.com>

2 files changed, 9 insertions, 9 deletions

diff --git a/cmd/gitaly-gpg/main.go b/cmd/gitaly-gpg/main.go
index ca41ed1d2..49e37fcfc 100644
--- a/cmd/gitaly-gpg/main.go
+++ b/cmd/gitaly-gpg/main.go
@@ -57,6 +57,15 @@ func gpgApp() *cli.App {
 	}
 }
 
+// This binary is used to support signing through providing the path to the
+// actual signing key. Git itself does not support this since it simply calls
+// out to gpg(1), which only supports fetching keys from the gpg database.
+// This binary is used as a stopgap measure since we can set Git's gpg.program
+// config to point to this binary, which interprets the key_id passed in as the
+// path to the signing key.
+// In the future, we will modify Git so that commit-tree can take in a raw
+// commit message that we can add a signature to, at which point we can sign
+// commits manually and get rid of this binary.
 func main() {
 	if err := gpgApp().Run(os.Args); err != nil {
 		log.Fatal(err)
diff --git a/cmd/gitaly/main.go b/cmd/gitaly/main.go
index 36fe0734d..14190f3eb 100644
--- a/cmd/gitaly/main.go
+++ b/cmd/gitaly/main.go
@@ -7,15 +7,6 @@ import (
 	cli "gitlab.com/gitlab-org/gitaly/v16/internal/cli/gitaly"
 )
 
-// This binary is used to support signing through providing the path to the
-// actual signing key. Git itself does not support this since it simply calls
-// out to gpg(1), which only supports fetching keys from the gpg database.
-// This binary is used as a stopgap meaure since we can set Git's gpg.program
-// config to point to this binary, which interprets the key_id passed in as the
-// path to the signing key.
-// In the future, we will modify Git so that commit-tree can take in a raw
-// commit message that we can add a signature to, at which point we can sign
-// commits manually and get rid of this binary.
 func main() {
 	if err := cli.NewApp().Run(os.Args); err != nil {
 		log.Fatal(err)