1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Generate man pages for the q applets"""
from __future__ import print_function
import datetime
import functools
import glob
import locale
import multiprocessing
import os
import re
import subprocess
import sys
import yaml
MKMAN_DIR = os.path.realpath(os.path.join(__file__, '..'))
FRAGS_DIR = os.path.join(MKMAN_DIR, 'include')
TOPDIR = os.path.join(MKMAN_DIR, '..')
Q = os.path.join(TOPDIR, 'q')
def FindApplets():
"""Return a list of all supported applets"""
applets = os.path.join(TOPDIR, 'applets.sh')
return subprocess.check_output([applets]).decode('ascii').splitlines()
COMMON_AUTHORS = [
'Ned Ludd <solar@gentoo.org>',
'Mike Frysinger <vapier@gentoo.org>',
'Fabian Groffen <grobian@gentoo.org>',
]
TEMPLATE = r""".\" generated by mkman.py, please do NOT edit!
.TH %(applet)s "1" "%(date)s" "Gentoo Foundation" "%(applet)s"
.SH NAME
%(applet)s \- %(short_desc)s
.SH SYNOPSIS
.B %(applet)s
\fI%(usage)s\fR
.SH DESCRIPTION
%(description)s
.SH OPTIONS
%(options)s
%(extra_sections)s
.SH "REPORTING BUGS"
Please report bugs via http://bugs.gentoo.org/
.br
Product: Portage Development; Component: Tools, Assignee:
portage-utils@gentoo.org
.SH AUTHORS
.nf
%(authors)s
.fi
.SH "SEE ALSO"
%(see_also)s
"""
def MkMan(applets, applet, output):
"""Generate a man page for |applet| and write it to |output|"""
print('%-10s: generating %s' % (applet, output))
# Extract the main use string and description:
# Usage: q <applet> <args> : invoke a portage utility applet
ahelp = subprocess.check_output([Q, applet, '--help']).decode('ascii')
lines = ahelp.splitlines()
m = re.search(r'^Usage: %s (.*) : (.*)' % applet, ahelp)
usage = m.group(1)
short_desc = m.group(2)
authors = COMMON_AUTHORS
see_also = sorted(['.BR %s (1)' % x for x in applets if x != applet])
description = ''
desc_file = os.path.join(FRAGS_DIR, '%s.desc' % applet)
if os.path.exists(desc_file):
fh = open(desc_file)
description = fh.read().rstrip()
fh.close()
optdescs = []
desc_file = os.path.join(FRAGS_DIR, '%s.optdesc.yaml' % applet)
if os.path.exists(desc_file):
with open(desc_file) as fh:
optdescs = yaml.load(fh)
# Extract all the options
options = []
for line, i in zip(lines, range(len(lines))):
if not line.startswith('Options: '):
continue
for option in [x.strip().split() for x in lines[i + 1:]]:
flags = [option[0].rstrip(',')]
option.pop(0)
if option[0][0] == '-':
flags += [option[0].rstrip(',')]
option.pop(0)
optdesc = None
for x in flags:
if x.lstrip('-') in optdescs:
optdesc = optdescs[x.lstrip('-')].strip()
if option[0] in ('<arg>', '[arg]'):
flags = [r'\fB%s\fR \fI%s\fR' % (x, option[0]) for x in flags]
option.pop(0)
else:
flags = [r'\fB%s\fR' % x for x in flags]
assert option[0] == '*', 'help line for %s is broken: %r' % (applet, option)
option.pop(0)
if not optdesc:
optdesc = ' '.join(option).rstrip('.') + '.'
options += [
'.TP',
', '.join(flags).replace('-', r'\-'),
optdesc,
]
break
# Handle applets that have applets
extra_sections = []
if 'Currently defined applets:' in ahelp:
alines = lines[lines.index('Currently defined applets:') + 1:]
alines = alines[:alines.index('')]
extra_sections += (
['.SH APPLETS', '.nf',
'.B This applet also has sub applets:'] +
alines +
['.fi']
)
# Handle any fragments this applet has available
for frag in sorted(glob.glob(os.path.join(FRAGS_DIR, '%s-*.include' % applet))):
with open(frag) as f:
if "-authors." in frag:
authors += [x.rstrip() for x in f.readlines()]
else:
extra_sections += [x.rstrip() for x in f.readlines()]
data = {
'applet': applet,
'date': datetime.datetime.now().strftime('%b %Y'),
'short_desc': short_desc,
'usage': usage,
'description': description,
'options': '\n'.join(options),
'extra_sections': '\n'.join(extra_sections),
'authors': '\n'.join(authors),
'see_also': ',\n'.join(see_also),
'rcsid': '',
}
with open(output, 'w') as f:
f.write(TEMPLATE % data)
def _MkMan(applets, applet):
"""Trampoline to MkMan for multiprocessing pickle"""
output = os.path.join(MKMAN_DIR, '%s.1' % applet)
MkMan(applets, applet, output)
def main(argv):
os.environ['NOCOLOR'] = '1'
if not argv:
argv = FindApplets()
# Support file completion like "qfile.1" or "./qdepends.1"
applets = [os.path.basename(x).split('.', 1)[0] for x in argv]
p = multiprocessing.Pool()
functor = functools.partial(_MkMan, applets)
p.map(functor, applets)
if __name__ == '__main__':
sys.exit(main(sys.argv[1:]))
|
GitWeb