> From: Development <development-boun...@qt-project.org> On Behalf Of Edward
> Welbourne
> Sent: Monday, November 22, 2021 8:08 PM
> To: Shawn Rutledge <shawn.rutle...@qt.io>; Oswald Buddenhagen
> <oswald.buddenha...@gmx.de>
> Cc: development@qt-project.org
> Subject: Re: [Development] Documentation of new Qt features in qtdoc
>
[...]
> Shawn Rutledge (22 November 2021 15:56) added:
>> ChangeLog entries from the git log may often be badly-worded or be
>> written badly for the audience that’s going to read them, but I think
>> we should still start from those, for the sake of completeness.
>
> I think the aim here is to make them (and all scripts with delusions of
> collecting them into a useful release story) redundant in any case.
That was not the scope of my proposal though.
The [Change Log] entries are used for the release notes, which are stored since
a while in qtreleasenotes.git. See e.g.
https://code.qt.io/cgit/qt/qtreleasenotes.git/tree/qt/6.2.0/release-note.md .
Release notes are produced for every feature and patch level release, and are
automatically generated from the git log.
The "What's New" pages in the documentation are separate:
https://doc-snapshots.qt.io/qt6-dev/whatsnew62.html . We add these only for
minor versions.
Now there's obviously some duplication between these two, and I'm sure there's
people who doubt whether we need both. But my suggestion was just about the
What's New page, not the ChangeLog.
Kai
--- Begin Message ---
> On 20 Nov 2021, at 01:12, Oswald Buddenhagen <oswald.buddenha...@gmx.de>
> wrote:
>
> On Fri, Nov 19, 2021 at 03:11:57PM +0000, Kai Koehne wrote:
>> Can we agree to document new features in Qt 6.3 and following released
>> directly in qtdoc.git?
>>
> won't this cause conflict hell during release finalization? the turnaround
> time for submitting patches is still quite unreasonable for contended areas.
>
> it might work better if the update is done through a single collectively
> edited change. with gerrit's online editing functionality, this wouldn't even
> be much more cumbersome than editing the wiki.
> that would mean that jani would have post a link to a change he started
> instead of a wiki page as he did so far.
I’m in favour of having a single place for the What’s New documentation, and
the documentation is the right place, so +1 for that.
But I share Ossi’s concern. Knowing how many of those changes happen late in
the process, ending up with lots of them causing constant merge conflicts for
everyone is going to suck.
So, having a change that everyone can edit using gerrit's web UI is a good
proposal. +1 to that as well.
Volker
_______________________________________________
Development mailing list
Development@qt-project.org
https://lists.qt-project.org/listinfo/development
--- End Message ---
_______________________________________________
Development mailing list
Development@qt-project.org
https://lists.qt-project.org/listinfo/development
