903768 - "How to Submit a Patch" / "Using Mercurial" should give an example of correct patch headers

Status: RESOLVED WONTFIX

(Developer Documentation Graveyard :: Mozilla Platform, defect, P5)

Description

[Jens Müller (:tessarakt)]

User Agent: Mozilla/5.0 (X11; Linux x86_64; rv:24.0) Gecko/20130805 Firefox/24.0 (Nightly/Aurora)
Build ID: 20130805004006

Steps to reproduce:

I want to prepare patches, so I need to know how the patch header should look like.

I found https://developer.mozilla.org/en-US/docs/Developer_Guide/How_to_Submit_a_Patch#Creating_a_patch, which points to https://developer.mozilla.org/en-US/docs/Mercurial_FAQ#How_can_I_generate_a_patch_for_somebody_else_to_check-in_for_me.3F

This page says:

> If you don't have commit access yourself, you need to attach your patches to a bug for somebody to check in.  In order to do that, you should make sure that your patch has the following conditions:
> 
> -   It has a correctly formatted author name.
> -   It has a correctly formatted commit message.
> -   It is generated in git style.

but it does not give a simple example how "a correctly formatted author name" and "a correctly formatted commit message". Especially for developers using tools other than Mercurial to produce their patches (in my case: Git and topgit), this makes it hard to produce patches in the correct format. In at least one case, this has lead to me not being listed in a commit as the author.



Expected results:

There should be an example of a correct patch header.

An added bonus might explain or link to an explanation of what makes a patch "git style".

Comment 1

[saicharanreddy.p]

Hi, try this http://mercurial.selenic.com/wiki/MqExtension and it will work for you.

Comment 2

[Eric Shepherd [:sheppy]]

(In reply to saicharanreddy.p from comment #1)
> Hi, try this http://mercurial.selenic.com/wiki/MqExtension and it will work
> for you.

We should still update the documentation appropriately though.

Comment 3

[saicharanreddy.p]

(In reply to  Eric Shepherd from comment #2)
Sir, I am on it and ill try to update the document if I can.

Comment 4

[BMO Automation]

MDN Web Docs' bug reporting has now moved to GitHub. From now on, please file content bugs at https://github.com/mdn/sprints/issues/ and platform bugs at https://github.com/mdn/kuma/issues/.