hath.cabal: drop a word and a period from the synopsis

[hath.git] / hath.cabal

diff --git a/hath.cabal b/hath.cabal
index 4431b842b625a9f285f88933bbbae73679c319e1..79315979ce73e4a6c9bafb7d9c72f20df401ebb5 100644 (file)
--- a/hath.cabal
+++ b/hath.cabal
@@ -1,69 +1,42 @@
+cabal-version:  3.0
 name:           hath
-version:        0.0.1
-cabal-version:  >= 1.8
+version:        0.5.8
 author:         Michael Orlitzky
-maintainer:    Michael Orlitzky <michael@orlitzky.com>
+maintainer:     Michael Orlitzky <michael@orlitzky.com>
+homepage:       https://michael.orlitzky.com/code/hath.xhtml
+bug-reports:    mailto:michael@orlitzky.com
+category:       Utils
+license:        AGPL-3.0-or-later
+license-file:   doc/LICENSE
 build-type:     Simple
+extra-source-files:
+  doc/COPYING
+  doc/man1/hath.1
+  test/shell/*.test
 synopsis:
-  Hath manipulates network blocks in CIDR notation.
+  Manipulates network blocks in CIDR notation
 description:
   Hath is a Haskell program for working with network blocks in CIDR
   notation. When dealing with blocks of network addresses, there are a
   few things that one usually wants to do with them:
-  .
+
     * Create a regular expression matching the CIDR block(s). This is
       because grep will throw up if you feed it CIDR.
-  .
+
     * Combine small blocks into larger ones. For example, if you have two
       consecutive \/24s, they might combine into a larger \/23.
-  .
+
     * View the result of block combination in a useful way.
-  .
-  Hath has four modes to perform these functions:
-  .
-    [@Regexed@]
-    This computes a (Perl-compatible) regular expression matching
-    the input CIDR blocks. It's the default mode of operation.
-  .
-    [@Reduced@]
-    This combines small blocks into larger ones where possible, and
-    eliminates redundant blocks. The output should be equivalent to
-    the input, though.
-  .
-    [@Duped@]
-    Shows only the blocks that would be removed by reduce; that is, it
-    shows the ones that would get combined into larger blocks or are
-    simply redundant.
-  .
-    [@Diffed@]
-    Shows what would change if you used reduce. Uses diff-like
-    notation.
-  .
-  /Examples/:
-  .
-  Combine two \/24s into a \/23:
-  .
-  @
-  $ hath reduced <<< \"10.0.0.0\/24 10.0.1.0\/24\"
-  10.0.0.0/23
-  @
-  .
-  Create a perl-compatible regex to be fed to grep:
-  .
-  @
-  $ grep -P `hath regexed -i cidrs.txt` mail.log
-  @
+
+    * List them.
+
+  Hath has several modes to perform these functions. The command-line
+  syntax and complete set of options are documented in the man page.
+
 
 executable hath
-  build-depends:
-    base                        == 4.*,
-    HUnit                       == 1.2.*,
-    QuickCheck                  == 2.6.*,
-    MissingH                    == 1.2.*,
-    split                       == 0.2.*,
-    test-framework              == 0.8.*,
-    test-framework-hunit        == 0.3.*,
-    test-framework-quickcheck2  == 0.3.*
+  default-language:
+    Haskell2010
 
   main-is:
     Main.hs
@@ -71,62 +44,65 @@ executable hath
   hs-source-dirs:
     src/
 
-  ghc-options:
-    -Wall
-    -fwarn-hi-shadowing
-    -fwarn-missing-signatures
-    -fwarn-name-shadowing
-    -fwarn-orphans
-    -fwarn-type-defaults
-    -fwarn-tabs
-    -fwarn-incomplete-record-updates
-    -fwarn-monomorphism-restriction
-    -fwarn-unused-do-bind
-    -rtsopts
-    -threaded
-    -optc-O3
-    -optc-march=native
-    -O2
-
-  ghc-prof-options:
-    -prof
-    -auto-all
-    -caf-all
+  other-modules:
+    Bit
+    Cidr
+    CommandLine
+    ExitCodes
+    IPv4Address
+    Maskable
+    Maskbits
+    Octet
+    Paths_hath
+
+  autogen-modules:
+    Paths_hath
+
+  build-depends:
+    base                        >= 4.15 && < 5.0,
+    cmdargs                     >= 0.10,
+    split                       >= 0.2,
+    tasty                       >= 0.8,
+    tasty-hunit                 >= 0.8,
+    tasty-quickcheck            >= 0.8.1
 
 
 test-suite testsuite
   type: exitcode-stdio-1.0
   hs-source-dirs: src test
+  default-language: Haskell2010
   main-is: TestSuite.hs
+
+  other-modules:
+    Bit
+    Cidr
+    IPv4Address
+    Maskable
+    Maskbits
+    Octet
+
   build-depends:
-    base                        == 4.*,
-    HUnit                       == 1.2.*,
-    QuickCheck                  == 2.6.*,
-    MissingH                    == 1.2.*,
-    split                       == 0.2.*,
-    test-framework              == 0.8.*,
-    test-framework-hunit        == 0.3.*,
-    test-framework-quickcheck2  == 0.3.*
-
-  -- It's not entirely clear to me why I have to reproduce all of this.
-  ghc-options:
-    -Wall
-    -fwarn-hi-shadowing
-    -fwarn-missing-signatures
-    -fwarn-name-shadowing
-    -fwarn-orphans
-    -fwarn-type-defaults
-    -fwarn-tabs
-    -fwarn-incomplete-record-updates
-    -fwarn-monomorphism-restriction
-    -fwarn-unused-do-bind
-    -rtsopts
-    -threaded
-    -optc-O3
-    -optc-march=native
-    -O2
+    base                        >= 4.15 && < 5.0,
+    split                       >= 0.2,
+    tasty                       >= 0.8,
+    tasty-hunit                 >= 0.8,
+    tasty-quickcheck            >= 0.8.1
+
+
+-- These won't work without shelltestrunner installed in your
+-- $PATH. Maybe there is some way to tell Cabal that.
+test-suite shelltests
+  type: exitcode-stdio-1.0
+  hs-source-dirs: test
+  default-language: Haskell2010
+  main-is: ShellTests.hs
+
+  build-depends:
+    base                        >= 4.15 && < 5.0,
+    process                     >= 1.1
+
 
 source-repository head
   type: git
-  location: http://michael.orlitzky.com/git/hath.git
+  location: https://gitweb.michael.orlitzky.com/hath.git
   branch: master