truffle: mxtool/mx.py comparison

comparison mxtool/mx.py @ 15406:ca16edfcecd5

mx: fixed site command by removing brittle post-processing of javadoc output

author	Doug Simon <doug.simon@oracle.com>
date	Mon, 28 Apr 2014 16:22:58 +0200
parents	a9df38ce8fb7
children	7a5c34543493

comparison

equal deleted inserted replaced

-:21204413a6de
+:ca16edfcecd5
 if stdDoclet:
 windowTitle = ['-windowtitle', p.name + ' javadoc']
 try:
 log('Generating {2} for {0} in {1}'.format(p.name, out, docDir))
 projectJava = java(p.javaCompliance)
-run([java().javadoc, memory,
+run([projectJava.javadoc, memory,
 '-XDignore.symbol.file',
 '-classpath', cp,
 '-quiet',
 '-d', out,
 '-overview', overviewFile,
 '-sourcepath', sp,
 '-source', str(projectJava.javaCompliance),
 '-bootclasspath', projectJava.bootclasspath(),
 '-extdirs', projectJava.extdirs()] +
-([] if java().javaCompliance < JavaCompliance('1.8') else ['-Xdoclint:none']) +
+([] if projectJava.javaCompliance < JavaCompliance('1.8') else ['-Xdoclint:none']) +
 links +
 extraArgs +
 nowarnAPI +
 windowTitle +
 list(pkgs))
 extraArgs +
 nowarnAPI +
 list(pkgs))
 log('Generated {2} for {0} in {1}'.format(', '.join(names), out, docDir))
-class Chunk:
-def __init__(self, content, ldelim, rdelim=None):
-lindex = content.find(ldelim)
-if rdelim is not None:
-rindex = content.find(rdelim)
-else:
-rindex = lindex + len(ldelim)
-self.ldelim = ldelim
-self.rdelim = rdelim
-if lindex != -1 and rindex != -1 and rindex > lindex:
-self.text = content[lindex + len(ldelim):rindex]
-else:
-self.text = None
-def replace(self, content, repl):
-lindex = content.find(self.ldelim)
-if self.rdelim is not None:
-rindex = content.find(self.rdelim)
-rdelimLen = len(self.rdelim)
-else:
-rindex = lindex + len(self.ldelim)
-rdelimLen = 0
-old = content[lindex:rindex + rdelimLen]
-return content.replace(old, repl)
-# Post-process an overview-summary.html file to move the
-# complete overview to the top of the page
-def _fix_overview_summary(path, topLink):
-"""
-Processes an "overview-summary.html" generated by javadoc to put the complete
-summary text above the Packages table.
-"""
-# This uses scraping and so will break if the relevant content produced by javadoc changes in any way!
-with open(path) as fp:
-content = fp.read()
-chunk1 = Chunk(content, """<div class="header">
-<div class="subTitle">
-<div class="block">""", """</div>
-</div>
-<p>See: <a href="#overview.description">Description</a></p>
-</div>""")
-chunk2 = Chunk(content, """<div class="contentContainer"><a name="overview.description">
-<!--   -->
-</a>
-<div class="block">""", """</div>
-</div>
-<!-- ======= START OF BOTTOM NAVBAR ====== -->""")
-assert chunk1.text, 'Could not find header section in ' + path
-assert chunk2.text, 'Could not find footer section in ' + path
-content = chunk1.replace(content, '<div class="header"><div class="subTitle"><div class="block">' + topLink + chunk2.text + '</div></div></div>')
-content = chunk2.replace(content, '')
-with open(path, 'w') as fp:
-fp.write(content)
-# Post-process a package-summary.html file to move the
-# complete package description to the top of the page
-def _fix_package_summary(path):
-"""
-Processes an "overview-summary.html" generated by javadoc to put the complete
-summary text above the Packages table.
-"""
-# This uses scraping and so will break if the relevant content produced by javadoc changes in any way!
-with open(path) as fp:
-content = fp.read()
-chunk1 = Chunk(content, """<div class="header">
-<h1 title="Package" class="title">Package""", """<p>See:&nbsp;<a href="#package.description">Description</a></p>
-</div>""")
-chunk2 = Chunk(content, """<a name="package.description">
-<!--   -->
-</a>""", """</div>
-</div>
-<!-- ======= START OF BOTTOM NAVBAR ====== -->""")
-if chunk1.text:
-if chunk2.text:
-repl = re.sub(r'<h2 title=(.*) Description</h2>', r'<h1 title=\1</h1>', chunk2.text, 1)
-content = chunk1.replace(content, '<div class="header">' + repl + '</div></div>')
-content = chunk2.replace(content, '')
-with open(path, 'w') as fp:
-fp.write(content)
-else:
-log('warning: Could not find package description detail section in ' + path)
-else:
-# no package description given
-pass
 def site(args):
 """creates a website containing javadoc and the project dependency graph"""
 parser = ArgumentParser(prog='site')
 parser.add_argument('-d', '--base', action='store', help='directory for generated site', required=True, metavar='<dir>')
+parser.add_argument('--tmp', action='store', help='directory to use for intermediate results', metavar='<dir>')
 parser.add_argument('--name', action='store', help='name of overall documentation', required=True, metavar='<name>')
 parser.add_argument('--overview', action='store', help='path to the overview content for overall documentation', required=True, metavar='<path>')
 parser.add_argument('--projects', action='store', help='comma separated projects to process (omit to process all projects)')
 parser.add_argument('--jd', action='append', help='extra Javadoc arguments (e.g. --jd @-use)', metavar='@<arg>', default=[])
 parser.add_argument('--exclude-packages', action='store', help='comma separated packages to exclude', metavar='<pkgs>')
 parser.add_argument('--dot-output-base', action='store', help='base file name (relative to <dir>/all) for project dependency graph .svg and .jpg files generated by dot (omit to disable dot generation)', metavar='<path>')
 parser.add_argument('--title', action='store', help='value used for -windowtitle and -doctitle javadoc args for overall documentation (default: "<name>")', metavar='<title>')
 args = parser.parse_args(args)
 args.base = os.path.abspath(args.base)
-tmpbase = tempfile.mkdtemp(prefix=basename(args.base) + '.', dir=dirname(args.base))
+tmpbase = args.tmp if args.tmp else  tempfile.mkdtemp(prefix=basename(args.base) + '.', dir=dirname(args.base))
 unified = join(tmpbase, 'all')
 exclude_packages_arg = []
 if args.exclude_packages is not None:
 exclude_packages_arg = ['--exclude-packages', args.exclude_packages]
 javadoc(['--base', tmpbase,
 '--unified',
 '--arg', '@-windowtitle', '--arg', '@' + title,
 '--arg', '@-doctitle', '--arg', '@' + title,
 '--arg', '@-overview', '--arg', '@' + args.overview] + exclude_packages_arg + projects_arg + extra_javadoc_args)
+if exists(unified):
+shutil.rmtree(unified)
 os.rename(join(tmpbase, 'javadoc'), unified)
 # Generate dependency graph with Graphviz
 if args.dot_output_base is not None:
 dotErr = None
 # Create HTML that embeds the svg file in an <object> frame
 with open(html, 'w') as fp:
 print >> fp, '<html><body><object data="{}.svg" type="image/svg+xml"></object></body></html>'.format(args.dot_output_base)
-top = join(tmpbase, 'all', 'overview-summary.html')
-for root, _, files in os.walk(tmpbase):
-for f in files:
-if f == 'overview-summary.html':
-path = join(root, f)
-topLink = ''
-if top != path:
-link = os.path.relpath(join(tmpbase, 'all', 'index.html'), dirname(path))
-topLink = '<p><a href="' + link + '", target="_top"><b>[return to the overall ' + args.name + ' documentation]</b></a></p>'
-_fix_overview_summary(path, topLink)
-elif f == 'package-summary.html':
-path = join(root, f)
-_fix_package_summary(path)
 if exists(args.base):
 shutil.rmtree(args.base)
-shutil.move(tmpbase, args.base)
+if args.tmp:
+shutil.copytree(tmpbase, args.base)
+else:
+shutil.move(tmpbase, args.base)
 print 'Created website - root is ' + join(args.base, 'all', 'index.html')
 finally:
-if exists(tmpbase):
+if not args.tmp and exists(tmpbase):
 shutil.rmtree(tmpbase)
 def _kwArg(kwargs):
 if len(kwargs) > 0:
 return kwargs.pop(0)

Mercurial > hg > truffle

comparison mxtool/mx.py @ 15406:ca16edfcecd5