This is an archive of the discontinued LLVM Phabricator instance.

Differential D83968

[docs] Add Deprecated section to ReleaseNotes
ClosedPublic

Authored by jsji on Jul 16 2020, 10:37 AM.

Details

Reviewers
hans
hfinkel
hubert.reinterpretcast
Commits
rG297be788a797: [docs] Add Deprecated section to ReleaseNotes
Summary

This is brought up in https://reviews.llvm.org/D83915.
We would like to remove some feature in PowerPC.

We did send RFC before, but we think it might be a better idea that
we indicate planned removal in the Release Notes for version 11
and actual removal in those for version 12..

Diff Detail

Unit TestsFailed

TimeTest
750 mslinux > SanitizerCommon-asan-x86_64-Linux.Linux::Unknown Unit Message ("")
510 mslinux > SanitizerCommon-lsan-x86_64-Linux.Linux::Unknown Unit Message ("")
620 mslinux > SanitizerCommon-msan-x86_64-Linux.Linux::Unknown Unit Message ("")
1,060 mslinux > SanitizerCommon-tsan-x86_64-Linux.Linux::Unknown Unit Message ("")
600 mslinux > SanitizerCommon-ubsan-x86_64-Linux.Linux::Unknown Unit Message ("")
View Full Test Results (7 Failed)

Event Timeline

jsji created this revision.Jul 16 2020, 10:37 AM
Herald added a project: Restricted Project. · View Herald TranscriptJul 16 2020, 10:37 AM
Herald added subscribers: llvm-commits, steven.zhang. · View Herald Transcript
jsji added reviewers: hans, hfinkel, hubert.reinterpretcast.Jul 16 2020, 10:37 AM
hans added inline comments.Jul 16 2020, 11:35 AM
llvm/docs/ReleaseNotes.rst
36

The "might" and the fact that it doesn't list any APIs makes this a bit vague.

I'd suggest instead to put a note on the 11.x branch with the features you are deprecating, and to instead say "these will be removed in the 12.0.0 release" so that it's not vague.

Harbormaster failed remote builds in B64558: Diff 278536!Jul 16 2020, 11:56 AM
jsji updated this revision to Diff 278569.Jul 16 2020, 12:03 PM

This will be committed to v11 branch.

jsji marked an inline comment as done.Jul 16 2020, 12:04 PM

Thanks @hans ! I have updated it to be in release/11.x only.

jsji edited the summary of this revision. (Show Details)Jul 16 2020, 12:07 PM
Harbormaster failed remote builds in B64576: Diff 278569!Jul 16 2020, 1:11 PM
hubert.reinterpretcast added inline comments.Jul 16 2020, 8:48 PM
llvm/docs/ReleaseNotes.rst
36

As written, the sentence implies that the subject is "BG/Q support that includes QPX" as opposed to "BG/Q support, which includes QPX". I believe the latter is meant, so I would suggest:
BG/Q support, including QPX, will be removed in the 12.0.0 release.

jsji updated this revision to Diff 278761.Jul 17 2020, 7:01 AM
jsji edited the summary of this revision. (Show Details)

Update per comments.

Harbormaster failed remote builds in B64681: Diff 278761!Jul 17 2020, 7:35 AM
hubert.reinterpretcast accepted this revision.Jul 17 2020, 8:41 AM

LGTM; thanks.

This revision is now accepted and ready to land.Jul 17 2020, 8:41 AM
jsji added a comment.Jul 17 2020, 9:00 AM

Committed to release/11.x in https://reviews.llvm.org/rG297be788a797c0ab98d9677f50e3dc57faab363b

jsji closed this revision.Jul 17 2020, 9:01 AM

Revision Contents

PathSize
llvm/
docs/
4 lines

Diff 278761

llvm/docs/ReleaseNotes.rst

Show All 25 Lines
<https://lists.llvm.org/mailman/listinfo/llvm-dev>`_ is a good place to send <https://lists.llvm.org/mailman/listinfo/llvm-dev>`_ is a good place to send
them. them.
Note that if you are reading this file from a Git checkout or the main Note that if you are reading this file from a Git checkout or the main
LLVM web page, this document applies to the *next* release, not the current LLVM web page, this document applies to the *next* release, not the current
one. To see the release notes for a specific release, please see the `releases one. To see the release notes for a specific release, please see the `releases
page <https://llvm.org/releases/>`_. page <https://llvm.org/releases/>`_.
Deprecated and Removed Features/APIs
=================================================
* BG/Q support, including QPX, will be removed in the 12.0.0 release.
hansUnsubmitted
Done
ReplyInline Actions

The "might" and the fact that it doesn't list any APIs makes this a bit vague.

I'd suggest instead to put a note on the 11.x branch with the features you are deprecating, and to instead say "these will be removed in the 12.0.0 release" so that it's not vague.

hans: The "might" and the fact that it doesn't list any APIs makes this a bit vague. I'd suggest…
hubert.reinterpretcastUnsubmitted
Not Done
ReplyInline Actions

As written, the sentence implies that the subject is "BG/Q support that includes QPX" as opposed to "BG/Q support, which includes QPX". I believe the latter is meant, so I would suggest:
BG/Q support, including QPX, will be removed in the 12.0.0 release.

hubert.reinterpretcast: As written, the sentence implies that the subject is "BG/Q support that includes QPX" as…
Non-comprehensive list of changes in this release Non-comprehensive list of changes in this release
================================================= =================================================
.. NOTE .. NOTE
For small 1-3 sentence descriptions, just add an entry at the end of For small 1-3 sentence descriptions, just add an entry at the end of
this list. If your description won't fit comfortably in one bullet this list. If your description won't fit comfortably in one bullet
point (e.g. maybe you would like to give an example of the point (e.g. maybe you would like to give an example of the
functionality, or simply have a lot to talk about), see the `NOTE` below functionality, or simply have a lot to talk about), see the `NOTE` below
for adding a new subsection. for adding a new subsection.
▲ Show 20 Lines • Show All 172 Lines • Show Last 20 Lines