]> Cypherpunks repositories - gostls13.git/commitdiff
cmd/doc: delete
authorMichael Matloob <matloob@golang.org>
Wed, 23 Jul 2025 15:25:14 +0000 (11:25 -0400)
committerMichael Matloob <matloob@google.com>
Thu, 24 Jul 2025 16:59:36 +0000 (09:59 -0700)
Users should not invoke "go tool doc" directly, but should instead run
"go doc". Remove "cmd/doc" because it no longer invokes the "doc" tool
but incorporates its logic directly.

Fixes #74667

Change-Id: I357a3d7e0ca075f028df66e34951a41354c08941
Reviewed-on: https://go-review.googlesource.com/c/go/+/689835
Reviewed-by: Michael Matloob <matloob@google.com>
Auto-Submit: Michael Matloob <matloob@golang.org>
Reviewed-by: Michael Pratt <mpratt@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>

doc/next/3-tools.md
src/cmd/doc/doc.go [deleted file]

index 5638f240a5b12744564781b99e1ce4878df6ca41..9459a5490e79046e7a9ce3b6e6639162d6f01715 100644 (file)
@@ -2,5 +2,10 @@
 
 ### Go command {#go-command}
 
+<!-- go.dev/issue/74667 -->
+`cmd/doc`, and `go tool doc` have been deleted. `go doc` can be used as
+a replacement for `go tool doc`: it takes the same flags and arguments and
+has the same behavior.
+
 ### Cgo {#cgo}
 
diff --git a/src/cmd/doc/doc.go b/src/cmd/doc/doc.go
deleted file mode 100644 (file)
index ac15ad9..0000000
+++ /dev/null
@@ -1,55 +0,0 @@
-// Copyright 2015 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-
-// Doc (usually run as go doc) accepts zero, one or two arguments.
-//
-// Zero arguments:
-//
-//     go doc
-//
-// Show the documentation for the package in the current directory.
-//
-// One argument:
-//
-//     go doc <pkg>
-//     go doc <sym>[.<methodOrField>]
-//     go doc [<pkg>.]<sym>[.<methodOrField>]
-//     go doc [<pkg>.][<sym>.]<methodOrField>
-//
-// The first item in this list that succeeds is the one whose documentation
-// is printed. If there is a symbol but no package, the package in the current
-// directory is chosen. However, if the argument begins with a capital
-// letter it is always assumed to be a symbol in the current directory.
-//
-// Two arguments:
-//
-//     go doc <pkg> <sym>[.<methodOrField>]
-//
-// Show the documentation for the package, symbol, and method or field. The
-// first argument must be a full package path. This is similar to the
-// command-line usage for the godoc command.
-//
-// For commands, unless the -cmd flag is present "go doc command"
-// shows only the package-level docs for the package.
-//
-// The -src flag causes doc to print the full source code for the symbol, such
-// as the body of a struct, function or method.
-//
-// The -all flag causes doc to print all documentation for the package and
-// all its visible symbols. The argument must identify a package.
-//
-// For complete documentation, run "go help doc".
-package main
-
-import (
-       "cmd/internal/doc"
-       "cmd/internal/telemetry/counter"
-       "os"
-)
-
-func main() {
-       counter.Open()
-       counter.Inc("doc/invocations")
-       doc.Main(os.Args[1:])
-}