aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2020-06-14 21:52:11 +0200
committerMichael Muré <batolettre@gmail.com>2020-06-14 22:26:47 +0200
commit6352d6aa2338f47cd8b60631dec5f4161d9d92ec (patch)
treeaac41ac96197ddcd33453ea4ab89e36e891d69a7 /doc
parent78f39c40778b31de63710cc022ff491c2e4586a7 (diff)
downloadgit-bug-6352d6aa2338f47cd8b60631dec5f4161d9d92ec.tar.gz
generate docs and completion concurrently for a faster "make"
Diffstat (limited to 'doc')
-rw-r--r--doc/gen_docs.go83
-rw-r--r--doc/gen_manpage.go46
-rw-r--r--doc/gen_markdown.go36
3 files changed, 83 insertions, 82 deletions
diff --git a/doc/gen_docs.go b/doc/gen_docs.go
new file mode 100644
index 00000000..31960b65
--- /dev/null
+++ b/doc/gen_docs.go
@@ -0,0 +1,83 @@
+package main
+
+import (
+ "fmt"
+ "os"
+ "path"
+ "path/filepath"
+ "time"
+
+ "github.com/spf13/cobra/doc"
+
+ "github.com/MichaelMure/git-bug/commands"
+)
+
+func main() {
+ fmt.Println("Generating documentation ...")
+
+ tasks := map[string]func() error{
+ "ManPage": genManPage,
+ "Markdown": genMarkdown,
+ }
+
+ // Due to concurrency issues in cobra, the following can't be concurrent :(
+
+ // var wg sync.WaitGroup
+ for name, f := range tasks {
+ // wg.Add(1)
+ // go func(name string, f func() error) {
+ // defer wg.Done()
+ err := f()
+ if err != nil {
+ fmt.Printf(" - %s: %v\n", name, err)
+ return
+ }
+ fmt.Printf(" - %s: ok\n", name)
+ // }(name, f)
+ }
+
+ // wg.Wait()
+}
+
+func genManPage() error {
+ cwd, _ := os.Getwd()
+ dir := path.Join(cwd, "doc", "man")
+
+ date := time.Date(2019, 4, 1, 12, 0, 0, 0, time.UTC)
+
+ header := &doc.GenManHeader{
+ Title: "GIT-BUG",
+ Section: "1",
+ Date: &date,
+ Source: "Generated from git-bug's source code",
+ }
+
+ files, err := filepath.Glob(dir + "/*.1")
+ if err != nil {
+ return err
+ }
+ for _, f := range files {
+ if err := os.Remove(f); err != nil {
+ return err
+ }
+ }
+
+ return doc.GenManTree(commands.RootCmd, header, dir)
+}
+
+func genMarkdown() error {
+ cwd, _ := os.Getwd()
+ dir := path.Join(cwd, "doc", "md")
+
+ files, err := filepath.Glob(dir + "/*.md")
+ if err != nil {
+ return err
+ }
+ for _, f := range files {
+ if err := os.Remove(f); err != nil {
+ return err
+ }
+ }
+
+ return doc.GenMarkdownTree(commands.RootCmd, dir)
+}
diff --git a/doc/gen_manpage.go b/doc/gen_manpage.go
deleted file mode 100644
index eef0ff66..00000000
--- a/doc/gen_manpage.go
+++ /dev/null
@@ -1,46 +0,0 @@
-// +build ignore
-
-package main
-
-import (
- "fmt"
- "log"
- "os"
- "path"
- "path/filepath"
- "time"
-
- "github.com/MichaelMure/git-bug/commands"
- "github.com/spf13/cobra/doc"
-)
-
-func main() {
- cwd, _ := os.Getwd()
- dir := path.Join(cwd, "doc", "man")
-
- date := time.Date(2019, 4, 1, 12, 0, 0, 0, time.UTC)
-
- header := &doc.GenManHeader{
- Title: "GIT-BUG",
- Section: "1",
- Date: &date,
- Source: "Generated from git-bug's source code",
- }
-
- fmt.Println("Generating manpage ...")
-
- files, err := filepath.Glob(dir + "/*.1")
- if err != nil {
- log.Fatal(err)
- }
- for _, f := range files {
- if err := os.Remove(f); err != nil {
- log.Fatal(err)
- }
- }
-
- err = doc.GenManTree(commands.RootCmd, header, dir)
- if err != nil {
- log.Fatal(err)
- }
-}
diff --git a/doc/gen_markdown.go b/doc/gen_markdown.go
deleted file mode 100644
index 47194666..00000000
--- a/doc/gen_markdown.go
+++ /dev/null
@@ -1,36 +0,0 @@
-// +build ignore
-
-package main
-
-import (
- "fmt"
- "log"
- "os"
- "path"
- "path/filepath"
-
- "github.com/MichaelMure/git-bug/commands"
- "github.com/spf13/cobra/doc"
-)
-
-func main() {
- cwd, _ := os.Getwd()
- dir := path.Join(cwd, "doc", "md")
-
- fmt.Println("Generating Markdown documentation ...")
-
- files, err := filepath.Glob(dir + "/*.md")
- if err != nil {
- log.Fatal(err)
- }
- for _, f := range files {
- if err := os.Remove(f); err != nil {
- log.Fatal(err)
- }
- }
-
- err = doc.GenMarkdownTree(commands.RootCmd, dir)
- if err != nil {
- log.Fatal(err)
- }
-}