2
0
mirror of https://github.com/openvswitch/ovs synced 2025-09-04 00:05:15 +00:00

doc: Reduce duplication in 'man_pages'

All these entries are going to be roughly the same, with only two key
differences. Clarify things by focusing on those differences.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
This commit is contained in:
Stephen Finucane
2017-05-10 21:32:18 -04:00
committed by Ben Pfaff
parent 34d8e04bec
commit f15010f663

View File

@@ -112,11 +112,15 @@ html_static_path = ['_static']
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ _man_pages = [
('ref/ovs-test.8', 'ovs-test', ('ovs-test.8',
u'Check Linux drivers for performance, vlan and L3 tunneling problems', u'Check Linux drivers for performance, vlan and L3 tunneling problems'),
[author], 8), ('ovs-vlan-test.8',
('ref/ovs-vlan-test.8', 'ovs-vlan-test', u'Check Linux drivers for problems with vlan traffic'),
u'Check Linux drivers for problems with vlan traffic',
[author], 8)
] ]
# Generate list of (path, name, description, [author, ...], section)
man_pages = [
('ref/%s' % filename, filename.split('.', 1)[0],
description, [author], filename.split('.', 1)[1])
for filename, description in _man_pages]