Browse Source

[trac615] Small cleanups

* A variable name
* Clarification of man pages
Michal 'vorner' Vaner 14 years ago
parent
commit
1e67f2cbd8

+ 4 - 3
src/bin/bind10/bind10.xml

@@ -101,9 +101,10 @@
           <option>--data-path</option> <replaceable>data-path</replaceable>
         </term>
         <listitem>
-          <para>The path where BIND looks for configuration files, if their
-          names are not absolute. It might be used for other data files in
-          future as well.</para>
+          <para>The path where BIND 10 programs look for various data files.
+          Currently only b10-cfgmgr uses it to locate the configuration file,
+          but the usage might be extended for other programs and other types
+          of files.</para>
         </listitem>
       </varlistentry>
 

+ 2 - 2
src/bin/cfgmgr/b10-cfgmgr.py.in

@@ -51,7 +51,7 @@ def parse_options(args=sys.argv[1:], Parser=OptionParser):
     parser.add_option("-p", "--data-path", dest="data_path",
                       help="Directory to search for configuration files " +
                       "(default=" + DATA_PATH + ")", default=DATA_PATH)
-    parser.add_option("-c", "--config-filename", dest="file_name",
+    parser.add_option("-c", "--config-filename", dest="config_file",
                       help="Configuration database filename " +
                       "(default=" + DEFAULT_CONFIG_FILE + ")",
                       default=DEFAULT_CONFIG_FILE)
@@ -69,7 +69,7 @@ def main():
     options = parse_options()
     global cm
     try:
-        cm = ConfigManager(options.data_path, options.file_name)
+        cm = ConfigManager(options.data_path, options.config_file)
         signal.signal(signal.SIGINT, signal_handler)
         signal.signal(signal.SIGTERM, signal_handler)
         cm.read_config()

+ 3 - 1
src/bin/cfgmgr/b10-cfgmgr.xml

@@ -114,7 +114,9 @@
           <option>--data-path</option> <replaceable>data-path</replaceable>
         </term>
         <listitem>
-          <para>The path where bind looks for configuration files.</para>
+          <para>The path where BIND 10 looks for files. The
+          configuration file is looked for here, if it is relative. If it is
+          absolute, the path is ignored.</para>
         </listitem>
       </varlistentry>
     </variablelist>

+ 5 - 5
src/bin/cfgmgr/tests/b10-cfgmgr_test.py.in

@@ -103,7 +103,7 @@ class TestParseArgs(unittest.TestCase):
         b = __import__("b10-cfgmgr")
         parsed = b.parse_options([], TestOptParser)
         self.assertEqual(b.DATA_PATH, parsed.data_path)
-        self.assertEqual(b.DEFAULT_CONFIG_FILE, parsed.file_name)
+        self.assertEqual(b.DEFAULT_CONFIG_FILE, parsed.config_file)
 
     def test_wrong_args(self):
         """
@@ -129,10 +129,10 @@ class TestParseArgs(unittest.TestCase):
         b = __import__("b10-cfgmgr")
         parsed = b.parse_options(['--data-path=/path'], TestOptParser)
         self.assertEqual('/path', parsed.data_path)
-        self.assertEqual(b.DEFAULT_CONFIG_FILE, parsed.file_name)
+        self.assertEqual(b.DEFAULT_CONFIG_FILE, parsed.config_file)
         parsed = b.parse_options(['-p', '/path'], TestOptParser)
         self.assertEqual('/path', parsed.data_path)
-        self.assertEqual(b.DEFAULT_CONFIG_FILE, parsed.file_name)
+        self.assertEqual(b.DEFAULT_CONFIG_FILE, parsed.config_file)
         self.assertRaises(OptsError, b.parse_options, ['-p'], TestOptParser)
         self.assertRaises(OptsError, b.parse_options, ['--data-path'],
                           TestOptParser)
@@ -145,10 +145,10 @@ class TestParseArgs(unittest.TestCase):
         parsed = b.parse_options(['--config-filename=filename'],
                                  TestOptParser)
         self.assertEqual(b.DATA_PATH, parsed.data_path)
-        self.assertEqual("filename", parsed.file_name)
+        self.assertEqual("filename", parsed.config_file)
         parsed = b.parse_options(['-c', 'filename'], TestOptParser)
         self.assertEqual(b.DATA_PATH, parsed.data_path)
-        self.assertEqual("filename", parsed.file_name)
+        self.assertEqual("filename", parsed.config_file)
         self.assertRaises(OptsError, b.parse_options, ['-c'], TestOptParser)
         self.assertRaises(OptsError, b.parse_options, ['--config-filename'],
                           TestOptParser)