[PATCH] fix some doc typos and grammar

[PATCH] fix some doc typos and grammar

[Mike Coleman]

[This is my first patch, which I'm trying via cut-and-paste into
gmail, which I realize sucks.  Any ideas for a better way?  Is anyone
sending patches via gmail+pop?  I gave up my previous shell/email
provider because they just weren't keeping the spam down.  Any
suggestions for something that works?  --Mike]

suggest user manual mention .gitignore

Signed-off-by: Michael Coleman <tutufan@gmail.com>
---
 Documentation/core-tutorial.txt |    6 +++---
 Documentation/user-manual.txt   |    8 +++++---
 2 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/Documentation/core-tutorial.txt b/Documentation/core-tutorial.txt
index 86a9c75..1cd834b 100644
--- a/Documentation/core-tutorial.txt
+++ b/Documentation/core-tutorial.txt
@@ -624,7 +624,7 @@ name for the state at that point.
 Copying repositories
 --------------------

-git repositories are normally totally self-sufficient and relocatable
+git repositories are normally totally self-sufficient and relocatable.
 Unlike CVS, for example, there is no separate notion of
 "repository" and "working tree". A git repository normally *is* the
 working tree, with the local git information hidden in the `.git`
@@ -1118,7 +1118,7 @@ You could do without using any branches at all, by
 keeping as many local repositories as you would like to have
 branches, and merging between them with `git pull`, just like
 you merge between branches. The advantage of this approach is
-that it lets you keep set of files for each `branch` checked
+that it lets you keep a set of files for each `branch` checked
 out and you may find it easier to switch back and forth if you
 juggle multiple lines of development simultaneously. Of
 course, you will pay the price of more disk usage to hold
@@ -1300,7 +1300,7 @@ differences since stage 2 (i.e. your version).
 Publishing your work
 --------------------

-So we can use somebody else's work from a remote repository; but
+So, we can use somebody else's work from a remote repository, but
 how can *you* prepare a repository to let other people pull from
 it?

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index b6916d1..6576625 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -398,7 +398,7 @@ branch name, but this longer name can also be useful.  Most
 importantly, it is a globally unique name for this commit: so if you
 tell somebody else the object name (for example in email), then you are
 guaranteed that name will refer to the same commit in their repository
-that you it does in yours (assuming their repository has that commit at
+that it does in yours (assuming their repository has that commit at
 all).

 Understanding history: commits, parents, and reachability
@@ -617,7 +617,7 @@ the relationships between these snapshots.
 Git provides extremely flexible and fast tools for exploring the
 history of a project.

-We start with one specialized tool which is useful for finding the
+We start with one specialized tool that is useful for finding the
 commit that introduced a bug into a project.

 How to use bisect to find a regression
@@ -1492,7 +1492,7 @@ dangling commit 13472b7c4b80851a1bc551779171dcb03655e9b5
 ...
 -------------------------------------------------

-and watch for output that mentions "dangling commits".  You can examine
+You can examine
 one of those dangling commits with, for example,

 ------------------------------------------------
@@ -2923,6 +2923,8 @@ Think about how to create a clear chapter
dependency graph that will
 allow people to get to important topics without necessarily reading
 everything in between.

+Say something about .gitignore.
+
 Scan Documentation/ for other stuff left out; in particular:
 	howto's
 	some of technical/?
-- 
1.5.0.rc3

Re: [PATCH] fix some doc typos and grammar

[Junio C Hamano]

"Mike Coleman" <tutufan@gmail.com> writes:

> [This is my first patch, which I'm trying via cut-and-paste into
> gmail, which I realize sucks.  Any ideas for a better way?  Is anyone
> sending patches via gmail+pop?  I gave up my previous shell/email
> provider because they just weren't keeping the spam down.  Any
> suggestions for something that works?  --Mike]

It is usually nicer to put this "cover letter" material below
the three dashes after Signed-off-by line; not a huge deal,
though.

I was surprised that, for a patch that came from cut & paste via
gmail, your patch did not have too many whitespace breakages.
There was only one -- this hunk:

> @@ -2923,6 +2923,8 @@ Think about how to create a clear chapter
> dependency graph that will
>  allow people to get to important topics without necessarily reading
>  everything in between.
>...

and after hand-fixing that overflowed hunk header, everything
cleanly applied.

It might help if you did not say:

	Content-Type: text/plain; charset=ISO-8859-1; format=flowed

as "format=flawed" often seem to corrupt patches by wrapping
lines.  This might be fixable just by futzing with your MUA
setting, or maybe gmail sets it and outside of your control; I
do not know which, because I do not use gmail myself.

> @@ -617,7 +617,7 @@ the relationships between these snapshots.
>  Git provides extremely flexible and fast tools for exploring the
>  history of a project.
>
> -We start with one specialized tool which is useful for finding the
> +We start with one specialized tool that is useful for finding the
>  commit that introduced a bug into a project.
>
>  How to use bisect to find a regression

Ah, "which or that", very funny.  At work today I was working
with somebody you know (AB) on a document, and he was fixing my
that to which.  Now you are fixing my which to that.

All the other hunks looked reasonable to me.  Thanks, will
apply, and I'll let others to fight over which and that ;-).

Re: [PATCH] fix some doc typos and grammar

[Mike Coleman]

On 2/2/07, Junio C Hamano <junkio@cox.net> wrote:
> It is usually nicer to put this "cover letter" material below
> the three dashes after Signed-off-by line; not a huge deal,
> though.

I remembered that the three dashes mattered, but I couldn't remember
if it was above or below.

It turns out that it's fairly easy to configure gmail to accept an
SMTP connection.  This recipe shows how to configure ssmtp, which is
just a really dumb sender, to work with gmail:

    http://www.destr0yr.com/article.php/Gmail_and_sSMTP

This makes git-send-email work directly, and avoids the gmail web MUA.

> Ah, "which or that", very funny.  At work today I was working
> with somebody you know (AB) on a document, and he was fixing my
> that to which.  Now you are fixing my which to that.

Amusingly enough, it was PE who taught me the difference between
'that' and 'which' in the first place.  Tell AB that MC says "Hi".
:-)

Mike

Re: [PATCH] fix some doc typos and grammar

[Jakub Narebski]

Mike Coleman wrote:
> On 2/2/07, Junio C Hamano <junkio@cox.net> wrote:

>> It is usually nicer to put this "cover letter" material below
>> the three dashes after Signed-off-by line; not a huge deal,
>> though.
> 
> I remembered that the three dashes mattered, but I couldn't remember
> if it was above or below.
> 
> It turns out that it's fairly easy to configure gmail to accept an
> SMTP connection.  This recipe shows how to configure ssmtp, which is
> just a really dumb sender, to work with gmail:
> 
>     http://www.destr0yr.com/article.php/Gmail_and_sSMTP
> 
> This makes git-send-email work directly, and avoids the gmail web MUA.

It is fairly easy to do the same with sendmail (which is default MTA
for many Linux distributions). I have googled the answer thanks to
some tips on #git channel. You have to change /etc/mail/sendmail.mc
(or the file where SMART_HOST is commented out), add your credentials
to /etc/mail/authinfo, then compile changes using "make -C /etc/mail"
(all of it as root, I think).

Your credential should have the form (in /etc/mail/authinfo)

  AuthInfo:smtp.gmail.com "U:username@gmail.com" "P:password" "M:PLAIN"
  AuthInfo: "U:username@gmail.com" "P:password" "M:PLAIN"

You can store password base64 encoded by using "P=base64pass" instead.
/etc/mail/authinfo should be readable only by sendmail.

Below here are changes I have made in diff form. Most probably only
the first chunk is needed; correct me if I'm wrong, please

--- /etc/mail/sendmail.mc.orig  2005-05-06 14:35:09.000000000 +0200
+++ /etc/mail/sendmail.mc       2006-11-25 17:20:50.000000000 +0100
@@ -19,7 +19,7 @@
 dnl # Uncomment and edit the following line if your outgoing mail needs to
 dnl # be sent out through an external mail server:
 dnl #
-dnl define(`SMART_HOST',`smtp.your.provider')
+define(`SMART_HOST',`[smtp.gmail.com]')
 dnl #
 define(`confDEF_USER_ID',``8:12'')dnl
 dnl define(`confAUTO_REBUILD')dnl
@@ -37,7 +37,7 @@
 dnl # The following allows relaying if the user authenticates, and disallows
 dnl # plaintext authentication (PLAIN/LOGIN) on non-TLS links
 dnl #
-dnl define(`confAUTH_OPTIONS', `A p')dnl
+define(`confAUTH_OPTIONS', `A p')dnl
 dnl # 
 dnl # PLAIN is the preferred plaintext authentication method and used by
 dnl # Mozilla Mail and Evolution, though Outlook Express and other MUAs do
@@ -45,8 +45,8 @@
 dnl # guaranteed secure.
 dnl # Please remember that saslauthd needs to be running for AUTH. 
 dnl #
-dnl TRUST_AUTH_MECH(`EXTERNAL DIGEST-MD5 CRAM-MD5 LOGIN PLAIN')dnl
-dnl define(`confAUTH_MECHANISMS', `EXTERNAL GSSAPI DIGEST-MD5 CRAM-MD5 LOGIN PLAIN')dnl
+TRUST_AUTH_MECH(`EXTERNAL DIGEST-MD5 CRAM-MD5 LOGIN PLAIN')dnl
+define(`confAUTH_MECHANISMS', `EXTERNAL GSSAPI DIGEST-MD5 CRAM-MD5 LOGIN PLAIN')dnl
 dnl #
 dnl # Rudimentary information on creating certificates for sendmail TLS:
 dnl #     cd /usr/share/ssl/certs; make sendmail.pem
@@ -71,6 +71,7 @@
 dnl FEATURE(delay_checks)dnl
 FEATURE(`no_default_msa',`dnl')dnl
 FEATURE(`smrsh',`/usr/sbin/smrsh')dnl
+FEATURE(`authinfo',`hash -o /etc/mail/authinfo.db')dnl
 FEATURE(`mailertable',`hash -o /etc/mail/mailertable.db')dnl
 FEATURE(`virtusertable',`hash -o /etc/mail/virtusertable.db')dnl
 FEATURE(redirect)dnl
@@ -153,7 +154,7 @@
 dnl # The following example makes mail from this host and any additional
 dnl # specified domains appear to be sent from mydomain.com
 dnl #
-dnl MASQUERADE_AS(`mydomain.com')dnl
+MASQUERADE_AS(`gmail.com')dnl
 dnl #
 dnl # masquerade not just the headers, but the envelope as well
 dnl #

Perhaps we should have put those on GitWiki page. Any volunteers?
-- 
Jakub Narebski
Warsaw, Poland
ShadeHawk on #git

How to configure your MTA [Was: [PATCH] fix some doc typos and grammar]

[Uwe Kleine-König]

Hello,

Jakub Narebski wrote:
> > This makes git-send-email work directly, and avoids the gmail web MUA.
> 
> It is fairly easy to do the same with sendmail (which is default MTA
> for many Linux distributions). I have googled the answer thanks to
> some tips on #git channel. You have to change /etc/mail/sendmail.mc
> (or the file where SMART_HOST is commented out), add your credentials
> to /etc/mail/authinfo, then compile changes using "make -C /etc/mail"
> (all of it as root, I think).
> 
> Your credential should have the form (in /etc/mail/authinfo)
> 
>   AuthInfo:smtp.gmail.com "U:username@gmail.com" "P:password" "M:PLAIN"
>   AuthInfo: "U:username@gmail.com" "P:password" "M:PLAIN"
I'd prefer a MTA that is able to do this on a per-user basis.  My wish
is something like procmail, but for sending.  Some time ago I searched
for such an MTA, but unsuccessful.  Does anyone know such a server?

Best regards
Uwe

-- 
Uwe Kleine-König

dd if=/proc/self/exe bs=1 skip=1 count=3 2>/dev/null

Re: [PATCH] fix some doc typos and grammar

[Andy Parkins]

On Friday 2007 February 02 06:44, Junio C Hamano wrote:

> Ah, "which or that", very funny.  At work today I was working
> with somebody you know (AB) on a document, and he was fixing my
> that to which.  Now you are fixing my which to that.

In case anyone is interested; a handy rule of thumb (i.e. it isn't always 
true, but will hold you in good stead) is that "which" should be preceded by 
a comma and "that" should not.  If you write a sentence that requires the 
comma, then it's "which"; if it requires not having a comma, then 
it's "that".

e.g. 

"git is a version control system, which is a piece of software used for 
tracking changes to files over time"

"git is a version control system that has a fanatical following of users who 
will kill anyone who asks for rename support"

In the first case the "which" describes what a version control system is.  In 
the second, the "that" describes what git is.


Andy
-- 
Dr Andy Parkins, M Eng (hons), MIEE
andyparkins@gmail.com