From 09a1d8991ce770a55aad05f2c4131a917ded1cb6 Mon Sep 17 00:00:00 2001 From: Matt Hunter Date: Sun, 24 May 2026 20:33:33 -0400 Subject: Update core documentation as git-sonar manpage The bulk of README.md is reworked, updated for accuracy, and reformatted into git-sonar(1). The output of 'git-sonar --help' is removed as well (melded into the new manpage). Now, specifying --help causes the manpage itself to open. Since 'git-sonar --help' used to be the only way to ask which version of the script is installed, a --version output is added as a terse replacement. The makefile is updated to facilitate installation of this new documentation. Signed-off-by: Matt Hunter --- Makefile | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 6edd7f4..de4ba58 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,5 @@ SOURCE=git-sonar git-precheck +MANPAGES=git-sonar.1 PREFIX?=/usr/local PWD=$(shell pwd) @@ -16,13 +17,14 @@ all: @echo 'If you want to install *git-sonar* for your user only:' @echo ' PREFIX=$$HOME/.local make install' -install: $(SOURCE) - @echo 'Installing in' $(PREFIX)/bin '...' - mkdir -p $(PREFIX)/bin +install: + @echo 'Installing in' $(PREFIX) '...' + mkdir -p $(PREFIX)/bin $(PREFIX)/share/man/man1 install -m 755 $(SOURCE) $(PREFIX)/bin + install -m 644 $(MANPAGES) $(PREFIX)/share/man/man1 -# Link each file separately since the full PWD is needed -develop: $(SOURCE) +develop: + # Link each file separately since the full PWD is needed @echo 'Symlinking in' $(PREFIX)/bin '...' mkdir -p $(PREFIX)/bin ln -sf $(PWD)/git-sonar $(PREFIX)/bin -- cgit v1.2.3 From 2a1fa5ff11b9b3137a402ede0cd47a2754c9facf Mon Sep 17 00:00:00 2001 From: Matt Hunter Date: Mon, 25 May 2026 22:42:02 -0400 Subject: precheck: Add documentation in new manpage Adds git-precheck(1) as the primary documentation for git-precheck. Like with git-sonar, the previous 'git-precheck --help' text is incorporated, and specifying --help now causes the new manpage to open. Signed-off-by: Matt Hunter --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index de4ba58..e29e455 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ SOURCE=git-sonar git-precheck -MANPAGES=git-sonar.1 +MANPAGES=git-sonar.1 git-precheck.1 PREFIX?=/usr/local PWD=$(shell pwd) -- cgit v1.2.3