Consistency patches for Documentation/
The following 2 patches are rather pedantic, but should be corrected. Sorry if the way I've sent these are wrong :)
threads / patch / 16996
Subject: [PATCH 2/2] Be consistent in switch usage for tar
Consistency patches for Documentation/
The following 2 patches are rather pedantic, but should be corrected. Sorry if the way I've sent these are wrong :)
[PATCH 1/2] Use capitalized names where appropriate
From: Henrik Austad <henrik@austad.us>
The Linux kernel and Emacs are both spelled capitalized
Signed-off-by: Henrik Austad <henrik@austad.us> --- Documentation/gittutorial.txt | 4 ++-- Documentation/user-manual.txt | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-)
Documentation/gittutorial.txt, Documentation/user-manual.txt
diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt index 7892244..458fafd 100644 --- a/Documentation/gittutorial.txt +++ b/Documentation/gittutorial.txt @@ -590,7 +590,7 @@ list. When the history has lines of development that diverged and then merged back together, the order in which 'git-log' presents those commits is meaningless. -Most projects with multiple contributors (such as the linux kernel, +Most projects with multiple contributors (such as the Linux kernel, or git itself) have frequent merges, and 'gitk' does a better job of visualizing their history. For example, @@ -642,7 +642,7 @@ digressions that may be interesting at this point are: * linkgit:git-format-patch[1], linkgit:git-am[1]: These convert series of git commits into emailed patches, and vice versa, - useful for projects such as the linux kernel which rely heavily + useful for projects such as the Linux kernel which rely heavily on emailed patches. * linkgit:git-bisect[1]: When there is a regression in your diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index d4b1e90..5242a7e 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -59,7 +59,7 @@ project in mind, here are some interesting examples: ------------------------------------------------ # git itself (approx. 10MB download): $ git clone git://git.kernel.org/pub/scm/git/git.git - # the linux kernel (approx. 150MB download): + # the Linux kernel (approx. 150MB download): $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git ------------------------------------------------ @@ -1340,7 +1340,7 @@ These will display all commits which exist only on HEAD or on MERGE_HEAD, and which touch an unmerged file. You may also use linkgit:git-mergetool[1], which lets you merge the -unmerged files using external tools such as emacs or kdiff3. +unmerged files using external tools such as Emacs or kdiff3. Each time you resolve the conflicts in a file and update the index:
-- 1.6.1.36.g8430e
From: Henrik Austad <henrik@austad.us>
tar handles switches with and witouth preceding '-', but the documentation should be consistent nonetheless.
Signed-off-by: Henrik Austad <henrik@austad.us> --- Documentation/user-manual.txt | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 5242a7e..19f571a 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1009,7 +1009,7 @@ $ git init If you have some initial content (say, a tarball): ------------------------------------------------- -$ tar -xzvf project.tar.gz +$ tar xzvf project.tar.gz $ cd project $ git init $ git add . # include everything below ./ in the first commit:
-- 1.6.1.36.g8430e
Re: [PATCH 2/2] Be consistent in switch usage for tar
On 16:25 Mon 05 Jan , henrik@austad.us wrote:
> From: Henrik Austad <henrik@austad.us> > > tar handles switches with and witouth preceding '-', but the documentation should be
s/witouth/without
> consistent nonetheless. > > Signed-off-by: Henrik Austad <henrik@austad.us> > --- > Documentation/user-manual.txt | 2 +- > 1 files changed, 1 insertions(+), 1 deletions(-) > > diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt > index 5242a7e..19f571a 100644 > --- a/Documentation/user-manual.txt > +++ b/Documentation/user-manual.txt > @@ -1009,7 +1009,7 @@ $ git init > If you have some initial content (say, a tarball): > > ------------------------------------------------- > -$ tar -xzvf project.tar.gz > +$ tar xzvf project.tar.gz
Btw, tar manpage uses dashed options in usage examples:
tar -xvf foo.tar verbosely extract foo.tar ...
> $ cd project > $ git init > $ git add . # include everything below ./ in the first commit: > -- > 1.6.1.36.g8430e