chaintool/chainlib
4
0
Fork 0
Code Issues 1 Pull Requests 2 Projects Releases Wiki Activity

Automatically apply overrides if file exists, use source dir instead of head file explicitly in man generator

Browse Source
This commit is contained in:
lash 2022-02-24 11:22:54 +00:00
parent fcd78b5ca8
commit 9b0f900eb3
Signed by: lash
GPG Key ID: 21D2E7BB88C2A746
1 changed files with 40 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
scripts/chainlib-man.py
View File

@ -79,13 +79,13 @@ https://git.defalsify.org
argparser = argparse.ArgumentParser() argparser = argparse.ArgumentParser()
argparser.add_argument('-b', default=add_0x(hex(argflag_std_base)), help='argument flag bitmask') argparser.add_argument('-b', default=add_0x(hex(argflag_std_base)), help='argument flag bitmask')
argparser.add_argument('-c', help='config override directory') argparser.add_argument('-c', help='config override directory')
argparser.add_argument('-n', help='tool name to use for man filename') argparser.add_argument('-n', required=True, help='tool name to use for man filename')
argparser.add_argument('-d', default='.', help='output directory') argparser.add_argument('-d', default='.', help='output directory')
argparser.add_argument('-v', action='store_true', help='turn on debug logging') argparser.add_argument('-v', action='store_true', help='turn on debug logging')
argparser.add_argument('--overrides-file', dest='overrides_file', help='load options description override from file') #argparser.add_argument('--overrides-dir', dest='overrides_dir', help='load options description override from file')
argparser.add_argument('--overrides-env-dir', dest='overrides_env_dir', help='load envionment description override config from directory') argparser.add_argument('--overrides-env-dir', dest='overrides_env_dir', help='load envionment description override config from directory')
argparser.add_argument('--overrides-config-file', dest='overrides_config_file', help='load configuration text from file') argparser.add_argument('--overrides-config-file', dest='overrides_config_file', help='load configuration text from file')
argparser.add_argument('header_file', help='groff file containing heading, synopsis and description') argparser.add_argument('source_dir', help='directory containing sources for the tool man page')
args = argparser.parse_args(sys.argv[1:]) args = argparser.parse_args(sys.argv[1:])
if args.v: if args.v:
@ -100,13 +100,23 @@ logg.debug('apply arg flags {}: {}'.format(flags, ', '.join(flags_debug)))
g = DocGenerator(flags) g = DocGenerator(flags)
toolname = args.n toolname = args.n
if toolname == None: #if toolname == None:
parts = os.path.splitext(os.path.basename(args.header_file)) # parts = os.path.splitext(os.path.basename(args.header_file))
toolname = parts[0] # toolname = parts[0]
g.process() g.process()
if args.overrides_file != None: def apply_override(g, override_dir):
f = open(args.overrides_file, 'r') #if args.overrides_dir != None:
overrides_file = os.path.join(override_dir, toolname + '.overrides')
override = True
f = None
try:
f = open(overrides_file, 'r')
except FileNotFoundError:
logg.debug('no overrides found for {}'.format(toolname))
override = False
if override:
while True: while True:
s = f.readline() s = f.readline()
if len(s) == 0: if len(s) == 0:
@ -119,14 +129,21 @@ if args.overrides_file != None:
fargs = [] fargs = []
g.override_arg(v[0], v[1], fargs) g.override_arg(v[0], v[1], fargs)
f.close() f.close()
return g
g = apply_override(g, args.source_dir)
ge = EnvDocGenerator(flags, override=args.overrides_env_dir) ge = EnvDocGenerator(flags, override=args.overrides_env_dir)
ge.process() ge.process()
f = open(args.header_file) def get_head(tool_name, source_dir):
head = f.read() header_file = os.path.join(source_dir, tool_name + '.head.groff')
f.close() f = open(header_file, 'r')
head = f.read()
f.close()
return head
head = get_head(toolname, args.source_dir)
if args.overrides_config_file != None: if args.overrides_config_file != None:
f = open(args.overrides_config_file, 'r') f = open(args.overrides_config_file, 'r')