Update synopsis from --help in pod
authorÉtienne BERSAC <etienne.bersac@dalibo.com>
Thu, 21 Sep 2017 09:41:16 +0000 (11:41 +0200)
committerÉtienne BERSAC <etienne.bersac@dalibo.com>
Thu, 21 Sep 2017 10:06:43 +0000 (12:06 +0200)
.circleci/config.yml
CONTRIBUTING.md
Makefile.PL

index f964e679afb8523e9bb42d76172147d1e2ffcbb8..b1724ef5f3a5b85e5b2e853d8620818a5e298722 100644 (file)
@@ -28,9 +28,9 @@ jobs:
         name: Check README is up to date with pod
         command: |
           perl Makefile.PL
-          touch --no-create doc/pgBadger.pod
+          touch --no-create pgbadger
           make README
-          git diff --exit-code
+          git diff --exit-code README doc/pgBadger.pod
 
 workflows:
   version: 2
index 312bf81584c69826939270239bcc37121f845427..dc7692c02c87d9d268ec687faecb7ab8a9a4cfdc 100644 (file)
 
 pgBadger project provides a [.editorconfig](http://editorconfig.org/) file to
 setup consistent spacing in files. Please follow it!
+
+
+## Keep Documentation Updated
+
+The first pgBadger documentation is `pgbadger --help`. `--help` is
+injected in `doc/pgBadger.pod`. `README` is the text formatting of
+`doc/pgBadger.pod`. Update `README` and `doc/pgBadger.pod` with `make
+README`.
+
+A job in CI ensure all versionned documentations are consistent.
index e7d59263ec4f23afc04415ea123b772a0eceac0e..753ce9fc23684caae8c42c016b191ad9fef36942 100644 (file)
@@ -39,6 +39,18 @@ sub MY::postamble {
     return <<'EOMAKE';
 README: doc/pgBadger.pod
        pod2text $^ > $@
+
+.INTERMEDIATE: doc/synopsis.pod
+doc/synopsis.pod: Makefile pgbadger
+       echo "=head1 SYNOPSIS" > $@
+       ./pgbadger --help >> $@
+       echo "=head1 DESCRIPTION" >> $@
+       sed -i 's/ +$$//g' $@
+
+doc/pgBadger.pod: doc/synopsis.pod Makefile
+       git checkout $@
+       sed -i '/^=head1 SYNOPSIS/,/^=head1 DESCRIPTION/d' $@
+       sed -i '4r $<' $@
 EOMAKE
 }