diff --git a/.gitignore b/.gitignore index 2c3d2f4..50201cf 100644 --- a/.gitignore +++ b/.gitignore @@ -23,7 +23,7 @@ coverage/* !coverage/.gitkeep awl -doc/awl.1 -doc/awl.1.gz +docs/awl.1 +docs/awl.1.gz .dccache diff --git a/.gitmodules b/.gitmodules index 1b94379..e67eb67 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ -[submodule "doc/wiki"] - path = doc/wiki +[submodule "docs/wiki"] + path = docs/wiki url = ../awl.wiki diff --git a/.goreleaser.yaml b/.goreleaser.yaml index a466e68..c85de73 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -5,7 +5,7 @@ before: - make clean - go mod tidy # Make manpages - - doc/makeman.sh + - docs/makeman.sh # Vendor dependencies - go mod vendor @@ -21,7 +21,7 @@ archives: - files: - LICENSE - completions/** - - doc/awl.1.gz + - docs/awl.1.gz name_template: >- {{ .ProjectName }}_ {{- if eq .Os "darwin" }}MacOS_ @@ -88,7 +88,7 @@ brews: bash_completion.install "completions/bash.bash" => "awl" zsh_completion.install "completions/zsh.zsh" => "_awl" fish_completion.install "completions/fish.fish" => "awl.fish" - man1.install "doc/awl.1.gz" + man1.install "docs/awl.1.gz" scoops: - repository: @@ -108,7 +108,7 @@ nix: description: A DNS query client license: bsd3 extra_install: |- - installManPage ./doc/awl.1.gz + installManPage ./docs/awl.1.gz installShellCompletion ./completions/* nfpms: @@ -131,10 +131,10 @@ nfpms: contents: - src: completions/bash.bash dst: /usr/share/bash-completion/completions/awl - - src: doc/awl.1.gz + - src: docs/awl.1.gz dst: /usr/share/man/man1/awl.1.gz - src: LICENSE - dst: /usr/share/doc/awl/copyright + dst: /usr/share/docs/awl/copyright - src: completions/fish.fish dst: /usr/share/fish/vendor_completions.d/awl.fish # DEB only diff --git a/GNUmakefile b/GNUmakefile index 945bdb2..9674226 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -22,7 +22,7 @@ install: else install: all install -$(INSTALLFLAGS)m755 $(PROG) $(DESTDIR)$(PREFIX)/$(BIN)/$(PROG) - install -$(INSTALLFLAGS)m644 doc/$(PROG).1 $(DESTDIR)$(MAN)/man1/$(PROG).1 + install -$(INSTALLFLAGS)m644 docs/$(PROG).1 $(DESTDIR)$(MAN)/man1/$(PROG).1 # completions need to go in one specific place :) install -$(INSTALLFLAGS)m644 completions/bash.bash $(DESTDIR)$(PREFIX)/$(SHARE)/bash-completion/completions/$(PROG) install -$(INSTALLFLAGS)m644 completions/fish.fish $(DESTDIR)$(PREFIX)/$(SHARE)/fish/vendor_completions.d/$(PROG).fish diff --git a/Makefile b/Makefile index 49cc06f..00544b2 100644 --- a/Makefile +++ b/Makefile @@ -9,7 +9,7 @@ EXE := $(PROG) .PHONY: install install: all install -Dm755 $(PROG) $(DESTDIR)$(PREFIX)/$(BIN)/$(PROG) - install -Dm644 doc/$(PROG).1 $(DESTDIR)$(MAN)/man1/$(PROG).1 + install -Dm644 docs/$(PROG).1 $(DESTDIR)$(MAN)/man1/$(PROG).1 # completions need to go in one specific place :) install -Dm644 completions/bash.bash $(DESTDIR)$(PREFIX)$(SHARE)/bash-completion/completions/$(PROG) install -Dm644 completions/fish.fish $(DESTDIR)$(PREFIX)$(SHARE)/fish/vendor_completions.d/$(PROG).fish diff --git a/README.md b/README.md index f1c2504..9735979 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# awl +# awl > awl *(noun)*: A pointed tool for making small holes in wood or leather @@ -158,7 +158,7 @@ scoop install awl ## Contributing -Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more information. +Please see the [CONTRIBUTING.md](./docs/CONTRIBUTING.md) file for more information. TL;DR: If you like the project, spread the word! If you want to contribute, [use the issue tracker](https://git.froth.zone/sam/awl/issues) or [open a pull request](https://git.froth.zone/sam/awl/pulls). Want to use email instead? Use our [mailing list](https://lists.sr.ht/~sammefishe/awl-devel)! diff --git a/doc/makeman.sh b/doc/makeman.sh deleted file mode 100755 index fbaa55e..0000000 --- a/doc/makeman.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/sh - -set -e - -rm -f doc/awl.1.gz -scdoc doc/awl.1 -gzip -9 -n doc/awl.1 diff --git a/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to docs/CODE_OF_CONDUCT.md diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/doc/awl.1.scd b/docs/awl.1.scd similarity index 100% rename from doc/awl.1.scd rename to docs/awl.1.scd diff --git a/doc/img/awl-text.png b/docs/img/awl-text.png similarity index 100% rename from doc/img/awl-text.png rename to docs/img/awl-text.png diff --git a/doc/img/awl.svg b/docs/img/awl.svg similarity index 100% rename from doc/img/awl.svg rename to docs/img/awl.svg diff --git a/docs/makeman.sh b/docs/makeman.sh new file mode 100755 index 0000000..17556fd --- /dev/null +++ b/docs/makeman.sh @@ -0,0 +1,7 @@ +#!/bin/sh + +set -e + +rm -f docs/awl.1.gz +scdoc docs/awl.1 +gzip -9 -n docs/awl.1 diff --git a/doc/wiki b/docs/wiki similarity index 100% rename from doc/wiki rename to docs/wiki diff --git a/mkfile b/mkfile index 7e17b6c..547a489 100644 --- a/mkfile +++ b/mkfile @@ -17,7 +17,7 @@ $PROG: install:V: $GO install $GOFLAGS . - # cp doc/$PROG.1 /sys/man/1/$PROG + # cp docs/$PROG.1 /sys/man/1/$PROG test:V: $GO test -v -cover ./... diff --git a/pkg/query/struct.go b/pkg/query/struct.go index f4cb5eb..3ec7693 100644 --- a/pkg/query/struct.go +++ b/pkg/query/struct.go @@ -61,7 +61,7 @@ type Answer struct { // EDNS0 is for all EDNS options. // -// RFC: https://datatracker.ietf.org/doc/draft-peltan-edns-presentation-format/ +// RFC: https://datatracker.ietf.org/docs/draft-peltan-edns-presentation-format/ // //nolint:govet,tagliatelle type EDNS0 struct { diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml index d6c5360..1d5d281 100644 --- a/snap/snapcraft.yaml +++ b/snap/snapcraft.yaml @@ -8,7 +8,7 @@ license: BSD-3-Clause summary: A command-line DNS query tool. description: | awl is a command line DNS tool, much like dig and drill. -icon: doc/img/awl.svg +icon: docs/img/awl.svg issues: - https://git.froth.zone/sam/awl/issues - ~sammefishe/awl-devel@lists.sr.ht diff --git a/template.mk b/template.mk index cee2303..1828621 100644 --- a/template.mk +++ b/template.mk @@ -23,19 +23,19 @@ MAN ?= $(PREFIX)/$(SHARE)/man PROG ?= awl # hehe -all: $(PROG) doc/$(PROG).1 +all: $(PROG) docs/$(PROG).1 $(PROG): $(SOURCES) $(GO) build -o $(EXE) $(GOFLAGS) . -doc/$(PROG).1: doc/$(PROG).1.scd +docs/$(PROG).1: docs/$(PROG).1.scd $(SCDOC) <$? >$@ -doc/wiki/$(PROG).1.md: doc/$(PROG).1 +docs/wiki/$(PROG).1.md: docs/$(PROG).1 pandoc --from man --to gfm -o $@ $? ## update_doc: update documentation (requires pandoc) -update_doc: doc/wiki/$(PROG).1.md +update_doc: docs/wiki/$(PROG).1.md .PHONY: fmt fmt: @@ -87,7 +87,7 @@ cover: coverage/cover.html clean: $(GO) clean # Ignore errors if you remove something that doesn't exist - rm -f doc/$(PROG).1 + rm -f docs/$(PROG).1 rm -f coverage/cover* rm -rf vendor