aboutsummaryrefslogtreecommitdiff
path: root/protoc-gen-go/main.go
diff options
context:
space:
mode:
Diffstat (limited to 'protoc-gen-go/main.go')
-rw-r--r--protoc-gen-go/main.go25
1 files changed, 17 insertions, 8 deletions
diff --git a/protoc-gen-go/main.go b/protoc-gen-go/main.go
index 81f5087..8e2486d 100644
--- a/protoc-gen-go/main.go
+++ b/protoc-gen-go/main.go
@@ -29,14 +29,23 @@
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-/*
- A plugin for the Google protocol buffer compiler to generate Go code.
-
- This plugin takes no options and the protocol buffer file syntax does
- not yet define any options for Go, so program does no option evaluation.
- That may change.
-*/
-
+// protoc-gen-go is a plugin for the Google protocol buffer compiler to generate
+// Go code. Run it by building this program and putting it in your path with
+// the name
+// protoc-gen-go
+// That word 'go' at the end becomes part of the option string set for the
+// protocol compiler, so once the protocol compiler (protoc) is installed
+// you can run
+// protoc --go_out=output_directory input_directory/file.proto
+// to generate Go bindings for the protocol defined by file.proto.
+// With that input, the output will be written to
+// output_directory/file.pb.go
+//
+// The generated code is documented in the package comment for
+// the library.
+//
+// See the README and documentation for protocol buffers to learn more:
+// https://developers.google.com/protocol-buffers/
package main
import (