Do not use go generate to run md-to-godoc

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Uber Technologies, Inc.
+Copyright (c) 2017 Uber Technologies, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -37,6 +37,12 @@ test-and-lint: test fmt lint
 go-gen:
 	go generate $(PACKAGES)
 
+.PHONY: md-to-godoc-gen
+md-to-godoc-gen:
+	find . -name README.md -not -path "./vendor/*" -not -path "./_site/*" -not -path "./idl/*" \
+		| grep -v '^./README.md' \
+		| xargs -I% md-to-godoc -license -licenseFile LICENSE -input=%
+
 .PHONY: clean
 clean:
 	rm -rf cover.out cover.html lint.log fmt.log

README.md

@@ -28,4 +28,5 @@ See [CONTRIBUTING](./CONTRIBUTING.md).
 [ci]: https://travis-ci.org/uber/jaeger
 [cov-img]: https://coveralls.io/repos/uber/jaeger/badge.svg?branch=master
 [cov]: https://coveralls.io/github/uber/jaeger?branch=master
+[//]: # (md-to-godoc-ignore)
 

pkg/README.md

@@ -1,4 +1,4 @@
-`pkg/` is a collection of utility packages used by the Jaeger components without being specific to its internals.
+Collection of utility packages used by the Jaeger components without being specific to its internals.
 
 Utility packages are kept separate from the Jaeger core codebase to keep it as small and concise as possible. If some utilities grow larger and their APIs stabilize, they may be moved to their own repository, to facilitate re-use by other projects. However that is not the priority.
 

services/agent/md2doc.go → pkg/doc.go

@@ -1,3 +1,5 @@
+// The MIT License (MIT)
+//
 // Copyright (c) 2017 Uber Technologies, Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -18,9 +20,9 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-// This file only exists to generate doc.go from README.md
-
-//go:generate md-to-godoc
-//go:generate python ../../scripts/updateLicense.py doc.go
-
-package agent
+// Package pkg is the Collection of utility packages used by the Jaeger components without being specific to its internals.
+//
+// Utility packages are kept separate from the Jaeger core codebase to keep it as small and concise as possible. If some utilities grow larger and their APIs stabilize, they may be moved to their own repository, to facilitate re-use by other projects. However that is not the priority.
+//
+//
+package pkg

services/agent/README.md

@@ -1,5 +1,3 @@
 # `jaeger-agent` sidecar service
 
-Agent is meant to run on each host that runs the services instrumented with Jaeger.
-Jaeger client libraries send tracing spans to `jaeger-agent`. The agent
-forwards the spans to `jaeger-collector` services for storing in the DB.
+Agent is meant to run on each host that runs the services instrumented with Jaeger. Jaeger client libraries send tracing spans to `jaeger-agent`. The agent forwards the spans to `jaeger-collector` services for storing in the DB.

services/agent/doc.go

@@ -1,3 +1,5 @@
+// The MIT License (MIT)
+//
 // Copyright (c) 2017 Uber Technologies, Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -20,11 +22,7 @@
 
 // Package agent is the jaeger-agent sidecar service.
 //
-// Agent is meant to run on each host that runs the services instrumented with Jaeger.
-// Jaeger client libraries send tracing spans to
-// jaeger-agent. The agent
-// forwards the spans to
-// jaeger-collector services for storing in the DB.
+// Agent is meant to run on each host that runs the services instrumented with Jaeger. Jaeger client libraries send tracing spans to jaeger-agent. The agent forwards the spans to jaeger-collector services for storing in the DB.
 //
 //
 package agent