Merge pull request #125 from brownleej/go-doc-build-removal

Removes the steps to build godoc from our Makefile
apple · Apr 13, 2018 · 7bd9324 · 7bd9324
2 parents 0d03087 + 89088ad
commit 7bd9324
Show file tree

Hide file tree

Showing 9 changed files with 556 additions and 49 deletions.
diff --git a/.gitignore b/.gitignore
@@ -14,7 +14,6 @@ packaging/msi/FDBInstaller.msi
 *.g.S
 *.g.asm
 *.pom
-bindings/go/src/fdb/generated.go
 bindings/java/pom*.xml
 bindings/java/src*/main/overview.html
 bindings/java/src*/main/com/apple/foundationdb/*Options.java

diff --git a/Makefile b/Makefile
@@ -174,13 +174,13 @@ lib/libstdc++.a: $(shell $(CC) -print-file-name=libstdc++_pic.a)
 	@ar rcs $@ .libstdc++/*.o
 	@rm -r .libstdc++
 
-docpreview: javadoc godoc
+docpreview: javadoc
 	TARGETS= $(MAKE) -C documentation docpreview
 
 docpreview_clean:
 	CLEAN_TARGETS= $(MAKE) -C documentation docpreview_clean
 
-packages/foundationdb-docs-$(VERSION).tar.gz: FORCE javadoc godoc
+packages/foundationdb-docs-$(VERSION).tar.gz: FORCE javadoc
 	TARGETS= $(MAKE) -C documentation docpackage
 	@mkdir -p packages
 	@rm -f packages/foundationdb-docs-$(VERSION).tar.gz

diff --git a/bindings/go/README.md b/bindings/go/README.md
@@ -27,5 +27,5 @@ of downloading from the remote repository.
 Documentation
 -------------
 
-* [API documentation](https://www.foundationdb.org/documentation/godoc/fdb.html)
+* [API documentation](https://godoc.org/github.com/apple/foundationdb/bindings/go/src/fdb)
 * [Tutorial](https://www.foundationdb.org/documentation/class-scheduling-go.html)
diff --git a/bindings/go/include.mk b/bindings/go/include.mk
@@ -25,7 +25,7 @@ GOPATH := $(CURDIR)/bindings/go/build
 GO_IMPORT_PATH := github.com/apple/foundationdb/bindings/go/src
 GO_DEST := $(GOPATH)/src/$(GO_IMPORT_PATH)
 
-.PHONY: fdb_go fdb_go_path fdb_go_fmt fdb_go_fmt_check fdb_go_tester fdb_go_tester_clean godoc godoc_clean
+.PHONY: fdb_go fdb_go_path fdb_go_fmt fdb_go_fmt_check fdb_go_tester fdb_go_tester_clean
 
 # We only override if the environment didn't set it (this is used by
 # the fdbwebsite documentation build process)
@@ -47,7 +47,8 @@ GO_PACKAGE_OUTDIR := $(GOPATH)/pkg/$(GOPLATFORM)/$(GO_IMPORT_PATH)
 GO_PACKAGES := fdb fdb/tuple fdb/subspace fdb/directory
 GO_PACKAGE_OBJECTS := $(addprefix $(GO_PACKAGE_OUTDIR)/,$(GO_PACKAGES:=.a))
 
-GO_SRC := $(shell find $(CURDIR)/bindings/go/src -name '*.go')
+GO_GEN := $(CURDIR)/bindings/go/src/fdb/generated.go
+GO_SRC := $(shell find $(CURDIR)/bindings/go/src -name '*.go') $(GO_GEN)
 
 fdb_go: $(GO_PACKAGE_OBJECTS) $(GO_SRC) fdb_go_fmt_check
 
@@ -77,53 +78,26 @@ fdb_go_tester_clean:
 	@echo "Cleaning       fdb_go_tester"
 	@rm -rf $(GOPATH)/bin
 
-$(GOPATH)/bin/_stacktester: $(GO_DEST)/.stamp $(GO_SRC) $(GO_PACKAGE_OBJECTS) $(GO_DEST)/fdb/generated.go
+$(GOPATH)/bin/_stacktester: $(GO_DEST)/.stamp $(GO_SRC) $(GO_PACKAGE_OBJECTS)
 	@echo "Compiling      $(basename $(notdir $@))"
 	@go install $(GO_IMPORT_PATH)/_stacktester
 
-$(GO_PACKAGE_OUTDIR)/fdb/tuple.a: $(GO_DEST)/.stamp $(GO_SRC) $(GO_PACKAGE_OUTDIR)/fdb.a $(GO_DEST)/fdb/generated.go
+$(GO_PACKAGE_OUTDIR)/fdb/tuple.a: $(GO_DEST)/.stamp $(GO_SRC) $(GO_PACKAGE_OUTDIR)/fdb.a
 	@echo "Compiling      fdb/tuple"
 	@go install $(GO_IMPORT_PATH)/fdb/tuple
 
-$(GO_PACKAGE_OUTDIR)/fdb/subspace.a: $(GO_DEST)/.stamp $(GO_SRC) $(GO_PACKAGE_OUTDIR)/fdb.a $(GO_PACKAGE_OUTDIR)/fdb/tuple.a $(GO_DEST)/fdb/generated.go
+$(GO_PACKAGE_OUTDIR)/fdb/subspace.a: $(GO_DEST)/.stamp $(GO_SRC) $(GO_PACKAGE_OUTDIR)/fdb.a $(GO_PACKAGE_OUTDIR)/fdb/tuple.a
 	@echo "Compiling      fdb/subspace"
 	@go install $(GO_IMPORT_PATH)/fdb/subspace
 
-$(GO_PACKAGE_OUTDIR)/fdb/directory.a: $(GO_DEST)/.stamp $(GO_SRC) $(GO_PACKAGE_OUTDIR)/fdb.a $(GO_PACKAGE_OUTDIR)/fdb/tuple.a $(GO_PACKAGE_OUTDIR)/fdb/subspace.a $(GO_DEST)/fdb/generated.go
+$(GO_PACKAGE_OUTDIR)/fdb/directory.a: $(GO_DEST)/.stamp $(GO_SRC) $(GO_PACKAGE_OUTDIR)/fdb.a $(GO_PACKAGE_OUTDIR)/fdb/tuple.a $(GO_PACKAGE_OUTDIR)/fdb/subspace.a
 	@echo "Compiling      fdb/directory"
 	@go install $(GO_IMPORT_PATH)/fdb/directory
 
-$(GO_PACKAGE_OUTDIR)/fdb.a: $(GO_DEST)/.stamp lib/libfdb_c.$(DLEXT) $(GO_SRC) $(GO_DEST)/fdb/generated.go
+$(GO_PACKAGE_OUTDIR)/fdb.a: $(GO_DEST)/.stamp lib/libfdb_c.$(DLEXT) $(GO_SRC)
 	@echo "Compiling      fdb"
 	@go install $(GO_IMPORT_PATH)/fdb
 
-$(GO_DEST)/fdb/generated.go: $(GO_DEST)/.stamp bindings/go/src/_util/translate_fdb_options.go fdbclient/vexillographer/fdb.options
+$(GO_GEN): bindings/go/src/_util/translate_fdb_options.go fdbclient/vexillographer/fdb.options
 	@echo "Building       $@"
 	@go run bindings/go/src/_util/translate_fdb_options.go < fdbclient/vexillographer/fdb.options > $@
-
-godoc: fdb_go_path $(GO_SRC) $(GO_DEST)/fdb/generated.go
-	@echo "Generating Go Documentation"
-	@rm -rf $(GODOC_DIR)/godoc
-	@mkdir -p $(GODOC_DIR)/godoc
-	@mkdir -p $(GODOC_DIR)/godoc/lib/godoc
-	@godoc -url "pkg/$(GO_IMPORT_PATH)/fdb" > $(GODOC_DIR)/godoc/fdb.html
-	@godoc -url "pkg/$(GO_IMPORT_PATH)/fdb/tuple" > $(GODOC_DIR)/godoc/fdb.tuple.html
-	@godoc -url "pkg/$(GO_IMPORT_PATH)/fdb/subspace" > $(GODOC_DIR)/godoc/fdb.subspace.html
-	@godoc -url "pkg/$(GO_IMPORT_PATH)/fdb/directory" > $(GODOC_DIR)/godoc/fdb.directory.html
-	@cp $(CURDIR)/bindings/go/godoc-resources/* $(GODOC_DIR)/godoc/lib/godoc
-	@echo "Mangling paths in Go Documentation"
-	@(find $(GODOC_DIR)/godoc/ -name *.html -exec sed -i '' -e 's_/lib_lib_' {} \;)
-	@(sed -i -e 's_a href="tuple/"_a href="fdb.tuple.html"_' $(GODOC_DIR)/godoc/fdb.html)
-	@(sed -i -e 's_a href="subspace/"_a href="fdb.subspace.html"_' $(GODOC_DIR)/godoc/fdb.html)
-	@(sed -i -e 's_a href="directory/"_a href="fdb.directory.html"_' $(GODOC_DIR)/godoc/fdb.html)
-
-	@(sed -i -e 's_a href="/pkg/builtin_a href="https://godoc.org/pkg/builtin_g;s_a href="/src/github.com/apple/foundationdb_a href="https://github.com/apple/foundationdb/tree/master_g;s_a href="/pkg/github.com/apple/foundationdb/bindings/go/src/fdb/_a href="./fdb.html_g' $(GODOC_DIR)/godoc/fdb.html)
-	@(sed -i -e 's_a href="/pkg/builtin_a href="https://godoc.org/pkg/builtin_g;s_a href="/src/github.com/apple/foundationdb_a href="https://github.com/apple/foundationdb/tree/master_g;s_a href="/pkg/github.com/apple/foundationdb/bindings/go/src/fdb/_a href="./fdb.html_g' $(GODOC_DIR)/godoc/fdb.directory.html)
-	@(sed -i -e 's_a href="/pkg/builtin_a href="https://godoc.org/pkg/builtin_g;s_a href="/src/github.com/apple/foundationdb_a href="https://github.com/apple/foundationdb/tree/master_g;s_a href="/pkg/github.com/apple/foundationdb/bindings/go/src/fdb/_a href="./fdb.html_g' $(GODOC_DIR)/godoc/fdb.subspace.html)
-	@(sed -i -e 's_a href="/pkg/builtin_a href="https://godoc.org/pkg/builtin_g;s_a href="/src/github.com/apple/foundationdb_a href="https://github.com/apple/foundationdb/tree/master_g;s_a href="/pkg/github.com/apple/foundationdb/bindings/go/src/fdb/_a href="./fdb.html_g' $(GODOC_DIR)/godoc/fdb.tuple.html)
-
-
-godoc_clean:
-	@echo "Cleaning Go Documentation"
-	@rm -rf $(GODOC_DIR)/godoc
-
diff --git a/bindings/go/src/_util/translate_fdb_options.go b/bindings/go/src/_util/translate_fdb_options.go
@@ -136,7 +136,7 @@ func (t Transaction) %s(key KeyConvertible, param []byte) {
 func writeEnum(scope Scope, opt Option, delta int) {
 	fmt.Println()
 	if opt.Description != "" {
-		doc.ToText(os.Stdout, opt.Description, "    // ", "", 73)
+		doc.ToText(os.Stdout, opt.Description, "\t// ", "", 73)
 		// fmt.Printf("	// %s\n", opt.Description)
 	}
 	fmt.Printf("	%s %s = %d\n", scope.Name+translateName(opt.Name), scope.Name, opt.Code+delta)
@@ -157,14 +157,34 @@ func main() {
 		log.Fatal(err)
 	}
 
-	fmt.Print(`// DO NOT EDIT THIS FILE BY HAND. This file was generated using
-// translate_fdb_options.go, part of the fdb-go repository, and a copy of the
-// fdb.options file (installed as part of the FoundationDB client, typically
+	fmt.Print(`/*
+ * generated.go
+ *
+ * This source file is part of the FoundationDB open source project
+ *
+ * Copyright 2013-2018 Apple Inc. and the FoundationDB project authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// DO NOT EDIT THIS FILE BY HAND. This file was generated using
+// translate_fdb_options.go, part of the FoundationDB repository, and a copy of
+// the fdb.options file (installed as part of the FoundationDB client, typically
 // found as /usr/include/foundationdb/fdb.options).
 
-// To regenerate this file, from the top level of an fdb-go repository checkout,
-// run:
-// $ go run _util/translate_fdb_options.go < /usr/include/foundationdb/fdb.options > fdb/generated.go
+// To regenerate this file, from the top level of a FoundationDB repository
+// checkout, run:
+// $ go run bindings/go/src/_util/translate_fdb_options.go < fdbclient/vexillographer/fdb.options > bindings/go/src/fdb/generated.go
 
 package fdb
 
@@ -216,6 +236,7 @@ func int64ToBytes(i int64) ([]byte, error) {
 
 		fmt.Printf(`
 type %s int
+
 const (
 `, scope.Name)
 		for _, opt := range scope.Option {