summaryrefslogtreecommitdiffstats
path: root/libs/OptParse/README.md
diff options
context:
space:
mode:
authorEvan Lojewski <github@meklort.com>2020-04-13 20:44:30 -0600
committerGitHub <noreply@github.com>2020-04-13 20:44:30 -0600
commit3ba78ad317d21d354d26dd6a95b81833ae236bfe (patch)
treef6b5979d80512f0109bebd6aeb0d7af693353a86 /libs/OptParse/README.md
parenta985bfd6cdbe977e02c72de85f958e74ddf372e7 (diff)
downloadbcm5719-ortega-3ba78ad317d21d354d26dd6a95b81833ae236bfe.tar.gz
bcm5719-ortega-3ba78ad317d21d354d26dd6a95b81833ae236bfe.zip
coverity: Fix issues found with coverity (#79)
Diffstat (limited to 'libs/OptParse/README.md')
-rw-r--r--libs/OptParse/README.md53
1 files changed, 0 insertions, 53 deletions
diff --git a/libs/OptParse/README.md b/libs/OptParse/README.md
deleted file mode 100644
index d9452fc..0000000
--- a/libs/OptParse/README.md
+++ /dev/null
@@ -1,53 +0,0 @@
-# cpp-optparse
-
-This is yet another option parser for C++. It is modelled after the excellent
-Python optparse API. Although incomplete, anyone familiar to
-[optparse](http://docs.python.org/library/optparse.html) should feel at home.
-
-- Copyright (c) 2010 Johannes Weißl
-- License: MIT License
-
-## Design decisions
-
-- Elegant and easy usage more important than speed / flexibility
-- Small size more important than feature completeness, e.g.:
- * No unicode
- * No checking for user programming errors
- * No conflict handlers
- * No adding of new actions
-
-## FAQ
-
-- Why not use getopt/getopt_long?
- * Not C++ / not completely POSIX
- * Too cumbersome to use, would need lot of additional code
-- Why not use Boost.Program_options?
- * Boost not installed on all target platforms (esp. cluster, HPC, ...)
- * Too big to include just for option handling for many projects:
- 322 *.h (44750 lines) + 7 *.cpp (2078 lines)
-- Why not use tclap/Opag/Options/CmdLine/Anyoption/Argument_helper/...?
- * Similarity to Python desired for faster learning curve
-
-## Future work
-
-- Support nargs > 1?
-
-## Example
-
-```cpp
-using optparse::OptionParser;
-
-OptionParser parser = OptionParser() .description("just an example");
-
-parser.add_option("-f", "--file") .dest("filename")
- .help("write report to FILE") .metavar("FILE");
-parser.add_option("-q", "--quiet")
- .action("store_false") .dest("verbose") .set_default("1")
- .help("don't print status messages to stdout");
-
-optparse::Values options = parser.parse_args(argc, argv);
-vector<string> args = parser.args();
-
-if (options.get("verbose"))
- cout << options["filename"] << endl;
-```
OpenPOWER on IntegriCloud