summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobin H. Johnson <robbat2@gentoo.org>2015-08-08 13:49:04 -0700
committerRobin H. Johnson <robbat2@gentoo.org>2015-08-08 17:38:18 -0700
commit56bd759df1d0c750a065b8c845e93d5dfa6b549d (patch)
tree3f91093cdb475e565ae857f1c5a7fd339e2d781e /dev-haskell/readargs/metadata.xml
downloadgentoo-56bd759df1d0c750a065b8c845e93d5dfa6b549d.tar.gz
gentoo-56bd759df1d0c750a065b8c845e93d5dfa6b549d.tar.bz2
gentoo-56bd759df1d0c750a065b8c845e93d5dfa6b549d.zip
proj/gentoo: Initial commit
This commit represents a new era for Gentoo: Storing the gentoo-x86 tree in Git, as converted from CVS. This commit is the start of the NEW history. Any historical data is intended to be grafted onto this point. Creation process: 1. Take final CVS checkout snapshot 2. Remove ALL ChangeLog* files 3. Transform all Manifests to thin 4. Remove empty Manifests 5. Convert all stale $Header$/$Id$ CVS keywords to non-expanded Git $Id$ 5.1. Do not touch files with -kb/-ko keyword flags. Signed-off-by: Robin H. Johnson <robbat2@gentoo.org> X-Thanks: Alec Warner <antarus@gentoo.org> - did the GSoC 2006 migration tests X-Thanks: Robin H. Johnson <robbat2@gentoo.org> - infra guy, herding this project X-Thanks: Nguyen Thai Ngoc Duy <pclouds@gentoo.org> - Former Gentoo developer, wrote Git features for the migration X-Thanks: Brian Harring <ferringb@gentoo.org> - wrote much python to improve cvs2svn X-Thanks: Rich Freeman <rich0@gentoo.org> - validation scripts X-Thanks: Patrick Lauer <patrick@gentoo.org> - Gentoo dev, running new 2014 work in migration X-Thanks: Michał Górny <mgorny@gentoo.org> - scripts, QA, nagging X-Thanks: All of other Gentoo developers - many ideas and lots of paint on the bikeshed
Diffstat (limited to 'dev-haskell/readargs/metadata.xml')
-rw-r--r--dev-haskell/readargs/metadata.xml71
1 files changed, 71 insertions, 0 deletions
diff --git a/dev-haskell/readargs/metadata.xml b/dev-haskell/readargs/metadata.xml
new file mode 100644
index 000000000000..240a652b0a68
--- /dev/null
+++ b/dev-haskell/readargs/metadata.xml
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+ <herd>haskell</herd>
+ <longdescription>
+ ReadArgs provides the @readArgs@ IO action, which lets you tell the compiler
+ to parse the command line arguments to fit the type signature you give.
+
+ For example @(a :: Int, b :: String, c :: Float) &lt;- readArgs@ would
+ parse the first runtime argument as an @Int@, the second as a @String@ (no
+ quotes required) and the third as a @Float@.
+
+ If the runtime arguments are incompatible with the type signature,
+ then a simple usage statement is given of the types needed.
+
+ Continuing the previous example, if it was used in a
+ program named @Example@, the error message for the above
+ action would be:
+
+ @
+ usage: Example Int String Float
+ @
+
+ Any type that has both @Typeable@ and @Read@ instances
+ can be used. @Char@, @String@, and @Text@ are handled specially so that
+ command line arguments for both do not require quotes (as their
+ @Read@ instances do). A special instance is provided for @FilePath@ so
+ that no constructor or quotes are required.
+
+ @readArgs@ also supports optional arguments and variadic arguments.
+ Optional arguments are specified using @Maybe@, and variadic arguments
+ using a list. @(a :: Int, b :: Maybe String, c :: [Float]) &lt;- readArgs@
+ would successfully parse any of the following sets of command line arguments:
+
+ @
+ Example 1
+ Example 1 2 3 4
+ Example 1 foo
+ Example 1 foo 2 3 4
+ @
+
+ But not
+
+ @
+ Example
+ Example foo
+ Example 1.0
+ @
+
+ Usage statements for optional and variadic arguments use command-line
+ parlance:
+
+ @
+ usage: Example Int [String] [Float..]
+ @
+
+ Note that both optional and variadic parsers are greedy by default
+ (so @Example 1 2 3 4@ was parsed as @(1, "2", [3.0,4.0])@. They
+ may both be made non-greedy through use of the @NonGreedy@ constructor:
+
+ @
+ ( a :: Int
+ , NonGreedy b :: NonGreedy Maybe String
+ , NonGreedy c :: NonGreedy [] Float
+ ) &lt;- readArgs
+ @
+ </longdescription>
+ <upstream>
+ <remote-id type="github">rampion/ReadArgs</remote-id>
+ </upstream>
+</pkgmetadata>