From 8027e319831f02538fe431b5870d90c0267b3b78 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Sun, 23 Jan 2011 14:39:19 +0200
Subject: Allow the options file search function to ignore the file

---
 doc/guide/index.xhtml | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

(limited to 'doc')

diff --git a/doc/guide/index.xhtml b/doc/guide/index.xhtml
index bc215e3..638b65b 100644
--- a/doc/guide/index.xhtml
+++ b/doc/guide/index.xhtml
@@ -743,9 +743,13 @@ namespace cli
 
     struct option_info
     {
-        const char* option;
-        std::string (*search_func) (const char*, void* arg);
-        void* arg;
+      // If search_func is not NULL, it is called, with the arg
+      // value as the second argument, to locate the options file.
+      // If it returns an empty string, then the file is ignored.
+      //
+      const char* option;
+      std::string (*search_func) (const char*, void* arg);
+      void* arg;
     };
 
     argv_file_scanner (int&amp; argc,
-- 
cgit v1.1