git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Fix formatting for urls section of fetch, pull, and push manpages
@ 2006-12-31  1:03 Theodore Ts'o
  2006-12-31  4:11 ` [PATCH, UPDATED] " Theodore Tso
  0 siblings, 1 reply; 2+ messages in thread
From: Theodore Ts'o @ 2006-12-31  1:03 UTC (permalink / raw)
  To: git


The line:

[remote "<remote>"]

was getting swallowed up by asciidoc, causing a critical line in the
explanation for how to store the .git/remotes information in .git/config
to go missing from the git-fetch, git-pull, and git-push manpages.  

Put all of the examples into delimited blocks to fix this problem and to
make them look nicer.

Signed-off-by: "Theodore Ts'o" <tytso@mit.edu>
---
 Documentation/urls.txt |   23 ++++++++++++++++-------
 1 files changed, 16 insertions(+), 7 deletions(-)

diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index 670827c..870c950 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt
@@ -40,9 +40,11 @@ In addition to the above, as a short-hand, the name of a
 file in `$GIT_DIR/remotes` directory can be given; the
 named file should be in the following format:
 
-	URL: one of the above URL format
-	Push: <refspec>
-	Pull: <refspec>
+------------
+URL: one of the above URL format
+Push: <refspec>
+Pull: <refspec>
+------------
 
 Then such a short-hand is specified in place of
 <repository> without <refspec> parameters on the command
@@ -54,10 +56,12 @@ be specified for additional branch mappings.
 Or, equivalently, in the `$GIT_DIR/config` (note the use
 of `fetch` instead of `Pull:`):
 
+------------
 [remote "<remote>"]
 	url = <url>
 	push = <refspec>
 	fetch = <refspec>
+------------
 
 The name of a file in `$GIT_DIR/branches` directory can be
 specified as an older notation short-hand; the named
@@ -68,10 +72,15 @@ name of remote head (URL fragment notation).
 without the fragment is equivalent to have this in the
 corresponding file in the `$GIT_DIR/remotes/` directory.
 
-	URL: <url>
-	Pull: refs/heads/master:<remote>
+------------
+URL: <url>
+Pull: refs/heads/master:<remote>
+------------
+
 
 while having `<url>#<head>` is equivalent to
 
-	URL: <url>
-	Pull: refs/heads/<head>:<remote>
+------------
+URL: <url>
+Pull: refs/heads/<head>:<remote>
+------------
-- 
1.5.0.rc0.g1ed48

^ permalink raw reply related	[flat|nested] 2+ messages in thread

* [PATCH, UPDATED] Fix formatting for urls section of fetch, pull, and push manpages
  2006-12-31  1:03 [PATCH] Fix formatting for urls section of fetch, pull, and push manpages Theodore Ts'o
@ 2006-12-31  4:11 ` Theodore Tso
  0 siblings, 0 replies; 2+ messages in thread
From: Theodore Tso @ 2006-12-31  4:11 UTC (permalink / raw)
  To: git

The line:

[remote "<remote>"]

was getting swallowed up by asciidoc, causing a critical line in the
explanation for how to store the .git/remotes information in .git/config
to go missing from the git-fetch, git-pull, and git-push manpages.

Put all of the examples into delimited blocks to fix this problem and to
make them look nicer.

Signed-off-by: "Theodore Ts'o" <tytso@mit.edu>

[Updated to make thee nroff'ed man pages look nicer]

---
 Documentation/urls.txt |   19 +++++++++++++++----
 1 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index 670827c..745f967 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt
@@ -40,10 +40,13 @@ In addition to the above, as a short-hand, the name of a
 file in `$GIT_DIR/remotes` directory can be given; the
 named file should be in the following format:
 
+------------
 	URL: one of the above URL format
 	Push: <refspec>
 	Pull: <refspec>
 
+------------
+
 Then such a short-hand is specified in place of
 <repository> without <refspec> parameters on the command
 line, <refspec> specified on `Push:` lines or `Pull:`
@@ -54,10 +57,13 @@ be specified for additional branch mappings.
 Or, equivalently, in the `$GIT_DIR/config` (note the use
 of `fetch` instead of `Pull:`):
 
-[remote "<remote>"]
-	url = <url>
-	push = <refspec>
-	fetch = <refspec>
+------------
+	[remote "<remote>"]
+		url = <url>
+		push = <refspec>
+		fetch = <refspec>
+
+------------
 
 The name of a file in `$GIT_DIR/branches` directory can be
 specified as an older notation short-hand; the named
@@ -68,10 +74,15 @@ name of remote head (URL fragment notation).
 without the fragment is equivalent to have this in the
 corresponding file in the `$GIT_DIR/remotes/` directory.
 
+------------
 	URL: <url>
 	Pull: refs/heads/master:<remote>
 
+------------
+
 while having `<url>#<head>` is equivalent to
 
+------------
 	URL: <url>
 	Pull: refs/heads/<head>:<remote>
+------------
-- 
1.5.0.rc0.g1d42

^ permalink raw reply related	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2006-12-31 12:37 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2006-12-31  1:03 [PATCH] Fix formatting for urls section of fetch, pull, and push manpages Theodore Ts'o
2006-12-31  4:11 ` [PATCH, UPDATED] " Theodore Tso

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).