Merge pull request #41 from SuperSandro2000/makefile

Add Makefile

Author: fboender

Makefile

@@ -0,0 +1,25 @@
+SHELL := /bin/sh
+
+PREFIX ?= /usr/local
+
+.PHONY: all
+all: man
+
+mgitstatus.1: mgitstatus.1.md
+		pandoc ./$< -s -t man > $@
+
+.PHONY: man
+man: mgitstatus.1
+
+.PHONY: test
+test:
+		# SC1117 Backslash is literal in...
+		# SC2059 Don't use variables in the printf format string. But we need to or colors won't work
+		shellcheck -e SC1117,SC2059 mgitstatus
+
+.PHONY: install
+install:
+		install -d $(DESTDIR)$(PREFIX)/bin
+		install -d $(DESTDIR)$(PREFIX)/man/man1
+		install mgitstatus -m 755 $(DESTDIR)$(PREFIX)/bin/
+		install mgitstatus.1 $(DESTDIR)$(PREFIX)/man/man1/

README.md

@@ -71,7 +71,7 @@ For more examples, see the [manual page](mgitstatus.1.md).
 
 # Installation
 
-mgitstatus requires a POSIX compliant shell. Bash will do fine.
+mgitstatus requires make.
 
 The following steps will install mgitstatus:
 
@@ -80,10 +80,10 @@ The following steps will install mgitstatus:
     $ cd multi-git-status
 
     # Install globally (all users)
-    $ sudo ./install.sh
+    $ sudo make install
 
     # Install locally (only your user)
-    $ PREFIX=~/.local ./install.sh
+    $ PREFIX=~/.local make install
 
 # License
 

build.sla

@@ -1,156 +1,132 @@
-.\" Automatically generated by Pandoc 1.19.2.4
+.\" Automatically generated by Pandoc 2.5
 .\"
 .TH "MGITSTATUS" "1" "Jul 2019" "" ""
 .hy
 .SH NAME
 .PP
-mgitstatus \[en] Show uncommitted, untracked and unpushed changes for
+mgitstatus \- Show uncommitted, untracked and unpushed changes for
 multiple Git repos.
 .SH SYNOPSIS
 .PP
-\f[B]mgitstatus\f[] [\f[B]\-\-version\f[]] [\f[B]\-w\f[]] [\f[B]\-e\f[]]
-[\f[B]\-f\f[]] [\f[B]\-\-no\-X\f[]] [\f[B]\-d/\-\-depth\f[]=2]
-[\f[B]DIR\f[] [\f[B]DIR\f[]]...]
+\f[B]mgitstatus\f[R] [\f[B]\-\-version\f[R]] [\f[B]\-w\f[R]]
+[\f[B]\-e\f[R]] [\f[B]\-f\f[R]] [\f[B]\-\-no\-X\f[R]]
+[\f[B]\-d/\-\-depth\f[R]=2] [\f[B]DIR\f[R] [\f[B]DIR\f[R]]\&...]
 .SH DESCRIPTION
 .PP
-\f[B]mgitstatus\f[] shows uncommited, untracked and unpushed changes in
-multiple Git repositories.
-By default, \f[B]mgitstatus\f[] scans two directories deep.
-This can be changed with the \f[C]\-d\f[] (\f[C]\-\-depth\f[]) option.
-If \f[B]DEPTH\f[] is 0, the scan is infinitely deep.
+\f[B]mgitstatus\f[R] shows uncommitted, untracked and unpushed changes
+in multiple Git repositories.
+By default, \f[B]mgitstatus\f[R] scans two directories deep.
+This can be changed with the \f[C]\-d\f[R] (\f[C]\-\-depth\f[R]) option.
+If \f[B]DEPTH\f[R] is 0, the scan is infinitely deep.
 .PP
 mgitstatus shows:
 .IP \[bu] 2
-\f[B]Uncommitted changes\f[] if there are unstaged or uncommitted
+\f[B]Uncommitted changes\f[R] if there are unstaged or uncommitted
 changes on the checked out branch.
 .IP \[bu] 2
-\f[B]Untracked files\f[] if there are untracked files which are not
+\f[B]Untracked files\f[R] if there are untracked files which are not
 ignored.
 .IP \[bu] 2
-\f[B]Needs push (BRANCH)\f[] if the branch is tracking a (remote) branch
-which is behind.
+\f[B]Needs push (BRANCH)\f[R] if the branch is tracking a (remote)
+branch which is behind.
 .IP \[bu] 2
-\f[B]Needs upstream (BRANCH)\f[] if a branch does not have a local or
+\f[B]Needs upstream (BRANCH)\f[R] if a branch does not have a local or
 remote upstream branch configured.
 Changes in the branch may otherwise never be pushed or merged.
 .IP \[bu] 2
-\f[B]Needs pull (BRANCH)\f[] if the branch is tracking a (remote) branch
-which is ahead.
+\f[B]Needs pull (BRANCH)\f[R] if the branch is tracking a (remote)
+branch which is ahead.
 This requires that the local git repo already knows about the remote
-changes (i.e.
-you\[aq]ve done a fetch), or that you specify the \-f option.
+changes (i.e.\ you\[cq]ve done a fetch), or that you specify the \-f
+option.
 mgitstatus does NOT contact the remote by default.
 .IP \[bu] 2
-\f[B]X stashes\f[] if there are stashes.
+\f[B]X stashes\f[R] if there are stashes.
 .PP
 Since there are a lot of different states a git repository can be in,
 mgitstatus makes no guarantees that all states are taken into account.
 .SH OPTIONS
 .TP
-.B \f[B]\-\-version\f[]
+.B \f[B]\-\-version\f[R]
 Show version
-.RS
-.RE
 .TP
-.B \f[B]\-w\f[]
+.B \f[B]\-w\f[R]
 Warn about dirs that are not Git repositories
-.RS
-.RE
 .TP
-.B \f[B]\-e\f[]
-Exclude repos that are \[aq]ok\[aq]
-.RS
-.RE
+.B \f[B]\-e\f[R]
+Exclude repos that are `ok'
 .TP
-.B \f[B]\-f\f[]
-Do a \[aq]git fetch\[aq] on each repo (slow for many repos)
-.RS
-.RE
+.B \f[B]\-f\f[R]
+Do a `git fetch' on each repo (slow for many repos)
 .TP
-.B \f[B]\-c\f[]
+.B \f[B]\-c\f[R]
 Force color output (preserve colors when using pipes)
-.RS
-.RE
 .TP
-.B \f[B]\-d, \-\-depth=2\f[]
+.B \f[B]\-d, \-\-depth=2\f[R]
 Scan this many directories deep.
 Default is 2.
-If \f[B]0\f[], the scan is infinitely deep
-.RS
-.RE
+If \f[B]0\f[R], the scan is infinitely deep
 .PP
 You can limit output with the following options:
 .TP
-.B \f[B]\-\-no\-push\f[]
+.B \f[B]\-\-no\-push\f[R]
 Do not show branches that need a push.
-.RS
-.RE
 .TP
-.B \f[B]\-\-no\-pull\f[]
+.B \f[B]\-\-no\-pull\f[R]
 Do not show branches that need a pull.
-.RS
-.RE
 .TP
-.B \f[B]\-\-no\-upstream\f[]
+.B \f[B]\-\-no\-upstream\f[R]
 Do not show branches that need an upstream.
-.RS
-.RE
 .TP
-.B \f[B]\-\-no\-uncommited\f[]
+.B \f[B]\-\-no\-uncommitted\f[R]
 Do not show branches that have unstaged or uncommitted changes.
-.RS
-.RE
 .TP
-.B \f[B]\-\-no\-untracked\f[]
+.B \f[B]\-\-no\-untracked\f[R]
 Do not show branches that have untracked files.
-.RS
-.RE
 .TP
-.B \f[B]\-\-no\-stashes\f[]
+.B \f[B]\-\-no\-stashes\f[R]
 Do now show stashes
-.RS
-.RE
 .SH EXAMPLES
 .PP
 The following command scans two directories deep for Git projects and
 shows their status:
 .IP
 .nf
 \f[C]
-$\ mgitstatus\ 
-\&./fboender/sla:\ ok\ 
-\&./fboender/multi\-git\-status:\ Needs\ push\ (master)\ Untracked\ files
-\&./other/peewee:\ ok\ 
-\f[]
+$ mgitstatus
+\&./fboender/sla: ok
+\&./fboender/multi\-git\-status: Needs push (master) Untracked files
+\&./other/peewee: ok
+\f[R]
 .fi
 .PP
 To scan deeper (three dirs instead of two) in the current dir:
 .IP
 .nf
 \f[C]
-$\ mgitstatus\ \-d\ 3
-\f[]
+$ mgitstatus \-d 3
+\f[R]
 .fi
 .PP
-The following command scans three levels deep in \f[C]/opt/deploy/\f[]
-and hides repos that are \[aq]ok\[aq].
+The following command scans three levels deep in \f[C]/opt/deploy/\f[R]
+and hides repos that are `ok'.
 It does not show stashes:
 .IP
 .nf
 \f[C]
-$\ mgitstatus\ \-e\ \-\-no\-stashes\ \-d\ 3\ /opt/deploy
-\f[]
+$ mgitstatus \-e \-\-no\-stashes \-d 3 /opt/deploy
+\f[R]
 .fi
 .PP
-To ignore a repo, set the \f[C]mgitstatus.ignore\f[] git configuration
-option for that repo to \f[C]true\f[].
+To ignore a repo, set the \f[C]mgitstatus.ignore\f[R] git configuration
+option for that repo to \f[C]true\f[R].
 E.g.:
 .IP
 .nf
 \f[C]
-$\ cd\ stupidrepo
-$\ git\ config\ \-\-local\ mgitstatus.ignore\ true
-\f[]
+$ cd stupidrepo
+$ git config \-\-local mgitstatus.ignore true
+\f[R]
 .fi
 .SH COPYRIGHT
 .PP

install.sh

@@ -87,10 +87,10 @@ You can limit output with the following options:
 The following command scans two directories deep for Git projects and shows
 their status:
 
-    $ mgitstatus 
-    ./fboender/sla: ok 
+    $ mgitstatus
+    ./fboender/sla: ok
     ./fboender/multi-git-status: Needs push (master) Untracked files
-    ./other/peewee: ok 
+    ./other/peewee: ok
 
 To scan deeper (three dirs instead of two) in the current dir: