[PATCH 1/2] Documentation/config.txt: document mailinfo.scissor

[PATCH 1/2] Documentation/config.txt: document mailinfo.scissor

[Matthieu Moy]

The variale was documented in git-mailinfo.txt, but not in config.txt.
The detailed documentation is still the one of --scissors in
git-mailinfo.txt, but we give enough information here to let the user
understand what it is about, and to make it easy to find it (e.g.
searching ">8" and "8<" finds it).

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
---
 Documentation/config.txt | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index ae6791d..4a2a078 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1740,6 +1740,13 @@ log.mailmap::
 	If true, makes linkgit:git-log[1], linkgit:git-show[1], and
 	linkgit:git-whatchanged[1] assume `--use-mailmap`.
 
+mailinfo.scissor::
+	If true, makes linkgit:git-mailinfo[1] (and therefore
+	linkgit:git-am[1]) act by default as if the --scissors option
+	was provided on the command-line. When active, this features
+	removes everything from the message body before a scissors
+	line (i.e. consisting mainly of ">8", "8<" and "-").
+
 mailmap.file::
 	The location of an augmenting mailmap file. The default
 	mailmap, located in the root of the repository, is loaded
-- 
2.3.0.157.g79e124b

[PATCH 2/2] Documentation/git-am.txt: mention mailinfo.scissor config variable

[Matthieu Moy]

It was already documented, but the user had to follow the link to
git-mailinfo.txt to find it.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
---
This one may be more controversial. I think it makes sense to apply
it, but I won't fight for it if you think it adds too much noise to
the doc.

 Documentation/git-am.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index f4eea28..1128570 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -52,7 +52,8 @@ OPTIONS
 -c::
 --scissors::
 	Remove everything in body before a scissors line (see
-	linkgit:git-mailinfo[1]).
+	linkgit:git-mailinfo[1]). Can be activated by default using
+	the `mailinfo.scissor` configuration variable.
 
 --no-scissors::
 	Ignore scissors lines (see linkgit:git-mailinfo[1]).
-- 
2.3.0.157.g79e124b

Re: [PATCH 2/2] Documentation/git-am.txt: mention mailinfo.scissor config variable

[Jeff King]

On Fri, Feb 20, 2015 at 11:09:07AM +0100, Matthieu Moy wrote:

> It was already documented, but the user had to follow the link to
> git-mailinfo.txt to find it.
> 
> Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
> ---
> This one may be more controversial. I think it makes sense to apply
> it, but I won't fight for it if you think it adds too much noise to
> the doc.

I recently looked up the option to reply to your other mail, knowing it
existed but forgetting the exact name. It took me several minutes to
find it. I'm in favor of this.

>  --scissors::
>  	Remove everything in body before a scissors line (see
> -	linkgit:git-mailinfo[1]).
> +	linkgit:git-mailinfo[1]). Can be activated by default using
> +	the `mailinfo.scissor` configuration variable.

As in the other patch, "scissors", with a trailing "s".

-Peff

Re: [PATCH 1/2] Documentation/config.txt: document mailinfo.scissor

[Jeff King]

On Fri, Feb 20, 2015 at 11:09:06AM +0100, Matthieu Moy wrote:

> The variale was documented in git-mailinfo.txt, but not in config.txt.

Missing 'b' in variable.

> +mailinfo.scissor::

s/scissor/&s/

-Peff

[PATCH v2 1/2] Documentation/config.txt: document mailinfo.scissor

[Matthieu Moy]

The variable was documented in git-mailinfo.txt, but not in config.txt.
The detailed documentation is still the one of --scissors in
git-mailinfo.txt, but we give enough information here to let the user
understand what it is about, and to make it easy to find it (e.g.
searching ">8" and "8<" finds it).

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
---
Changes since v1 for both patches : typos noted by Peff.

 Documentation/config.txt | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index ae6791d..15f8695 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1740,6 +1740,13 @@ log.mailmap::
 	If true, makes linkgit:git-log[1], linkgit:git-show[1], and
 	linkgit:git-whatchanged[1] assume `--use-mailmap`.
 
+mailinfo.scissors::
+	If true, makes linkgit:git-mailinfo[1] (and therefore
+	linkgit:git-am[1]) act by default as if the --scissors option
+	was provided on the command-line. When active, this features
+	removes everything from the message body before a scissors
+	line (i.e. consisting mainly of ">8", "8<" and "-").
+
 mailmap.file::
 	The location of an augmenting mailmap file. The default
 	mailmap, located in the root of the repository, is loaded
-- 
2.3.0.157.g79e124b

[PATCH v2 2/2] Documentation/git-am.txt: mention mailinfo.scissors config variable

[Matthieu Moy]

It was already documented, but the user had to follow the link to
git-mailinfo.txt to find it.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
---
 Documentation/git-am.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index f4eea28..0d8ba48 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -52,7 +52,8 @@ OPTIONS
 -c::
 --scissors::
 	Remove everything in body before a scissors line (see
-	linkgit:git-mailinfo[1]).
+	linkgit:git-mailinfo[1]). Can be activated by default using
+	the `mailinfo.scissors` configuration variable.
 
 --no-scissors::
 	Ignore scissors lines (see linkgit:git-mailinfo[1]).
-- 
2.3.0.157.g79e124b

Re: [PATCH v2 1/2] Documentation/config.txt: document mailinfo.scissor

[Eric Sunshine]

On Fri, Feb 20, 2015 at 5:29 AM, Matthieu Moy <Matthieu.Moy@imag.fr> wrote:
> Subject: Documentation/config.txt: document mailinfo.scissor
>
> The variable was documented in git-mailinfo.txt, but not in config.txt.
> The detailed documentation is still the one of --scissors in
> git-mailinfo.txt, but we give enough information here to let the user
> understand what it is about, and to make it easy to find it (e.g.
> searching ">8" and "8<" finds it).
>
> Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
> ---
> Changes since v1 for both patches : typos noted by Peff.

The same typo (s/scissor/scissors/) exists in the subjects.

>  Documentation/config.txt | 7 +++++++
>  1 file changed, 7 insertions(+)
>
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index ae6791d..15f8695 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -1740,6 +1740,13 @@ log.mailmap::
>         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
>         linkgit:git-whatchanged[1] assume `--use-mailmap`.
>
> +mailinfo.scissors::
> +       If true, makes linkgit:git-mailinfo[1] (and therefore
> +       linkgit:git-am[1]) act by default as if the --scissors option
> +       was provided on the command-line. When active, this features
> +       removes everything from the message body before a scissors
> +       line (i.e. consisting mainly of ">8", "8<" and "-").
> +
>  mailmap.file::
>         The location of an augmenting mailmap file. The default
>         mailmap, located in the root of the repository, is loaded
> --
> 2.3.0.157.g79e124b

[PATCH v3 1/2] Documentation/config.txt: document mailinfo.scissors

[Matthieu Moy]

The variable was documented in git-mailinfo.txt, but not in config.txt.
The detailed documentation is still the one of --scissors in
git-mailinfo.txt, but we give enough information here to let the user
understand what it is about, and to make it easy to find it (e.g.
searching ">8" and "8<" finds it).

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
---
Hopefully, I'd have fixed all intances of my typo now :-\.

Sorry for the noise.

 Documentation/config.txt | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index ae6791d..15f8695 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1740,6 +1740,13 @@ log.mailmap::
 	If true, makes linkgit:git-log[1], linkgit:git-show[1], and
 	linkgit:git-whatchanged[1] assume `--use-mailmap`.
 
+mailinfo.scissors::
+	If true, makes linkgit:git-mailinfo[1] (and therefore
+	linkgit:git-am[1]) act by default as if the --scissors option
+	was provided on the command-line. When active, this features
+	removes everything from the message body before a scissors
+	line (i.e. consisting mainly of ">8", "8<" and "-").
+
 mailmap.file::
 	The location of an augmenting mailmap file. The default
 	mailmap, located in the root of the repository, is loaded
-- 
2.3.0.157.g79e124b

[PATCH v3 2/2] Documentation/git-am.txt: mention mailinfo.scissors config variable

[Matthieu Moy]

It was already documented, but the user had to follow the link to
git-mailinfo.txt to find it.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
---
 Documentation/git-am.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index f4eea28..0d8ba48 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -52,7 +52,8 @@ OPTIONS
 -c::
 --scissors::
 	Remove everything in body before a scissors line (see
-	linkgit:git-mailinfo[1]).
+	linkgit:git-mailinfo[1]). Can be activated by default using
+	the `mailinfo.scissors` configuration variable.
 
 --no-scissors::
 	Ignore scissors lines (see linkgit:git-mailinfo[1]).
-- 
2.3.0.157.g79e124b