mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-11-22 09:35:45 +03:00
Code Issues Projects Releases Packages Wiki Activity

Improve help and cmdline option names for --generate-config options (#5512)

Browse source 
* group the arguments together into a group
* add new names "--generate-missing-config" and "--config-directory" for
  existing cmdline options "--generate-keys" and "--keys-dir", which better
  reflect their purposes.
This commit is contained in:
Richard van der Hoff 2019-06-21 18:50:43 +01:00 committed by GitHub
parent 03cea2b0fe
commit e1a795758c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 30 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/5512.feature Normal file
View file

@ -0,0 +1 @@
Improve help and cmdline option names for --generate-config options.

52
synapse/config/_base.py
View file

@ -254,37 +254,43 @@ class Config(object):
help="Specify config file. Can be given multiple times and" help="Specify config file. Can be given multiple times and"
" may specify directories containing *.yaml files.", " may specify directories containing *.yaml files.",
) )
config_parser.add_argument(
generate_group = config_parser.add_argument_group("Config generation")
generate_group.add_argument(
"--generate-config", "--generate-config",
action="store_true", action="store_true",
help="Generate a config file for the server name", help="Generate a config file, then exit.",
) )
config_parser.add_argument( generate_group.add_argument(
"--report-stats", "--generate-missing-configs",
action="store",
help="Whether the generated config reports anonymized usage statistics",
choices=["yes", "no"],
)
config_parser.add_argument(
"--generate-keys", "--generate-keys",
action="store_true", action="store_true",
help="Generate any missing key files then exit", help="Generate any missing additional config files, then exit.",
) )
config_parser.add_argument( generate_group.add_argument(
"-H", "--server-name", help="The server name to generate a config file for."
)
generate_group.add_argument(
"--report-stats",
action="store",
help="Whether the generated config reports anonymized usage statistics.",
choices=["yes", "no"],
)
generate_group.add_argument(
"--config-directory",
"--keys-directory", "--keys-directory",
metavar="DIRECTORY", metavar="DIRECTORY",
help="Used with 'generate-*' options to specify where files such as" help=(
" signing keys should be stored, unless explicitly" "Specify where additional config files such as signing keys and log"
" specified in the config.", " config should be stored. Defaults to the same directory as the main"
) " config file."
config_parser.add_argument( ),
"-H", "--server-name", help="The server name to generate a config file for"
) )
config_args, remaining_args = config_parser.parse_known_args(argv) config_args, remaining_args = config_parser.parse_known_args(argv)
config_files = find_config_files(search_paths=config_args.config_path) config_files = find_config_files(search_paths=config_args.config_path)
generate_keys = config_args.generate_keys generate_missing_configs = config_args.generate_missing_configs
obj = cls() obj = cls()
@ -303,8 +309,8 @@ class Config(object):
(config_path,) = config_files (config_path,) = config_files
if not cls.path_exists(config_path): if not cls.path_exists(config_path):
print("Generating config file %s" % (config_path,)) print("Generating config file %s" % (config_path,))
if config_args.keys_directory: if config_args.config_directory:
config_dir_path = config_args.keys_directory config_dir_path = config_args.config_directory
else: else:
config_dir_path = os.path.dirname(config_path) config_dir_path = os.path.dirname(config_path)
config_dir_path = os.path.abspath(config_dir_path) config_dir_path = os.path.abspath(config_dir_path)
@ -350,7 +356,7 @@ class Config(object):
) )
% (config_path,) % (config_path,)
) )
generate_keys = True generate_missing_configs = True
parser = argparse.ArgumentParser( parser = argparse.ArgumentParser(
parents=[config_parser], parents=[config_parser],
@ -369,10 +375,10 @@ class Config(object):
) )
config_dict = obj.read_config_files( config_dict = obj.read_config_files(
config_files, keys_directory=args.keys_directory config_files, keys_directory=config_args.config_directory
) )
if generate_keys: if generate_missing_configs:
obj.generate_missing_files(config_dict) obj.generate_missing_files(config_dict)
return None return None