[PATCH] Documentation: Fix ssh:// URLs in generated documentation
From: Alp Toker <hidden>
Date: 2016-06-15 22:42:33
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Commit c3f17061be95de3498449a548e93883aebff23d6 was causing warnings during doc generation due to bad asciidoc markup. This resulted in "ssh://[user@]host.xz/path/to/repo.git/" being rendered as "host.xz/path/to/repo.git/" in the man pages and html output. This patch converts sections listing URL formats to verbatim. Signed-off-by: Alp Toker <redacted> --- Documentation/urls.txt | 30 ++++++++++++------------------ 1 files changed, 12 insertions(+), 18 deletions(-)
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index 9abec80..a071915 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt@@ -4,33 +4,27 @@ GIT URLS[[URLS]] One of the following notations can be used to name the remote repository: -=============================================================== -- rsync://host.xz/path/to/repo.git/ -- http://host.xz/path/to/repo.git/ -- https://host.xz/path/to/repo.git/ -- git://host.xz/path/to/repo.git/ -- git://host.xz/~user/path/to/repo.git/ -- ssh://[user@]host.xz/path/to/repo.git/ -- ssh://[user@]host.xz/~user/path/to/repo.git/ -- ssh://[user@]host.xz/~/path/to/repo.git -=============================================================== + rsync://host.xz/path/to/repo.git/ + http://host.xz/path/to/repo.git/ + https://host.xz/path/to/repo.git/ + git://host.xz/path/to/repo.git/ + git://host.xz/~user/path/to/repo.git/ + ssh://[user@]host.xz/path/to/repo.git/ + ssh://[user@]host.xz/~user/path/to/repo.git/ + ssh://[user@]host.xz/~/path/to/repo.git SSH Is the default transport protocol and also supports an scp-like syntax. Both syntaxes support username expansion, as does the native git protocol. The following three are identical to the last three above, respectively: -=============================================================== -- host.xz:/path/to/repo.git/ -- host.xz:~user/path/to/repo.git/ -- host.xz:path/to/repo.git -=============================================================== + host.xz:/path/to/repo.git/ + host.xz:~user/path/to/repo.git/ + host.xz:path/to/repo.git To sync with a local directory, use: -=============================================================== -- /path/to/repo.git/ -=============================================================== + /path/to/repo.git/ REMOTES -------
--
1.4.1.g28ec