From 191a327d9df10b0eca7af5b8a4751e4e78ce69df Mon Sep 17 00:00:00 2001 From: Alex Willmer Date: Wed, 3 Oct 2018 00:21:18 +0100 Subject: [PATCH] docs: Don't redefine links to scp and sftp This addresses an error found while running tox -edocs Warning, treated as error: ./docs/ansible.rst:6:Duplicate explicit target name: "scp(1)". --- docs/ansible.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/ansible.rst b/docs/ansible.rst index 485c24dc..06d4b270 100644 --- a/docs/ansible.rst +++ b/docs/ansible.rst @@ -271,8 +271,7 @@ command line, or as host and group variables. File Transfer ~~~~~~~~~~~~~ -Normally `sftp(1) `_ or -`scp(1) `_ are used to copy files by the +Normally `sftp(1)`_ or `scp(1)`_ are used to copy files by the `assemble `_, `copy `_, `patch `_, @@ -283,6 +282,9 @@ actions, or when uploading modules with pipelining disabled. With Mitogen copies are implemented natively using the same interpreters, connection tree, and routed message bus that carries RPCs. +.. _scp(1): https://linux.die.net/man/1/scp +.. _sftp(1): https://linux.die.net/man/1/sftp + This permits direct streaming between endpoints regardless of execution environment, without necessitating temporary copies in intermediary accounts or machines, for example when ``become`` is active, or in the presence of @@ -302,8 +304,7 @@ to rename over any existing file. This ensures the file remains consistent at all times, in the event of a crash, or when overlapping `ansible-playbook` runs deploy differing file contents. -The `sftp(1) `_ and `scp(1) -`_ tools may cause undetected data corruption +The `sftp(1)`_ and `scp(1)`_ tools may cause undetected data corruption in the form of truncated files, or files containing intermingled data segments from overlapping runs. As part of normal operation, both tools expose a window where readers may observe inconsistent file contents. @@ -423,8 +424,7 @@ Ansible may: * Create a directory owned by the SSH user either under ``remote_tmp``, or a system-default directory, * Upload action dependencies such as non-new style modules or rendered - templates to that directory via `sftp(1) `_ - or `scp(1) `_. + templates to that directory via `sftp(1)`_ or `scp(1)`_. * Attempt to modify the directory's access control list to grant access to the target user using `setfacl(1) `_, requiring that tool to be installed and a supported filesystem to be in use,