threads / patch / 32487

v2, 2 partsAdd MAINTAINERS file and clarify gui workflows

Subject: [PATCH v2 0/2] Add MAINTAINERS file and clarify gui workflows

## tl;dr

5 messages between Dec 31, 2012 and Dec 31, 2012. Diffs are folded; open one to read it.

replies: 4people: 3as markdown or json

Jason Holden· Dec 31, 2012, 22:19 UTC · lore

Changes since the initial version:
-Added git-po to the MAINTAINERS file and generalized wording that had been
 gui-specific
-Fixup some trailing whitespace warnings

Jason Holden (2):
  Add top-level maintainers file with email/canonical repository
    information
  Provide better guidance for submitting patches against upstream
    utilities

 Documentation/SubmittingPatches | 11 +++++++++++
 MAINTAINERS                     | 21 +++++++++++++++++++++
 2 files changed, 32 insertions(+)
 create mode 100644 MAINTAINERS

-- 
1.8.1.rc3.28.g0ab5d1f

Jason Holden· Dec 31, 2012, 22:19 UTC · re: Jason Holden · lore

[PATCH v2 1/2] Add top-level maintainers file with email/canonical repository information

Certain parts of git have a semi-formalized workflow for incoming patches. This file documents the maintainers, their area of specialization, their email address, and their canonical repository against which patches should be submitted.

Signed-off-by: Jason Holden <jason.k.holden.swdev@gmail.com>
---
 MAINTAINERS | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 MAINTAINERS

Show changes to MAINTAINERS +21 −0

diff --git a/MAINTAINERS b/MAINTAINERS
new file mode 100644
index 0000000..c3a96b4
--- /dev/null
+++ b/MAINTAINERS
@@ -0,0 +1,21 @@
+Core Git/Overall Maintainer:
+ Junio C Hamano <gitster@pobox.com>
+ git://git.kernel.org/pub/scm/git/git.git
+
+
+Certain utilities packaged with git (git-gui, gitk, and git-po) are maintained
+upstream of the core git repository.  Their contact information
+and canonical repositories are below.  Patches to improve these utilities
+should be made against the tree's referenced below
+
+gitk:
+ Paul Mackerras <paulus@samba.org>
+ git://ozlabs.org/~paulus/gitk
+
+git-gui:
+ Pat Thoyts <patthoyts@users.sourceforge.net>
+ git://repo.or.cz/git-gui
+
+git-po:
+ Jiang Xin <worldhello.net@gmail.com>
+ https://github.com/git-l10n/git-po/

-- 
1.8.1.rc3.28.g0ab5d1f

Jacob Helwig· Dec 31, 2012, 22:25 UTC · re: Jason Holden · lore

Re: [PATCH v2 1/2] Add top-level maintainers file with email/canonical repository information

One minor grammar nit below.

On Mon, Dec 31, 2012 at 2:19 PM, Jason Holden <jason.k.holden.swdev@gmail.com> wrote:

Show 26 quoted lines

> Certain parts of git have a semi-formalized workflow for
> incoming patches.  This file documents the maintainers, their area of
> specialization, their email address, and their canonical repository against
> which patches should be submitted.
>
> Signed-off-by: Jason Holden <jason.k.holden.swdev@gmail.com>
> ---
>  MAINTAINERS | 21 +++++++++++++++++++++
>  1 file changed, 21 insertions(+)
>  create mode 100644 MAINTAINERS
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> new file mode 100644
> index 0000000..c3a96b4
> --- /dev/null
> +++ b/MAINTAINERS
> @@ -0,0 +1,21 @@
> +Core Git/Overall Maintainer:
> + Junio C Hamano <gitster@pobox.com>
> + git://git.kernel.org/pub/scm/git/git.git
> +
> +
> +Certain utilities packaged with git (git-gui, gitk, and git-po) are maintained
> +upstream of the core git repository.  Their contact information
> +and canonical repositories are below.  Patches to improve these utilities
> +should be made against the tree's referenced below

Should be "trees", not "tree's" (plural vs. possessive/contraction).

Show 15 quoted lines

> +
> +gitk:
> + Paul Mackerras <paulus@samba.org>
> + git://ozlabs.org/~paulus/gitk
> +
> +git-gui:
> + Pat Thoyts <patthoyts@users.sourceforge.net>
> + git://repo.or.cz/git-gui
> +
> +git-po:
> + Jiang Xin <worldhello.net@gmail.com>
> + https://github.com/git-l10n/git-po/
> --
> 1.8.1.rc3.28.g0ab5d1f
>

-- 
Jacob Helwig
http://technosorcery.net/about/me

Jason Holden· Dec 31, 2012, 22:19 UTC · re: Jason Holden · lore

[PATCH v2 2/2] Provide better guidance for submitting patches against upstream utilities

git-gui, gitk, and git-po are maintained upstream of git. Document this, and the procedure for submitting patches to these tools

Signed-off-by: Jason Holden <jason.k.holden.swdev@gmail.com>
---
 Documentation/SubmittingPatches | 11 +++++++++++
 1 file changed, 11 insertions(+)

Show changes to Documentation/SubmittingPatches +11 −0

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 75935d5..30b95a8 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -58,6 +58,17 @@ Checklist (and a short version for the impatient):
 	  please test it first by sending email to yourself.
 	- see below for instructions specific to your mailer
 
+	Improving upstream utilities (gitk, git-gui, git-po)
+	- gitk, git-gui, and git-po are maintained upstream of Git
+	  despite being included in Git's git repository
+	- Patches should be made against the upstream gui repository,
+	  and not against the version in Git's git repository
+	- The resulting patch should still be emailed for review
+	  to the git mailing list (git@vger.kernel.org), cc'ing the
+	  applicable gui maintainer
+	- Please see the MAINTAINER's file for the gui maintainer's contact
+	  information and canonical repository location
+
 Long version:
 
 I started reading over the SubmittingPatches document for Linux

-- 
1.8.1.rc3.28.g0ab5d1f

Junio C Hamano· Dec 31, 2012, 23:39 UTC · re: Jason Holden · lore

Re: [PATCH v2 2/2] Provide better guidance for submitting patches against upstream utilities

Jason Holden <jason.k.holden.swdev@gmail.com> writes:

Show 20 quoted lines

> git-gui, gitk, and git-po are maintained upstream of git.
> Document this, and the procedure for submitting patches to these tools
>
> Signed-off-by: Jason Holden <jason.k.holden.swdev@gmail.com>
> ---
>  Documentation/SubmittingPatches | 11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> index 75935d5..30b95a8 100644
> --- a/Documentation/SubmittingPatches
> +++ b/Documentation/SubmittingPatches
> @@ -58,6 +58,17 @@ Checklist (and a short version for the impatient):
>  	  please test it first by sending email to yourself.
>  	- see below for instructions specific to your mailer
>  
> +	Improving upstream utilities (gitk, git-gui, git-po)
> +	- gitk, git-gui, and git-po are maintained upstream of Git
> +	  despite being included in Git's git repository
> +	- Patches should be made against the upstream gui repository,

GUI?

Show 5 quoted lines

> +	  and not against the version in Git's git repository
> +	- The resulting patch should still be emailed for review
> +	  to the git mailing list (git@vger.kernel.org), cc'ing the
> +	  applicable gui maintainer
> +	- Please see the MAINTAINER's file for the gui maintainer's contact

GUI?

Perhaps "parts with sub-maintainers' with their own repositories".

In any case, I think it is probably much better not to add a new file at the top of the tree only to hold twenty-or-so lines. Instead, add the contents as a footnote to this file and refer to it from here.