* [PATCH] Documentation: Fix ssh:// URLs in generated documentation
@ 2006-07-12 21:55 Alp Toker
2006-07-13 4:58 ` Junio C Hamano
0 siblings, 1 reply; 5+ messages in thread
From: Alp Toker @ 2006-07-12 21:55 UTC (permalink / raw)
To: git
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.
It also changes a minor capitalization inconsistency which ended up
appearing in several man pages by inclusion.
Signed-off-by: Alp Toker <alp@atoker.com>
---
Documentation/urls.txt | 34 ++++++++++++++--------------------
1 files changed, 14 insertions(+), 20 deletions(-)
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index 9abec80..2b5a7f8 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
-===============================================================
-
-SSH Is the default transport protocol and also supports an
+ 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.g2fca1
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] Documentation: Fix ssh:// URLs in generated documentation
2006-07-12 21:55 [PATCH] Documentation: Fix ssh:// URLs in generated documentation Alp Toker
@ 2006-07-13 4:58 ` Junio C Hamano
2006-07-13 5:48 ` Alp Toker
0 siblings, 1 reply; 5+ messages in thread
From: Junio C Hamano @ 2006-07-13 4:58 UTC (permalink / raw)
To: Alp Toker; +Cc: git
Alp Toker <alp@atoker.com> writes:
> 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.
I wonder if this is with less formatting impact then.
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index 9abec80..93378d2 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt
@@ -10,9 +10,9 @@ to name the remote repository:
- 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://+++[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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] Documentation: Fix ssh:// URLs in generated documentation
2006-07-13 4:58 ` Junio C Hamano
@ 2006-07-13 5:48 ` Alp Toker
0 siblings, 0 replies; 5+ messages in thread
From: Alp Toker @ 2006-07-13 5:48 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git
Junio C Hamano wrote:
> I wonder if this is with less formatting impact then.
>
> diff --git a/Documentation/urls.txt b/Documentation/urls.txt
> index 9abec80..93378d2 100644
> --- a/Documentation/urls.txt
> +++ b/Documentation/urls.txt
> @@ -10,9 +10,9 @@ to name the remote repository:
> - 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://+++[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
Your call. I almost went that way but decided the more invasive patch
left the source a bit more readable as it didn't need escaping. As long
as the output gets fixed, nobody will be losing sleep over this one.
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH] Documentation: Fix ssh:// URLs in generated documentation
2006-07-14 10:24 [PATCH] Revert "Documentation: Fix ssh://[user@]host.xz URL" Alp Toker
@ 2006-07-14 10:24 ` Alp Toker
2006-07-14 21:46 ` Junio C Hamano
0 siblings, 1 reply; 5+ messages in thread
From: Alp Toker @ 2006-07-14 10:24 UTC (permalink / raw)
To: git; +Cc: junkio
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 <alp@atoker.com>
---
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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] Documentation: Fix ssh:// URLs in generated documentation
2006-07-14 10:24 ` [PATCH] Documentation: Fix ssh:// URLs in generated documentation Alp Toker
@ 2006-07-14 21:46 ` Junio C Hamano
0 siblings, 0 replies; 5+ messages in thread
From: Junio C Hamano @ 2006-07-14 21:46 UTC (permalink / raw)
To: Alp Toker; +Cc: git
Alp Toker <alp@atoker.com> writes:
> Commit c3f17061be95de3498449a548e93883aebff23d6 was causing warnings
> during doc generation due to bad asciidoc markup.
It seems that the '+++' quoting does not seem to work with older asciidoc.
However, I just noticed that what the text talks about is wrong
to begin with (not your fault):
> + 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
So how about something like this instead, until people have up
to date asciidoc?
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index 93378d2..a5519e5 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt
@@ -10,12 +10,12 @@ to name the remote repository:
- 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://host.xz/path/to/repo.git/
+- ssh://host.xz/~user/path/to/repo.git/
+- ssh://host.xz/~/path/to/repo.git
===============================================================
-SSH Is the default transport protocol and also supports an
+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:
@@ -26,6 +26,10 @@ identical to the last three above, respe
- host.xz:path/to/repo.git
===============================================================
+In addition, you can specify the name of the user to log in as
+by saying `ssh://user@host.xz/\...` and `user@host.xz:\...` for
+the SSH protocol.
+
To sync with a local directory, use:
===============================================================
^ permalink raw reply related [flat|nested] 5+ messages in thread
end of thread, other threads:[~2006-07-14 21:46 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2006-07-12 21:55 [PATCH] Documentation: Fix ssh:// URLs in generated documentation Alp Toker
2006-07-13 4:58 ` Junio C Hamano
2006-07-13 5:48 ` Alp Toker
-- strict thread matches above, loose matches on Subject: below --
2006-07-14 10:24 [PATCH] Revert "Documentation: Fix ssh://[user@]host.xz URL" Alp Toker
2006-07-14 10:24 ` [PATCH] Documentation: Fix ssh:// URLs in generated documentation Alp Toker
2006-07-14 21:46 ` Junio C Hamano
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).