[bug#73055] [PATCH] doc: Explain `git format-patch` revision format

[bug#73055] [PATCH] doc: Explain `git format-patch` revision format

[Ekaitz Zarraga]

* doc/contributing.texi(Sending a Patch Series): Add a note about
`git format-patch` revision format and link to git documentation.

Change-Id: Ie08f85dc19e3804165fb184664b74e85a804d7c4
---
 doc/contributing.texi | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 73f7addbef..d5d63ebdbd 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -2187,6 +2187,18 @@ Sending a Patch Series
       --cover-letter --base=auto
 @end example
 
+@quotation Note
+@code{git format-patch} accepts a wide range of
+@uref{https://git-scm.com/docs/gitrevisions, revision range} specifiers.
+For example, if you are working in a branch, you could select all commits
+in your branch starting at @code{master}.
+
+@example
+$ git format-patch master..@var{MY_BRANCH} -o outgoing \
+      --cover-letter --base=auto
+@end example
+@end quotation
+
 We can now send @emph{just} the cover letter to the
 @email{guix-patches@@gnu.org} address, which will create an issue
 that we can send the rest of the patches to.

base-commit: 7d2ced8d6d9c38327592d312376d59a8c37fc160
-- 
2.45.2

[bug#73055] [PATCH] doc: Explain `git format-patch` revision format

[Maxim Cournoyer]

Hi Ekaitz,

Ekaitz Zarraga <ekaitz@elenq.tech> writes:

> * doc/contributing.texi(Sending a Patch Series): Add a note about
> `git format-patch` revision format and link to git documentation.
>
> Change-Id: Ie08f85dc19e3804165fb184664b74e85a804d7c4
> ---
>  doc/contributing.texi | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
>
> diff --git a/doc/contributing.texi b/doc/contributing.texi
> index 73f7addbef..d5d63ebdbd 100644
> --- a/doc/contributing.texi
> +++ b/doc/contributing.texi
> @@ -2187,6 +2187,18 @@ Sending a Patch Series
>        --cover-letter --base=auto
>  @end example
>  
> +@quotation Note
> +@code{git format-patch} accepts a wide range of
> +@uref{https://git-scm.com/docs/gitrevisions, revision range} specifiers.
> +For example, if you are working in a branch, you could select all commits
> +in your branch starting at @code{master}.
> +
> +@example
> +$ git format-patch master..@var{MY_BRANCH} -o outgoing \
> +      --cover-letter --base=auto

The --base=auto can be dropped since it's part of our default git
config, which is automatically installed for all of our contributors
(c.f.: etc/git/gitconfig) when they build the Guix source.

Otherwise, LGTM, if others think it has enough value to be added.

--
Thanks,
Maxim

[bug#73055] [PATCH] doc: Explain `git format-patch` revision format

[Ekaitz Zarraga]

> The --base=auto can be dropped since it's part of our default git
> config, which is automatically installed for all of our contributors
> (c.f.: etc/git/gitconfig) when they build the Guix source.
> 
> Otherwise, LGTM, if others think it has enough value to be added.
> 
> --
> Thanks,
> Maxim

Hi!

Should we remove the --base=auto from all the examples or only mine?

Thanks!

[bug#73055] [PATCH] doc: Explain `git format-patch` revision format

[Maxim Cournoyer]

Hi Ekaitz,

Ekaitz Zarraga <ekaitz@elenq.tech> writes:

>> The --base=auto can be dropped since it's part of our default git
>> config, which is automatically installed for all of our contributors
>> (c.f.: etc/git/gitconfig) when they build the Guix source.
>> Otherwise, LGTM, if others think it has enough value to be added.
>> --
>> Thanks,
>> Maxim
>
> Hi!
>
> Should we remove the --base=auto from all the examples or only mine?

Your commit shouldn't add it, and as an extra, if you don't mind the
extra scope, another commit removing it from all the existing examples
would be nice.

-- 
Thanks,
Maxim

[bug#73055] [PATCH] doc: contributing: Remove --base=auto

[Ekaitz Zarraga]

* doc/contributing.texi(Sending a Patch Series): Remove --base=auto from
  examples

Change-Id: Idd421f9d6b592d6a314edfaa66404dee4c1b2241
---
 doc/contributing.texi | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index d5d63ebdbd..fe8f4c0113 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -2184,7 +2184,7 @@ Sending a Patch Series
 
 @example
 $ git format-patch -@var{NUMBER_COMMITS} -o outgoing \
-      --cover-letter --base=auto
+      --cover-letter
 @end example
 
 @quotation Note
@@ -2195,7 +2195,7 @@ Sending a Patch Series
 
 @example
 $ git format-patch master..@var{MY_BRANCH} -o outgoing \
-      --cover-letter --base=auto
+      --cover-letter
 @end example
 @end quotation
 

base-commit: 7d2ced8d6d9c38327592d312376d59a8c37fc160
prerequisite-patch-id: c786a06cb219ebf12546f05af46995498bf6b090
-- 
2.45.2

[bug#73055] [PATCH] doc: contributing: Remove --base=auto

[Maxim Cournoyer]

Hi,

Ekaitz Zarraga <ekaitz@elenq.tech> writes:

Reviewed-by: Maxim Cournoyer <maxim.cournoyer@gmail>

-- 
Thanks,
Maxim