aboutsummaryrefslogtreecommitdiff
path: root/include/libsurvive
diff options
context:
space:
mode:
authorJustin Berger <j.david.berger@gmail.com>2018-03-24 10:13:23 -0600
committerJustin Berger <j.david.berger@gmail.com>2018-03-24 10:13:23 -0600
commitd5c42c4951261c401c5f9148ce2d6bb1402ce75b (patch)
tree1ff58058d0810f2f82ecc8f3882b9f68f8748409 /include/libsurvive
parentb45e58d9f75747e8727ac6cd0594a921e945c7e2 (diff)
downloadlibsurvive-d5c42c4951261c401c5f9148ce2d6bb1402ce75b.tar.gz
libsurvive-d5c42c4951261c401c5f9148ce2d6bb1402ce75b.tar.bz2
Some minor fixups around command line processing
Diffstat (limited to 'include/libsurvive')
-rw-r--r--include/libsurvive/survive.h15
1 files changed, 11 insertions, 4 deletions
diff --git a/include/libsurvive/survive.h b/include/libsurvive/survive.h
index 0b85bf3..b1c32cd 100644
--- a/include/libsurvive/survive.h
+++ b/include/libsurvive/survive.h
@@ -202,11 +202,18 @@ struct SurviveContext
void survive_verify_FLT_size(uint32_t user_size); // Baked in size of FLT to verify users of the library have the correct setting.
-
-
-
-
SurviveContext * survive_init_internal( int argc, char * const * argv );
+
+/**
+ * Call survive_init to get a populated SurviveContext pointer.
+ *
+ * This also sets up a number of configuration values based on command line
+ * arguments. Pass 0, 0 to this function if you specifically do not want
+ * command line processing.
+ *
+ * Note that this function _can_ return null based on command line arguments,
+ * notably if -h was passed in.
+ */
static inline SurviveContext * survive_init( int argc, char * const * argv )
{
survive_verify_FLT_size(sizeof(FLT));