From b8e641136ab87265629321ac52e0529cf62cd903 Mon Sep 17 00:00:00 2001 From: Michael Vogt Date: Fri, 1 Nov 2013 09:20:05 +0100 Subject: [PATCH] make comment lines in troff start with .\" and add a .SH EXAMPLES to the PLAINEXAMPLES section --- hacking/templates/man.j2 | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/hacking/templates/man.j2 b/hacking/templates/man.j2 index 90e429742b..6cf51960ae 100644 --- a/hacking/templates/man.j2 +++ b/hacking/templates/man.j2 @@ -1,16 +1,16 @@ .TH ANSIBLE.@{ module | upper }@ 3 "@{ now_date }@" "@{ ansible_version }@" "ANSIBLE MODULES" -." generated from @{ filename }@ +.\" generated from @{ filename }@ .SH NAME @{ module }@ \- @{ short_description }@ -." ------ DESCRIPTION +.\" ------ DESCRIPTION .SH DESCRIPTION {% for desc in description %} .PP @{ desc | jpfunc }@ {% endfor %} -." ------ OPTIONS -." -." +.\" ------ OPTIONS +.\" +.\" {% if options %} .SH OPTIONS {% for k in option_keys %} @@ -30,9 +30,9 @@ {% endif %} {% endfor %} {% endif %} -." -." -." ------ NOTES +.\" +.\" +.\" ------ NOTES {% if notes %} .SH NOTES {% for note in notes %} @@ -40,9 +40,9 @@ @{ note | jpfunc }@ {% endfor %} {% endif %} -." -." -." ------ EXAMPLES +.\" +.\" +.\" ------ EXAMPLES {% if examples is defined %} .SH EXAMPLES {% for e in examples %} @@ -56,14 +56,15 @@ .fi {% endfor %} {% endif %} -." ------ PLAINEXAMPLES +.\" ------ PLAINEXAMPLES {% if plainexamples is defined %} +.SH EXAMPLES .nf @{ plainexamples }@ .fi {% endif %} -." ------- AUTHOR +.\" ------- AUTHOR {% if author is defined %} .SH AUTHOR @{ author }@