From 2f811c40d745a3aca3ee6bcc389f9be62ec19193 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Thu, 2 Jan 2014 17:36:52 -0500 Subject: [PATCH] Basic docsite formatting fixups --- docs/man/man1/ansible-pull.1 | 32 +++++++++++++++++++++++------ docsite/rst/playbooks_variables.rst | 2 +- hacking/templates/rst.j2 | 2 +- library/files/template | 4 ++-- 4 files changed, 30 insertions(+), 10 deletions(-) diff --git a/docs/man/man1/ansible-pull.1 b/docs/man/man1/ansible-pull.1 index 7644751d97c..6d75a3cc5ea 100644 --- a/docs/man/man1/ansible-pull.1 +++ b/docs/man/man1/ansible-pull.1 @@ -1,13 +1,22 @@ '\" t .\" Title: ansible -.\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 11/27/2013 +.\" Author: :doctype:manpage +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 01/02/2014 .\" Manual: System administration commands -.\" Source: Ansible 1.4.1 +.\" Source: Ansible 1.5 .\" Language: English .\" -.TH "ANSIBLE" "1" "11/27/2013" "Ansible 1\&.4\&.1" "System administration commands" +.TH "ANSIBLE" "1" "01/02/2014" "Ansible 1\&.5" "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-pull \- set up a remote copy of ansible on each managed node ansible \-d DEST \-U URL [options] [ ] .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\&. .sp Use ansible\-pull to set up a remote copy of ansible on each managed node, each set to run via cron and update playbook source via a source repository\&. This inverts the default \fBpush\fR architecture of ansible into a \fBpull\fR architecture, which has near\-limitless scaling potential\&. .sp @@ -77,6 +86,11 @@ Purge the checkout after the playbook is run\&. .RS 4 Module used to checkout playbook repository\&. Defaults to git\&. .RE +.PP +\fB\-o\fR, \fB\-\-only\-if\-changed\fR +.RS 4 +Run the playbook only if the repository has changed +.RE .SH "AUTHOR" .sp Ansible was originally written by Michael DeHaan\&. See the AUTHORS file for a complete list of contributors\&. @@ -90,3 +104,9 @@ Ansible is released under the terms of the GPLv3 License\&. \fBansible\fR(1), \fBansible\-playbook\fR(1), \fBansible\-doc\fR(1) .sp Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/ +.SH "AUTHOR" +.PP +\fB:doctype:manpage\fR +.RS 4 +Author. +.RE diff --git a/docsite/rst/playbooks_variables.rst b/docsite/rst/playbooks_variables.rst index 0f84ad4ddf6..693cc0b5a09 100644 --- a/docsite/rst/playbooks_variables.rst +++ b/docsite/rst/playbooks_variables.rst @@ -71,7 +71,7 @@ Variables defined from included files and roles It turns out we've already talked about variables in another place too. -As described in :doc:`intro_roles`, variables can also be included in the playbook via include files, which may or may +As described in :doc:`playbooks_roles`, variables can also be included in the playbook via include files, which may or may not be part of an "Ansible Role". Usage of roles is preferred as it provides a nice organizational system. .. _about_jinja2: diff --git a/hacking/templates/rst.j2 b/hacking/templates/rst.j2 index 2fa43488461..5c393144764 100644 --- a/hacking/templates/rst.j2 +++ b/hacking/templates/rst.j2 @@ -95,7 +95,7 @@ Examples :: -@{ plainexamples | escape | indent(4, True) }@ +@{ plainexamples | indent(4, True) }@ {% endif %} {% endif %} diff --git a/library/files/template b/library/files/template index ccc6bafadc0..5f64b6d9e60 100644 --- a/library/files/template +++ b/library/files/template @@ -47,11 +47,11 @@ options: - all arguments accepted by the M(file) module also work here required: false notes: - - Since Ansible version 0.9, templates are loaded with C(trim_blocks=True). + - "Since Ansible version 0.9, templates are loaded with C(trim_blocks=True)." - "Also, you can override jinja2 settings by adding a special header to template file. i.e. C(#jinja2:variable_start_string:'[%' , variable_end_string:'%]') - which changes the variable interpolation markers to [% var %] instead of {{ var }}." This is the best way to prevent evaluation of things that look like, but should not be Jinja2. raw/endraw in Jinja2 will not work as you expect because templates in Ansible are recursively evaluated. + which changes the variable interpolation markers to [% var %] instead of {{ var }}. This is the best way to prevent evaluation of things that look like, but should not be Jinja2. raw/endraw in Jinja2 will not work as you expect because templates in Ansible are recursively evaluated." requirements: [] author: Michael DeHaan