Stop generated manpage from showing dev settings

Reported-by: SanskritFritz

5 files changed, 25 insertions, 16 deletions

diff --git a/NEWS b/NEWS
index 1e0fd47b..d582cf5d 100644
--- a/NEWS
+++ b/NEWS
@@ -3,6 +3,19 @@ Obnam NEWS
 
 This file summarizes changes between releases of Obnam.
 
+Version 1.X, released UNRELEASED
+--------------------------------
+
+Bug fixes:
+
+* `--help` output no longer shows the default value of any options. It
+  was shown only for a few options anyway. The proper way to see the
+  current settings is with the `--dump-config` option. The bug that
+  was fixed that the generated manual page no longer contains values
+  that are specific to the machine doing the generation, such as the
+  hostname as the default value for `--client-name`. Reported by
+  SanskritFritz.
+
 Version 1.7.4, released 2014-03-31
 --------------------------------
 
diff --git a/create-reference-repo b/create-reference-repo
index 9b9e2a7f..7e3d6165 100755
--- a/create-reference-repo
+++ b/create-reference-repo
@@ -48,7 +48,7 @@ class CreateReferenceRepository(cliapp.Application):
     def add_settings(self):
         self.settings.string(
             ['obnam'],
-            'which obnam to execute (default: %default)',
+            'which obnam to execute',
             metavar='CMD',
             default='./obnam')
 
diff --git a/obnamlib/app.py b/obnamlib/app.py
index b1a9083f..669cb0a2 100644
--- a/obnamlib/app.py
+++ b/obnamlib/app.py
@@ -48,33 +48,31 @@ class App(cliapp.Application):
 
         self.settings.string(['repository', 'r'], 'name of backup repository')
 
-        self.settings.string(['client-name'], 'name of client (%default)',
-                           default=self.deduce_client_name())
+        self.settings.string(
+            ['client-name'],
+            'name of client (defaults to hostname)',
+            default=self.deduce_client_name())
 
         self.settings.bytesize(['node-size'],
                              'size of B-tree nodes on disk; only affects new '
                                 'B-trees so you may need to delete a client '
                                 'or repository to change this for existing '
-                                'repositories '
-                                 '(default: %default)',
+                                'repositories',
                               default=obnamlib.DEFAULT_NODE_SIZE,
                               group=perf_group)
 
         self.settings.bytesize(['chunk-size'],
-                            'size of chunks of file data backed up '
-                                 '(default: %default)',
+                            'size of chunks of file data backed up',
                              default=obnamlib.DEFAULT_CHUNK_SIZE,
                               group=perf_group)
 
         self.settings.bytesize(['upload-queue-size'],
-                            'length of upload queue for B-tree nodes '
-                                 '(default: %default)',
+                            'length of upload queue for B-tree nodes',
                             default=obnamlib.DEFAULT_UPLOAD_QUEUE_SIZE,
                             group=perf_group)
 
         self.settings.bytesize(['lru-size'],
-                             'size of LRU cache for B-tree nodes '
-                                 '(default: %default)',
+                             'size of LRU cache for B-tree nodes',
                              default=obnamlib.DEFAULT_LRU_SIZE,
                              group=perf_group)
 
diff --git a/obnamlib/plugins/backup_plugin.py b/obnamlib/plugins/backup_plugin.py
index 35661f19..99971d60 100644
--- a/obnamlib/plugins/backup_plugin.py
+++ b/obnamlib/plugins/backup_plugin.py
@@ -265,13 +265,12 @@ class BackupPlugin(obnamlib.ObnamPlugin):
                                     'that are in a different filesystem',
                                  group=backup_group)
         self.app.settings.bytesize(['checkpoint'],
-                                      'make a checkpoint after a given SIZE '
-                                      '(%default)',
+                                      'make a checkpoint after a given SIZE',
                                     metavar='SIZE',
                                     default=1024**3,
                                  group=backup_group)
         self.app.settings.integer(['chunkids-per-group'],
-                                  'encode NUM chunk ids per group (%default)',
+                                  'encode NUM chunk ids per group',
                                   metavar='NUM',
                                   default=obnamlib.DEFAULT_CHUNKIDS_PER_GROUP,
                                   group=perf_group)
diff --git a/obnamlib/plugins/sftp_plugin.py b/obnamlib/plugins/sftp_plugin.py
index 4c16f44b..cdbd1cc7 100644
--- a/obnamlib/plugins/sftp_plugin.py
+++ b/obnamlib/plugins/sftp_plugin.py
@@ -671,8 +671,7 @@ class SftpPlugin(obnamlib.ObnamPlugin):
                                  group=ssh_group)
 
         self.app.settings.string(['ssh-known-hosts'],
-                                 'filename of the user\'s known hosts file '
-                                    '(default: %default)',
+                                 'filename of the user\'s known hosts file',
                                  metavar='FILENAME',
                                  default=
                                     os.path.expanduser('~/.ssh/known_hosts'),