[wwwdocs] htdocs/gitwrite.html: Clarify ChangeLog generation

As there was some confusion regarding when the ChangeLog is generated,
I propose the attached wwwdocs patch. Comments?

(Side remark: The cron-script commit by gccadmin@ is labelled "Daily bump."
and updates gcc/DATESTAMP besides the ChangeLog files.)

Tobias

-----------------
Mentor Graphics (Deutschland) GmbH, Arnulfstrasse 201, 80634 München Registergericht München HRB 106955, Geschäftsführer: Thomas Heurung, Frank Thürauf

On 5/23/21 2:37 PM, Tobias Burnus wrote:
> As there was some confusion regarding when the ChangeLog is generated,
> I propose the attached wwwdocs patch. Comments?

I support the change. Moreover, I'm going to install the following
patch that adds a note about ChangeLog entries.

Martin

> 
> (Side remark: The cron-script commit by gccadmin@ is labelled "Daily bump."
> and updates gcc/DATESTAMP besides the ChangeLog files.)
> 
> Tobias
> 
> -----------------
> Mentor Graphics (Deutschland) GmbH, Arnulfstrasse 201, 80634 München Registergericht München HRB 106955, Geschäftsführer: Thomas Heurung, Frank Thürauf

On Sun, 23 May 2021, Tobias Burnus wrote:
> As there was some confusion regarding when the ChangeLog is generated,
> I propose the attached wwwdocs patch. Comments?

-<li>Apply the patch to your local tree.  ChangeLog entries will be
-automatically added to the corresponding ChangeLog files based
-on the git commit message.  See the documentation of
+<li>Apply the patch to your local tree.  On the release branches, ChangeLog
+entries will be automatically added to the corresponding ChangeLog files based
+on the git commit message by the daily-bump commit.

Just "On release branches".

And "by the daily-dump commit based on git commit messages" (plural 
for commit messages and different order).


Can we assume everyone knows about the "daily-dump commit" here, or 
should we just write "once a day" or something like that?

And a question for my understanding: Why only on release branches?
From what I can tell the same applies for trunk?

Gerald

PS: Nice change, too, Martin. Thank you!

On 24.05.21 09:45, Gerald Pfeifer wrote:
> On Sun, 23 May 2021, Tobias Burnus wrote:
>> As there was some confusion regarding when the ChangeLog is generated,
>> I propose the attached wwwdocs patch. Comments?
> -<li>Apply the patch to your local tree.  ChangeLog entries will be
> -automatically added to the corresponding ChangeLog files based
> -on the git commit message.  See the documentation of
> +<li>Apply the patch to your local tree.  On the release branches, ChangeLog
> +entries will be automatically added to the corresponding ChangeLog files based
> +on the git commit message by the daily-bump commit.
>
> Just "On release branches".
>
> And "by the daily-dump commit based on git commit messages" (plural
> for commit messages and different order).
>
>
> Can we assume everyone knows about the "daily-dump commit" here, or
> should we just write "once a day" or something like that?
I think "once a day" is clearer. [The commit has the message "Daily
bump." and bumps (not "dumps") the date in DATESTAMP. I wanted to relate
those – but it seems as if this just adds more confusion.]
> And a question for my understanding: Why only on release branches?
>  From what I can tell the same applies for trunk?

Yes, to mainline ("master" branch, also available as "trunk") and to
(currently) 9, 10, and 11 – but not to closed (release) branches like
GCC 8 (releases/gcc-8) or to devel/*, vendor/*, user/* branches.

In my mind, "release branch" included the to-be-released mainline (in
line with the version list on gcc.gnu.org), but one can argue about
"branch" and "release". – I now use "master" (as that's the branch name
in our git repo, and not "target" (alias) or "mainline" (generic GCC term)).

Hence, I attached a new version ...

Tobias

-----------------
Mentor Graphics (Deutschland) GmbH, Arnulfstrasse 201, 80634 München Registergericht München HRB 106955, Geschäftsführer: Thomas Heurung, Frank Thürauf

*PING*

On 25.05.21 13:16, Tobias Burnus wrote:
> On 24.05.21 09:45, Gerald Pfeifer wrote:
>> On Sun, 23 May 2021, Tobias Burnus wrote:
>>> As there was some confusion regarding when the ChangeLog is generated,
>>> I propose the attached wwwdocs patch. Comments?
>> -<li>Apply the patch to your local tree.  ChangeLog entries will be
>> -automatically added to the corresponding ChangeLog files based
>> -on the git commit message.  See the documentation of
>> +<li>Apply the patch to your local tree.  On the release branches,
>> ChangeLog
>> +entries will be automatically added to the corresponding ChangeLog
>> files based
>> +on the git commit message by the daily-bump commit.
>>
>> Just "On release branches".
>>
>> And "by the daily-dump commit based on git commit messages" (plural
>> for commit messages and different order).
>>
>>
>> Can we assume everyone knows about the "daily-dump commit" here, or
>> should we just write "once a day" or something like that?
> I think "once a day" is clearer. [The commit has the message "Daily
> bump." and bumps (not "dumps") the date in DATESTAMP. I wanted to
> relate those – but it seems as if this just adds more confusion.]
>> And a question for my understanding: Why only on release branches?
>>  From what I can tell the same applies for trunk?
>
> Yes, to mainline ("master" branch, also available as "trunk") and to
> (currently) 9, 10, and 11 – but not to closed (release) branches like
> GCC 8 (releases/gcc-8) or to devel/*, vendor/*, user/* branches.
>
> In my mind, "release branch" included the to-be-released mainline (in
> line with the version list on gcc.gnu.org), but one can argue about
> "branch" and "release". – I now use "master" (as that's the branch
> name in our git repo, and not "target" (alias) or "mainline" (generic
> GCC term)).
>
> Hence, I attached a new version ...
>
> Tobias
>
-----------------
Mentor Graphics (Deutschland) GmbH, Arnulfstrasse 201, 80634 München Registergericht München HRB 106955, Geschäftsführer: Thomas Heurung, Frank Thürauf

On Tue, 25 May 2021, Tobias Burnus wrote:
> I think "once a day" is clearer. [The commit has the message "Daily
> bump." and bumps (not "dumps") the date in DATESTAMP. I wanted to relate
> those – but it seems as if this just adds more confusion.]

FWIW, your updated version makes everything easy to consume and crystal 
clear to me. :-)

> Yes, to mainline ("master" branch, also available as "trunk") and to
> (currently) 9, 10, and 11 – but not to closed (release) branches like
> GCC 8 (releases/gcc-8) or to devel/*, vendor/*, user/* branches.
> 
> In my mind, "release branch" included the to-be-released mainline (in
> line with the version list on gcc.gnu.org), but one can argue about
> "branch" and "release".

I believe the way we've usually been using is for trunk/master/mainline/...
to not count as a release branch (also in terms how we're handling it).

> Hence, I attached a new version ...

Ah, I thought you'd go ahead and commit it.  Please do. :-)

Gerald