diff options
| author | Aki <please@ignore.pl> | 2024-02-11 00:31:45 +0100 |
|---|---|---|
| committer | Aki <please@ignore.pl> | 2024-02-11 00:32:35 +0100 |
| commit | 90be8407ccc34a0ee26ee25b1ff1384c393138c0 (patch) | |
| tree | e63571baaa4957ce86dd68dbe0738f1f616d6f85 | |
| parent | 94108525d08eaf3e6abb43df1dd7c5ac879a50e4 (diff) | |
| download | activity-90be8407ccc34a0ee26ee25b1ff1384c393138c0.zip activity-90be8407ccc34a0ee26ee25b1ff1384c393138c0.tar.gz activity-90be8407ccc34a0ee26ee25b1ff1384c393138c0.tar.bz2 | |
Added a manpage
| -rw-r--r-- | Makefile | 6 | ||||
| -rw-r--r-- | activity.1 | 44 | ||||
| -rwxr-xr-x | activity.lua (renamed from generate.lua) | 0 |
3 files changed, 49 insertions, 1 deletions
@@ -2,6 +2,8 @@ LUA_VERSION=5.4 PREFIX=/usr/local BINDIR=$(PREFIX)/bin DATADIR=$(PREFIX)/share +MANDIR=$(DATADIR)/man +MAN1DIR=$(MANDIR)/man1 LUA_LMOD=$(DATADIR)/lua/$(LUA_VERSION) all: @@ -10,11 +12,13 @@ all: install: install -m644 -Dt $(DESTDIR)$(LUA_LMOD)/activity activity/*.lua install -m644 -Dt $(DESTDIR)$(LUA_LMOD)/activity/formats activity/formats/*.lua - install -m755 -DT generate.lua $(DESTDIR)$(BINDIR)/activity + install -m755 -DT activity.lua $(DESTDIR)$(BINDIR)/activity + install -m644 -Dt $(DESTDIR)$(MAN1DIR) activity.1 uninstall: rm -rf $(DESTDIR)$(LUA_LMOD)/activity rm -f $(DESTIR)$(BINDIR)/activity + rm -f $(DESTIR)$(MAN1DIR)/activity.1 test: busted diff --git a/activity.1 b/activity.1 new file mode 100644 index 0000000..0ed1eb3 --- /dev/null +++ b/activity.1 @@ -0,0 +1,44 @@ +.TH activity 1 "2024-02-11" +.SH NAME +activity - generates a rolling or yearly activity chart for git repositories +.SH SYNOPSIS +.B activity +.RB [ \-y +.IR year ] +.RB [ \-f +.IR format ] +.RB [ \-A | \-C +.IR email ]... +.RI [ repositories ]... +.SH DESCRIPTION +Activity counts daily commits in selected repositories and creates a calendar year chart or up to last 53 weeks rolling +chart. Chart is a day-based heatmap, where the colour intensifies along the number of commits. +.P +Optionally, a filter can be applied to only count commits committed or authored by a person using selected e-mails. More +than one address can be provided and if any of them match, the commit will be included. +.SH EXIT STATUS +If no errors were encountered during chart generation, a +.B 0 +exit status is returned from the process. If an error occurred, a non-zero exit status is returned. Not all errors are +considered critical and in some cases an incomplete chart may be still generated. +.SH EXAMPLES +.SS Print rolling chart for the repository owning current working directory +.RS +.EX +$ activity +.EE +.RE +.SS Generate SVG chart for 2023 for all repositories in a list +.RS +.EX +$ xargs activity -y2023 -fsvg <repositories >activity.svh +.EE +.RE +.SS Generate HTML5 rolling chart filtered by matching either author or committer in all repositories in a list +.RS +.EX +$ xargs activity -Aplease@ignore.pl -Cplease@ignore.pl -fhtml5 <repositories >activity.html +.EE +.RE +.SH SEE ALSO +.BR git (1) diff --git a/generate.lua b/activity.lua index a97e79d..a97e79d 100755 --- a/generate.lua +++ b/activity.lua |