This thread contains a patchset. You're looking at the original emails,
but you may wish to use the patch review UI.
Review patch
4
2
[PATCH mdtohtml] restructure docs
---
.gitignore | 2 + -
Makefile | 8 +++++ ---
mdtohtml.1.scd => docs/mdtohtml.1.scd | 0
3 files changed, 6 insertions(+), 4 deletions(-)
rename mdtohtml.1.scd => docs/mdtohtml.1.scd (100%)
diff --git a/.gitignore b/.gitignore
index 879797a..88b2533 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,2 @@
mdtohtml
- mdtohtml.1
+ docs/mdtohtml.1
diff --git a/Makefile b/Makefile
index 61524e8..9e46607 100644
--- a/Makefile
+++ b/Makefile
@@ -14,8 +14,10 @@ all: mdtohtml mdtohtml.1
mdtohtml: main.go go.mod go.sum
$(GO) build $(GOFLAGS) -o $@
- mdtohtml.1: mdtohtml.1.scd
- scdoc < mdtohtml.1.scd > $@
+ docs: docs/mdtohtml.1
+
+ docs/mdtohtml.1: docs/mdtohtml.1.scd
+ scdoc < docs/mdtohtml.1.scd > $@
clean:
$(RM) mdtohtml
@@ -30,4 +32,4 @@ uninstall:
$(RM) $(DESTDIR)$(BINDIR)/mdtohtml
$(RM) $(DESTDIR)$(MANDIR)/man1/mdtohtml.1
- .PHONY: all clean install uninstall
+ .PHONY: all docs clean install uninstall
diff --git a/mdtohtml.1.scd b/docs/mdtohtml.1.scd
similarity index 100%
rename from mdtohtml.1.scd
rename to docs/mdtohtml.1.scd
--
2.38.0
What's the motivation for this?
> What's the motivation for this?
It's simply to bring the structure of the doc source and Makefile into
closer alignment with the main kiln project's structure. Similar changes
were in a previous patch I submitted[1], and I've factored them out.
If you consider this is just unnecessarily adding noise to the project,
feel free to reject the patch.
[1]: https://lists.sr.ht/~adnano/kiln-devel/patches/35784
If we're going to do this, we should do it for all repositories. Could
you send a similar patch for gmnitohtml as well?
On Tue Oct 4, 2022 at 10:17 AM EDT, Edd Salkield wrote:
> ---
> .gitignore | 2 +-
> Makefile | 8 +++++---
> mdtohtml.1.scd => docs/mdtohtml.1.scd | 0
> 3 files changed, 6 insertions(+), 4 deletions(-)
> rename mdtohtml.1.scd => docs/mdtohtml.1.scd (100%)
>
> diff --git a/.gitignore b/.gitignore
> index 879797a..88b2533 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -1,2 +1,2 @@
> mdtohtml
> -mdtohtml.1
> +docs/mdtohtml.1
> diff --git a/Makefile b/Makefile
> index 61524e8..9e46607 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -14,8 +14,10 @@ all: mdtohtml mdtohtml.1
> mdtohtml: main.go go.mod go.sum
> $(GO) build $(GOFLAGS) -o $@
>
> -mdtohtml.1: mdtohtml.1.scd
> - scdoc < mdtohtml.1.scd > $@
> +docs: docs/mdtohtml.1
The 'all' target needs to be updated as well. It still refers to
the old target.
> +
> +docs/mdtohtml.1: docs/mdtohtml.1.scd
> + scdoc < docs/mdtohtml.1.scd > $@
>
> clean:
> $(RM) mdtohtml
> @@ -30,4 +32,4 @@ uninstall:
> $(RM) $(DESTDIR)$(BINDIR)/mdtohtml
> $(RM) $(DESTDIR)$(MANDIR)/man1/mdtohtml.1
>
> -.PHONY: all clean install uninstall
> +.PHONY: all docs clean install uninstall
> diff --git a/mdtohtml.1.scd b/docs/mdtohtml.1.scd
> similarity index 100%
> rename from mdtohtml.1.scd
> rename to docs/mdtohtml.1.scd
> --
> 2.38.0
> If we're going to do this, we should do it for all repositories. Could
> you send a similar patch for gmnitohtml as well?
Sure
> The 'all' target needs to be updated as well. It still refers to
> the old target.
Good catch, fixed in the latest patch:
https://lists.sr.ht/~adnano/kiln-devel/patches/35844