[Development] Proposal to retain \since version information in Qt Documentation

[Thiago Macieira]

On Tuesday 24 September 2024 14:22:06 GMT-7 Jaroslaw Kobus via Development 
wrote:
> > We didn't start adding them until post 4.0. I don't think 3.x had the tag
> > at all and APIs new in 4.0 weren't marked as such either. That means the
> > furthest back we can go is 4.0. Qt 3 to 4 was also a massive update, so I
> > don't think it would be useful to go that far back anyway. Qt 4.0 will be
> > 20 years old next year.
> 
> If the change introducing \since were tagged as \since we would now easily
> know when it was introduced.

If you have to do a git blame to find the commit that introduced something, you 
don't need the \since. The git tags can tell you where a commit was made part 
of.

Two examples. First, prior to the Pick-to existence. Let's say I wanted to 
know when QDataStream::Qt_6_0 was added. Git blame says it was commit 
543e87c65a8c8a9215c7fa1647792da77c2f6925 authored by you. Qt Creator's commit 
view includes:
          origin: 6.0, 6.1, 6.2, ..., 6.8.0, HEAD, dev and 24 more
and in the command-line:
$ git name-rev 543e87c65a8c8a9215c7fa1647792da77c2f6925
543e87c65a8c8a9215c7fa1647792da77c2f6925 tags/v6.0.0-alpha1~3167


Second, after that. Let's say I want to know when QDataStream::NullCode was 
added. Git blame says it was added by Øystein in commit 
fb81373313c4d1834437351aeb5df4a44303b93c, which Qt Creator says
Precedes: v6.8.0-beta1
Follows: v6.7.0-beta1

But a git show of this commit shows the annotation:
Notes (cherry-picks):
    6.7: 8dd7aba7fd2e6edeee33e97879f7e891028bad7d

And that commit is name-rev'ed to tags/v6.7.0-rc1~141.

-- 
Thiago Macieira - thiago.macieira (AT) intel.com
  Principal Engineer - Intel DCAI Platform & System Engineering
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 5152 bytes
Desc: not available
URL: <http://lists.qt-project.org/pipermail/development/attachments/20240924/cc9930c6/attachment-0001.bin>