diff mbox

[ovs-dev,RFC,1/2] doc: Reduce duplication in 'man_pages'

Message ID 20170511013219.28254-1-stephen@that.guru
State Accepted
Headers show

Commit Message

Stephen Finucane May 11, 2017, 1:32 a.m. UTC 
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>
---
 Documentation/conf.py | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

Comments

Ben Pfaff May 18, 2017, 10:49 p.m. UTC | #1 
On Wed, May 10, 2017 at 09:32:18PM -0400, Stephen Finucane wrote:
> 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>

Fair enough!  Thanks, I applied this to master.
diff mbox

Patch

diff --git a/Documentation/conf.py b/Documentation/conf.py
index 6555747..d70ee6b 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -112,11 +112,15 @@  html_static_path = ['_static']
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('ref/ovs-test.8', 'ovs-test',
-     u'Check Linux drivers for performance, vlan and L3 tunneling problems',
-     [author], 8),
-    ('ref/ovs-vlan-test.8', 'ovs-vlan-test',
-     u'Check Linux drivers for problems with vlan traffic',
-     [author], 8)
+_man_pages = [
+    ('ovs-test.8',
+     u'Check Linux drivers for performance, vlan and L3 tunneling problems'),
+    ('ovs-vlan-test.8',
+     u'Check Linux drivers for problems with vlan traffic'),
 ]
+
+# 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]