threads / patch / 35833

patch, 4 partsdocs/merge-strategies: remove hyphen from mis-merges

Subject: [PATCH 1/4] docs/merge-strategies: remove hyphen from mis-merges

## tl;dr

7 messages between Feb 8, 2014 and Feb 11, 2014. Diffs are folded; open one to read it.

replies: 6people: 2as markdown or json

Albert L. Lash, IV· Feb 8, 2014, 20:41 UTC · lore

The term mismerges without hyphen is used a few other places in the documentation. Let's update this to be consistent.

Signed-off-by: Albert L. Lash, IV <alash3@bloomberg.net>
---
 Documentation/merge-strategies.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/merge-strategies.txt +1 −1
diff --git a/Documentation/merge-strategies.txt b/Documentation/merge-strategies.txt
index fb6e593..3509498 100644
--- a/Documentation/merge-strategies.txt
+++ b/Documentation/merge-strategies.txt
@@ -20,7 +20,7 @@ recursive::
 	merged tree of the common ancestors and uses that as
 	the reference tree for the 3-way merge.  This has been
 	reported to result in fewer merge conflicts without
-	causing mis-merges by tests done on actual merge commits
+	causing mismerges by tests done on actual merge commits
 	taken from Linux 2.6 kernel development history.
 	Additionally this can detect and handle merges involving
 	renames.  This is the default merge strategy when

-- 
1.8.3.2
Albert L. Lash, IV· Feb 8, 2014, 20:41 UTC · re: Albert L. Lash, IV · lore

[PATCH 2/4] docs/git-remote: capitalize first word of initial blurb

All other man files have capitalized descriptions which immediately follow the command's name. Let's capitalize this one too for consistency.

Signed-off-by: Albert L. Lash, IV <alash3@bloomberg.net>
---
 Documentation/git-remote.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/git-remote.txt +1 −1
diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index 2507c8b..cb103c8 100644
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -3,7 +3,7 @@ git-remote(1)
 
 NAME
 ----
-git-remote - manage set of tracked repositories
+git-remote - Manage set of tracked repositories
 
 
 SYNOPSIS

-- 
1.8.3.2
Albert L. Lash, IV· Feb 8, 2014, 20:41 UTC · re: Albert L. Lash, IV · lore

[PATCH 3/4] docs/git-clone: clarify use of --no-hardlinks option

Current text claims optimization, implying the use of hardlinks, when this option ratchets down the level of efficiency. This change explains the difference made by using this option, namely copying instead of hardlinking, and why it may be useful.

Signed-off-by: Albert L. Lash, IV <alash3@bloomberg.net>
---
 Documentation/git-clone.txt | 11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)
Show changes to Documentation/git-clone.txt +4 −7
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index bf3dac0..0363d00 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -55,15 +55,12 @@ repository is specified as a URL, then this flag is ignored (and we
 never use the local optimizations).  Specifying `--no-local` will
 override the default when `/path/to/repo` is given, using the regular
 Git transport instead.
-+
-To force copying instead of hardlinking (which may be desirable if you
-are trying to make a back-up of your repository), but still avoid the
-usual "Git aware" transport mechanism, `--no-hardlinks` can be used.
 
 --no-hardlinks::
-	Optimize the cloning process from a repository on a
-	local filesystem by copying files under `.git/objects`
-	directory.
+	Force the cloning process from a repository on a local
+	filesystem to copy the files under the `.git/objects`
+	directory instead of using hardlinks. This may be desirable
+	if you are trying to make a back-up of your repository.
 
 --shared::
 -s::

-- 
1.8.3.2
Junio C Hamano· Feb 11, 2014, 00:20 UTC · re: Albert L. Lash, IV · lore

Re: [PATCH 3/4] docs/git-clone: clarify use of --no-hardlinks option

"Albert L. Lash, IV" <albert.lash@gmail.com> writes:
Show 32 quoted lines
> Current text claims optimization, implying the use of
> hardlinks, when this option ratchets down the level of
> efficiency. This change explains the difference made by
> using this option, namely copying instead of hardlinking,
> and why it may be useful.
>
> Signed-off-by: Albert L. Lash, IV <alash3@bloomberg.net>
> ---
>  Documentation/git-clone.txt | 11 ++++-------
>  1 file changed, 4 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
> index bf3dac0..0363d00 100644
> --- a/Documentation/git-clone.txt
> +++ b/Documentation/git-clone.txt
> @@ -55,15 +55,12 @@ repository is specified as a URL, then this flag is ignored (and we
>  never use the local optimizations).  Specifying `--no-local` will
>  override the default when `/path/to/repo` is given, using the regular
>  Git transport instead.
> -+
> -To force copying instead of hardlinking (which may be desirable if you
> -are trying to make a back-up of your repository), but still avoid the
> -usual "Git aware" transport mechanism, `--no-hardlinks` can be used.
>  
>  --no-hardlinks::
> -	Optimize the cloning process from a repository on a
> -	local filesystem by copying files under `.git/objects`
> -	directory.
> +	Force the cloning process from a repository on a local
> +	filesystem to copy the files under the `.git/objects`
> +	directory instead of using hardlinks. This may be desirable
> +	if you are trying to make a back-up of your repository.

Makes sense, and it is kind of embarrassing (I have to suspect that this was originally the description of "--hardlinks" option).

[PATCH {1,2}/4] looked trivially correct, too.
Thanks.
Albert L. Lash, IV· Feb 8, 2014, 20:41 UTC · re: Albert L. Lash, IV · lore

[PATCH 4/4] docs/git-blame: explain more clearly the example pickaxe use

We state that the following paragraph mentions the pickaxe interface, but the term pickaxe is not then used. This change clarifies that the example command uses the pickaxe interface and what it is searching for.

Signed-off-by: Albert L. Lash, IV <alash3@bloomberg.net>
---
 Documentation/git-blame.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
Show changes to Documentation/git-blame.txt +2 −1
diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt
index 8e70a61..ddb88d0 100644
--- a/Documentation/git-blame.txt
+++ b/Documentation/git-blame.txt
@@ -35,7 +35,8 @@ Apart from supporting file annotation, Git also supports searching the
 development history for when a code snippet occurred in a change. This makes it
 possible to track when a code snippet was added to a file, moved or copied
 between files, and eventually deleted or replaced. It works by searching for
-a text string in the diff. A small example:
+a text string in the diff. A small example of the pickaxe interface 
+that searches for `blame_usage`:
 
 -----------------------------------------------------------------------------
 $ git log --pretty=oneline -S'blame_usage'

-- 
1.8.3.2
Junio C Hamano· Feb 11, 2014, 00:21 UTC · re: Albert L. Lash, IV · lore

Re: [PATCH 4/4] docs/git-blame: explain more clearly the example pickaxe use

"Albert L. Lash, IV" <albert.lash@gmail.com> writes:
Show 24 quoted lines
> We state that the following paragraph mentions the pickaxe
> interface, but the term pickaxe is not then used. This
> change clarifies that the example command uses the pickaxe
> interface and what it is searching for.
>
> Signed-off-by: Albert L. Lash, IV <alash3@bloomberg.net>
> ---
>  Documentation/git-blame.txt | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt
> index 8e70a61..ddb88d0 100644
> --- a/Documentation/git-blame.txt
> +++ b/Documentation/git-blame.txt
> @@ -35,7 +35,8 @@ Apart from supporting file annotation, Git also supports searching the
>  development history for when a code snippet occurred in a change. This makes it
>  possible to track when a code snippet was added to a file, moved or copied
>  between files, and eventually deleted or replaced. It works by searching for
> -a text string in the diff. A small example:
> +a text string in the diff. A small example of the pickaxe interface 
> +that searches for `blame_usage`:
>  
>  -----------------------------------------------------------------------------
>  $ git log --pretty=oneline -S'blame_usage'
Thanks.

I cannot shake this nagging feeling that this and the latter half of the previous paragraph may not belong to this page, though.

Will queue.

← back to recent threads