Skip to content

Commit

Permalink
Documentation commit.
Browse files Browse the repository at this point in the history
Broke-up the README; most of its content went into a new
user manual in Texinfo format. The process of documenting
filter quoting exposed multiple bugs-- fixed.
  • Loading branch information
sp1ff committed Mar 29, 2021
1 parent 0cb0093 commit 4507370
Show file tree
Hide file tree
Showing 18 changed files with 1,834 additions and 271 deletions.
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ on:
push:
branches:
- master
- filters
schedule:
- cron: '00 01 * * *'
jobs:
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,8 @@ jobs:
mkdir -p "$staging"/{bin,doc}
cp -v {README.org,AUTHORS,ChangeLog,COPYING,NEWS,THANKS} "$staging/doc/"
cp -v mpdpopm/mppopmd.{conf,service} "$staging/doc/"
cp -v mpdpopm/target/release/mppopm{,d} "$staging/bin"
cp -v doc/mpdpopm.info "$staging/doc/"
cp -v mpdpopm/target/release/mppopm{,d} "$staging/bin/"
tar czf "$staging.tar.gz" "$staging"
echo "ASSET=$staging.tar.gz" >> $GITHUB_ENV
Expand Down
9 changes: 8 additions & 1 deletion ChangeLog
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
2021-03-20 Michael Herstine <[email protected]>
2021-03-27 Michael Herstine <[email protected]>

Documentation commit.
Broke-up the README; most of its content went into a new
user manual in Texinfo format. The process of documenting
filter quoting exposed multiple bugs-- fixed.

2021-03-21 Michael Herstine <[email protected]>

First true filter implementation.
This commit:
Expand Down
2 changes: 1 addition & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
@@ -1 +1 @@
SUBDIRS = mpdpopm
SUBDIRS = mpdpopm doc
14 changes: 14 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
mpdpopm News -- history of user-visible changes -*- outline -*-

* 0.2.3 build

** User-visible changes

*** broke-up the README

Broke-up README.org into a much shorter version focused on installing mpdpopm and a full-fledged user-manual.

** Bug-fixes

*** quoting

Fixed a number of bugs relating to quoting filters.

* 0.2.2 build

** User-visible changes
Expand Down
254 changes: 64 additions & 190 deletions README.org

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions THANKS
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Thanks to tanshoku <https://github.com/tanshoku> for contributing
the systemd unit.
Thanks to tanshoku <https://github.com/tanshoku> for his suggested
systemd unit file.

Thanks to m040601 <https://github.com/m040601> for his detailed
feedback on the initial mpdpopm docs.
Expand Down
3 changes: 2 additions & 1 deletion configure.ac
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
AC_INIT([mpdpopm], [0.2.2], [[email protected]], [mpdpopm], [https://github.com/sp1ff/mpdpopm])
AC_INIT([mpdpopm], [0.2.3], [[email protected]], [mpdpopm], [https://github.com/sp1ff/mpdpopm])
AC_CONFIG_AUX_DIR([build-aux])
AC_CONFIG_SRCDIR([mpdpopm/Cargo.toml.in])
AM_INIT_AUTOMAKE([-Wall -Werror -Wno-portability -Wno-override gnits std-options dist-bzip2 dist-xz])
Expand Down Expand Up @@ -27,6 +27,7 @@ AC_CONFIG_FILES([mpdpopm/mppopmd.conf.am:etc/mppopmd.conf.am.in])
AC_CONFIG_FILES([mpdpopm/mppopmd.service.am:etc/mppopmd.service.am.in])
AC_CONFIG_FILES([PKGBUILD:admin/PKGBUILD.in])
AC_CONFIG_FILES([Makefile mpdpopm/Makefile mpdpopm/Cargo.toml])
AC_CONFIG_FILES([doc/Makefile])

dnl Specify --enable-debug to make a development release. By default,
dnl we build in public release mode.
Expand Down
1 change: 1 addition & 0 deletions doc/Makefile.am
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
info_TEXINFOS = mpdpopm.texi
Loading

0 comments on commit 4507370

Please sign in to comment.