[PATCH] Escape some tilde characters causing spurious subscripts in documentation

[PATCH] Escape some tilde characters causing spurious subscripts in documentation

[Jason Sewall]

A few unescaped tilde characters were causing long parts of the html
documentation to be formatted as footnotes. This patch fixes them; I
think I found all of them, but no promises.

Signed-off-by: Jason Sewall <jasonsewall@gmail.com>
---
This is my first attempt at actually submitting a patch to the git
list; let me know if this is a reasonably presented patch. It is truly
trivial, but getting those docs cleaned up is important!

 Documentation/git-bundle.txt |    8 ++++----
 Documentation/git-daemon.txt |    2 +-
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index 5051e2b..d89f350 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -61,7 +61,7 @@ unbundle <file>::
 [git-rev-list-args...]::
        A list of arguments, acceptable to git-rev-parse and
        git-rev-list, that specify the specific objects and references
-       to transport.  For example, "master~10..master" causes the
+       to transport.  For example, "master\~10..master" causes the
        current master reference to be packaged along with all objects
        added since its 10th ancestor commit.  There is no explicit
        limit to the number of references and objects that may be
@@ -80,12 +80,12 @@ SPECIFYING REFERENCES

 git-bundle will only package references that are shown by
 git-show-ref: this includes heads, tags, and remote heads.  References
-such as master~1 cannot be packaged, but are perfectly suitable for
+such as master\~1 cannot be packaged, but are perfectly suitable for
 defining the basis.  More than one reference may be packaged, and more
 than one basis can be specified.  The objects packaged are those not
 contained in the union of the given bases.  Each basis can be
-specified explicitly (e.g., ^master~10), or implicitly (e.g.,
-master~10..master, master --since=10.days.ago).
+specified explicitly (e.g., ^master\~10), or implicitly (e.g.,
+master\~10..master, master --since=10.days.ago).

 It is very important that the basis used be held by the destination.
 It is okay to err on the side of conservatism, causing the bundle file
diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt
index 4b30b18..3f9cec5 100644
--- a/Documentation/git-daemon.txt
+++ b/Documentation/git-daemon.txt
@@ -98,7 +98,7 @@ OPTIONS
 	--verbose, thus by default only error conditions will be logged.

 --user-path, --user-path=path::
-	Allow ~user notation to be used in requests.  When
+	Allow \~user notation to be used in requests.  When
 	specified with no parameter, requests to
 	git://host/~alice/foo is taken as a request to access
 	'foo' repository in the home directory of user `alice`.
-- 
1.5.2.1.280.g38570

Re: [PATCH] Escape some tilde characters causing spurious subscripts in documentation

[Johannes Schindelin]

Hi,

On Sat, 23 Jun 2007, Jason Sewall wrote:

> This is my first attempt at actually submitting a patch to the git list; 
> let me know if this is a reasonably presented patch. It is truly 
> trivial, but getting those docs cleaned up is important!

You followed SubmittingPatches really well. Commit message, diffstat and 
the comment between message and diffstat.

Thanks.

> @@ -80,12 +80,12 @@ SPECIFYING REFERENCES
> 
> git-bundle will only package references that are shown by
> git-show-ref: this includes heads, tags, and remote heads.  References
> -such as master~1 cannot be packaged, but are perfectly suitable for
> +such as master\~1 cannot be packaged, but are perfectly suitable for

But you have some whitespace damage, unfortunately. The space at the 
beginning of the lines is missing.

Judging from your email address, I suspect you copied&pasted the patch 
into the web interface, and somehow this mangled the white space.

Can you send it somehow via SMTP?

Ciao,
Dscho