From 2d26d1fd71b0b20f21da3a449ee9f9ba79c890fd Mon Sep 17 00:00:00 2001 From: Tim Bielawa Date: Tue, 17 Apr 2012 10:31:29 -0400 Subject: [PATCH] Update %description and auto-add version to manpages Conflicts: docs/man/man1/ansible-playbook.1 docs/man/man1/ansible.1 Update %description --- Makefile | 7 ++++--- ansible.spec | 10 +++++++--- docs/man/.gitignore | 1 + docs/man/man1/ansible-playbook.1 | 15 ++++++++++++--- docs/man/man1/ansible-playbook.1.asciidoc | 2 +- docs/man/man1/ansible.1 | 19 ++++++++++++++----- docs/man/man1/ansible.1.asciidoc | 2 +- 7 files changed, 40 insertions(+), 16 deletions(-) diff --git a/Makefile b/Makefile index 2095cf9ed2d..6de5dd195f5 100644 --- a/Makefile +++ b/Makefile @@ -16,10 +16,10 @@ tests: docs: $(MANPAGES) -%.1: %.1.asciidoc - $(ASCII2MAN) +%.1.asciidoc.gen: %.1.asciidoc ansible.spec + sed "s/%VERSION%/$(RPMVERSION)/" $< > $@ -%.5: %.5.asciidoc +%.1: %.1.asciidoc.gen $(ASCII2MAN) loc: @@ -45,6 +45,7 @@ clean: find . -type f \( -name "*.swp" \) -delete @echo "Cleaning up asciidoc to man transformations and results" find ./docs/man -type f -name "*.xml" -delete + find ./docs/man -type f -name "*.gen" -delete @echo "Cleaning up output from test runs" -rm -rf test/test_data @echo "Cleaning up RPM building stuff" diff --git a/ansible.spec b/ansible.spec index d2a85a0c776..5280eed8c97 100644 --- a/ansible.spec +++ b/ansible.spec @@ -20,9 +20,13 @@ Requires: python-paramiko Requires: python-jinja2 %description -Ansible is a extra-simple tool/API for doing 'parallel remote things' over SSH -executing commands, running "modules", or executing larger 'playbooks' that -can serve as a configuration management or deployment system. + +Ansible is a radically simple model-driven configuration management, +multi-node deployment, and remote task execution system. Ansible works +over SSH and does not require any software or daemons to be installed +on remote nodes. Extension modules can be written in any language and +are transferred to managed machines automatically. + %prep %setup -q diff --git a/docs/man/.gitignore b/docs/man/.gitignore index 6722cd96e78..ceb714c17d9 100644 --- a/docs/man/.gitignore +++ b/docs/man/.gitignore @@ -1 +1,2 @@ *.xml +*.gen diff --git a/docs/man/man1/ansible-playbook.1 b/docs/man/man1/ansible-playbook.1 index 5fb260bb0cd..1642966af37 100644 --- a/docs/man/man1/ansible-playbook.1 +++ b/docs/man/man1/ansible-playbook.1 @@ -1,13 +1,22 @@ '\" t .\" Title: ansible-playbook .\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 04/16/2012 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 04/17/2012 .\" Manual: System administration commands .\" Source: Ansible 0.0.2 .\" Language: English .\" -.TH "ANSIBLE\-PLAYBOOK" "1" "04/16/2012" "Ansible 0\&.0\&.2" "System administration commands" +.TH "ANSIBLE\-PLAYBOOK" "1" "04/17/2012" "Ansible 0\&.0\&.2" "System administration commands" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- diff --git a/docs/man/man1/ansible-playbook.1.asciidoc b/docs/man/man1/ansible-playbook.1.asciidoc index 14d34710e71..1ebb0204f4f 100644 --- a/docs/man/man1/ansible-playbook.1.asciidoc +++ b/docs/man/man1/ansible-playbook.1.asciidoc @@ -2,7 +2,7 @@ ansible-playbook(1) =================== :doctype:manpage :man source: Ansible -:man version: 0.0.2 +:man version: %VERSION% :man manual: System administration commands NAME diff --git a/docs/man/man1/ansible.1 b/docs/man/man1/ansible.1 index 550415ada06..057bad2c7d0 100644 --- a/docs/man/man1/ansible.1 +++ b/docs/man/man1/ansible.1 @@ -1,13 +1,22 @@ '\" t .\" Title: ansible .\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 04/16/2012 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 04/17/2012 .\" Manual: System administration commands .\" Source: Ansible 0.0.2 .\" Language: English .\" -.TH "ANSIBLE" "1" "04/16/2012" "Ansible 0\&.0\&.2" "System administration commands" +.TH "ANSIBLE" "1" "04/17/2012" "Ansible 0\&.0\&.2" "System administration commands" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -25,7 +34,7 @@ ansible \- run a command somewhere else ansible [\-f forks] [\-m module_name] [\-a args] .SH "DESCRIPTION" .sp -\fBAnsible\fR is an extra\-simple tool/framework/API for doing \'remote things\' over SSH\&. +\fBAnsible\fR is an extra\-simple tool/framework/API for doing \*(Aqremote things\*(Aq over SSH\&. .SH "ARGUMENTS" .PP \fBhost\-pattern\fR @@ -63,7 +72,7 @@ to load modules from\&. The default is \fI/usr/share/ansible\fR\&. .RE .PP -\fB\-a\fR \'\fIARGUMENTS\fR\', \fB\-\-args=\fR\'\fIARGUMENTS\fR\' +\fB\-a\fR \*(Aq\fIARGUMENTS\fR\*(Aq, \fB\-\-args=\fR\*(Aq\fIARGUMENTS\fR\*(Aq .RS 4 The \fIARGUMENTS\fR diff --git a/docs/man/man1/ansible.1.asciidoc b/docs/man/man1/ansible.1.asciidoc index a32cbde4534..2e43f64f198 100644 --- a/docs/man/man1/ansible.1.asciidoc +++ b/docs/man/man1/ansible.1.asciidoc @@ -2,7 +2,7 @@ ansible(1) ========= :doctype:manpage :man source: Ansible -:man version: 0.0.2 +:man version: %VERSION% :man manual: System administration commands NAME