Re: [PATCH] describe how to override Author
Robert Pluim writes: >> On Thu, 30 Jun 2022 21:19:36 +0800, Ihor Radchenko >> said: > > Ihor> Robert Pluim writes: > >> >> Occasional committers would probably not read org-maintenance.org, > and > >> >> those are the people this section is aimed at, I think. Plus itʼs > the > >> >> kind of thing you need to catch early: once the commit has been > pushed > >> >> itʼs too late. > >> > Ihor> Not really. org-contribute.org is the page directly linked from > Ihor> orgmode.org. It is aiming for new contributors with no write access. > >> > >> This particular change is in "Your first commit as an Org > >> maintainer". Perhaps that node should be moved to org-maintenance.org? > > Ihor> I do not think so. I am seeing this section as a "crash course" for > the > Ihor> new maintainers. We should only provide the critical information > there. > Ihor> Not too much, not too less. Something to not scare people with the > Ihor> details. > > I guess we disagree about whether knowing about the distinction > between 'Author:' and 'Commit:' is critical or not. For a free > software project correct attribution of changes is very important, so > committers should pay attention to it (and by extension the > documentation should educate them about it at the earliest > opportunity). But youʼre the maintainer :-) Maybe we are mis-communicating here. AFAIU, carefully checking Author: and Commit: is only relevant when applying commits made by people without commit access. Same goes for checking the copyright status of the patch authors. Occasional committers do not usually apply patches made by others. > Ihor> The elaborate details should be in org-maintenance.org, which is > Ihor> directly mentioned at the end of the "first commit" section. > > In "Where can I track bugs, patches and updates?" or somewhere else? I think that "Copyright assignments" is suitable. "keep track of copyright assignments" includes checking the copyright status of the patch authors. > BTW, Iʼm having trouble parsing this sentence from there: > > You don't much more: confirming bugs is a critical contribution. > > Thereʼs at least one word missing betweeen "donʼt" and "much" there. Fixed. Should be "You don't need to do much more: confirming bugs is a critical contribution." Best, Ihor
Re: [PATCH] describe how to override Author
> On Thu, 30 Jun 2022 21:19:36 +0800, Ihor Radchenko > said: Ihor> Robert Pluim writes: >> >> Occasional committers would probably not read org-maintenance.org, and >> >> those are the people this section is aimed at, I think. Plus itʼs the >> >> kind of thing you need to catch early: once the commit has been pushed >> >> itʼs too late. >> Ihor> Not really. org-contribute.org is the page directly linked from Ihor> orgmode.org. It is aiming for new contributors with no write access. >> >> This particular change is in "Your first commit as an Org >> maintainer". Perhaps that node should be moved to org-maintenance.org? Ihor> I do not think so. I am seeing this section as a "crash course" for the Ihor> new maintainers. We should only provide the critical information there. Ihor> Not too much, not too less. Something to not scare people with the Ihor> details. I guess we disagree about whether knowing about the distinction between 'Author:' and 'Commit:' is critical or not. For a free software project correct attribution of changes is very important, so committers should pay attention to it (and by extension the documentation should educate them about it at the earliest opportunity). But youʼre the maintainer :-) Ihor> The elaborate details should be in org-maintenance.org, which is Ihor> directly mentioned at the end of the "first commit" section. In "Where can I track bugs, patches and updates?" or somewhere else? BTW, Iʼm having trouble parsing this sentence from there: You don't much more: confirming bugs is a critical contribution. Thereʼs at least one word missing betweeen "donʼt" and "much" there. Robert --
Re: [PATCH] describe how to override Author
Robert Pluim writes: > >> Occasional committers would probably not read org-maintenance.org, and > >> those are the people this section is aimed at, I think. Plus itʼs the > >> kind of thing you need to catch early: once the commit has been pushed > >> itʼs too late. > > Ihor> Not really. org-contribute.org is the page directly linked from > Ihor> orgmode.org. It is aiming for new contributors with no write access. > > This particular change is in "Your first commit as an Org > maintainer". Perhaps that node should be moved to org-maintenance.org? I do not think so. I am seeing this section as a "crash course" for the new maintainers. We should only provide the critical information there. Not too much, not too less. Something to not scare people with the details. The elaborate details should be in org-maintenance.org, which is directly mentioned at the end of the "first commit" section. Best, Ihor
Re: [PATCH] describe how to override Author
> On Wed, 29 Jun 2022 18:10:00 +0800, Ihor Radchenko > said: Ihor> Robert Pluim writes: >> Iʼd be worried if the org maintainer(s) didnʼt know how to override >> Author :-) Ihor> I have bad news for you... Simply because I never ever had a need to do Ihor> it :) Not like selecting this option from Magit dispatch is difficult. But you were at least aware that it was possible :-) >> Occasional committers would probably not read org-maintenance.org, and >> those are the people this section is aimed at, I think. Plus itʼs the >> kind of thing you need to catch early: once the commit has been pushed >> itʼs too late. Ihor> Not really. org-contribute.org is the page directly linked from Ihor> orgmode.org. It is aiming for new contributors with no write access. This particular change is in "Your first commit as an Org maintainer". Perhaps that node should be moved to org-maintenance.org? Ihor> More elaborate things like backwards compatibility, copyright process Ihor> assistance, etc are documented in org-maintenance.org. Ihor> Modifying submitted diffs/patches appears to lay within the more Ihor> elaborate category IMHO. Ihor> I guess that you intended to attach the updated patch, but haven't? No, since weʼre still discussing where it should go. Robert --
Re: [PATCH] describe how to override Author
Robert Pluim writes:
>> On Mon, 27 Jun 2022 17:53:30 +0800, Ihor Radchenko
>> said:
>
> Ihor> Robert Pluim writes:
> >> diff --git a/org-contribute.org b/org-contribute.org
>
> Ihor> Maybe add the details to org-maintenance.org instead?
> Ihor> This is more of a technical detail needed for maintainers, not for
> the
> Ihor> committers.
>
> Iʼd be worried if the org maintainer(s) didnʼt know how to override
> Author :-)
I have bad news for you... Simply because I never ever had a need to do
it :) Not like selecting this option from Magit dispatch is difficult.
> Occasional committers would probably not read org-maintenance.org, and
> those are the people this section is aimed at, I think. Plus itʼs the
> kind of thing you need to catch early: once the commit has been pushed
> itʼs too late.
Not really. org-contribute.org is the page directly linked from
orgmode.org. It is aiming for new contributors with no write access.
More elaborate things like backwards compatibility, copyright process
assistance, etc are documented in org-maintenance.org.
Modifying submitted diffs/patches appears to lay within the more
elaborate category IMHO.
> >> +1. Command line: src_sh{git commit --author='First Last
> '}
>
> Ihor> I think we usually prefer source blocks to inline source blocks.
>
> OK, changed.
>
> >> +2. =VC=: Set the 'Author:' field in log-edit mode (requires setting
> >> + `log-edit-setup-add-author').
>
> Ihor> 'Author:' -> =Author:=
> Ihor> `log-edit-setup-add-author' -> ~log-edit-setup-add-author~
>
> OK, changed.
I guess that you intended to attach the updated patch, but haven't?
Best,
Ihor
Re: [PATCH] describe how to override Author
> On Mon, 27 Jun 2022 17:53:30 +0800, Ihor Radchenko
> said:
Ihor> Robert Pluim writes:
>> diff --git a/org-contribute.org b/org-contribute.org
Ihor> Maybe add the details to org-maintenance.org instead?
Ihor> This is more of a technical detail needed for maintainers, not for the
Ihor> committers.
Iʼd be worried if the org maintainer(s) didnʼt know how to override
Author :-)
Occasional committers would probably not read org-maintenance.org, and
those are the people this section is aimed at, I think. Plus itʼs the
kind of thing you need to catch early: once the commit has been pushed
itʼs too late.
>> +1. Command line: src_sh{git commit --author='First Last
'}
Ihor> I think we usually prefer source blocks to inline source blocks.
OK, changed.
>> +2. =VC=: Set the 'Author:' field in log-edit mode (requires setting
>> + `log-edit-setup-add-author').
Ihor> 'Author:' -> =Author:=
Ihor> `log-edit-setup-add-author' -> ~log-edit-setup-add-author~
OK, changed.
Robert
--
Re: [PATCH] describe how to override Author
Robert Pluim writes:
> diff --git a/org-contribute.org b/org-contribute.org
Maybe add the details to org-maintenance.org instead?
This is more of a technical detail needed for maintainers, not for the
committers.
> +1. Command line: src_sh{git commit --author='First Last
> '}
I think we usually prefer source blocks to inline source blocks.
> +2. =VC=: Set the 'Author:' field in log-edit mode (requires setting
> + `log-edit-setup-add-author').
'Author:' -> =Author:=
`log-edit-setup-add-author' -> ~log-edit-setup-add-author~
Best,
Ihor
Re: [PATCH] describe how to override Author
Robert Pluim [2022-06-26 Sun 15:47] wrote: > Something like this? (I hope Iʼve got the syntax right, I seldom write > org for exporting purposes). The emacs CONTRIBUTE guidelines talk > about setting 'Author', but I guess not everyone reads those... > +When applying patches written by other people, please ensure that the > +=Author= information of the resulting commit(s) is correct. When > +applying patches created with =git format-patch= this will happen > +automatically, but when applying simple diffs you will need to > +override the author. Here are three ways to do that, depending on 2 spaces here. Looks good and to the point. -- Daniel Fleischer
[PATCH] describe how to override Author
Robert> The thing thatʼs missing is any discussion of how to ensure the
Author
Robert> of the commit is set correctly. When applying git patches it all
Robert> works, but not when applying diffs. Iʼll read through the
Robert> org-contribute section and see if I can come up with some verbiage.
Something like this? (I hope Iʼve got the syntax right, I seldom write
org for exporting purposes). The emacs CONTRIBUTE guidelines talk
about setting 'Author', but I guess not everyone reads those...
diff --git a/org-contribute.org b/org-contribute.org
index a3cb6f2b..c01bf417 100644
--- a/org-contribute.org
+++ b/org-contribute.org
@@ -270,6 +270,19 @@ * Your first commit as an Org maintainer
locally and make sure you have a clean commit history before merging
it into the =bugfix= or =main= branch.
+When applying patches written by other people, please ensure that the
+=Author= information of the resulting commit(s) is correct. When
+applying patches created with =git format-patch= this will happen
+automatically, but when applying simple diffs you will need to
+override the author. Here are three ways to do that, depending on
+which method you use to commit to git:
+
+1. Command line: src_sh{git commit --author='First Last '}
+2. =VC=: Set the 'Author:' field in log-edit mode (requires setting
+ `log-edit-setup-add-author').
+3. =Magit=: Override the author using the =-A= flag from magit's commit
+ transient.
+
To check our Git workflow in more details, please read
[[file:org-maintenance.org][Org maintenance]].
* Commit messages and ChangeLog entries
