mirrors/llvm-project
0
0
Fork 0
mirror of https://github.com/llvm/llvm-project.git synced 2025-04-15 23:36:31 +00:00
Code Issues Projects Releases Wiki Activity
llvm-project/llvm/docs/ReleaseNotes.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

160 lines
4.4 KiB
Markdown
Raw Normal View History

[llvm][docs] Convert LLVM release notes to Markdown (#109107) * Markdown is the most common format on GitHub and most contributors are more familiar with it than RST. * This leads to mistakes in the RST syntax and/or folks just using Markdown syntax and assuming it works. * The release notes have a high number of edits and a high number of views, we should optimise for making the common path easy. That is, adding a bullet point and a link. * Though GitHub can render RST and Markdown, its support for Markdown is more complete (and neither handle the Sphinx directives well). * We already have some Markdown docs in the llvm docs. To keep the original formatting we do need some Sphinx directives still, and those are provided by MyST which is already enabled. https://myst-parser.readthedocs.io/en/latest/ I did have to enable an extension so we can substitute in the release version. https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2 Needing to use MyST means there is some special knowledge needed if you want to do advanced things, but at least the basics remain Markdown. Even in RST form, you still had to look up Sphinx syntax. I also make use of a nested directive https://myst-parser.readthedocs.io/en/latest/syntax/roles-and-directives.html#nesting-directives to implement the prerelease warning. The note about sections referred to another note that got removed in 4c72deb613d9d8838785b431facb3eb480fb2f51. I presume accidentally, so I have restored that. I also removed the "Update on required toolchains to build LLVM" header because the section is now empty. The other difference is that the table of contents now has a heading "Contents". This is the default and I could not find a way to remove that name. Otherwise it's the same table as you'd get from the RST document.
2024-09-26 14:15:53 +01:00
<!-- This document is written in Markdown and uses extra directives provided by
MyST (https://myst-parser.readthedocs.io/en/latest/). -->
LLVM {{env.config.release}} Release Notes
=========================================
```{contents}
```
````{only} PreRelease
```{warning} These are in-progress notes for the upcoming LLVM {{env.config.release}}
release. Release notes for previous releases can be found on
[the Download Page](https://releases.llvm.org/download.html).
```
````
Introduction
============
This document contains the release notes for the LLVM Compiler Infrastructure,
release {{env.config.release}}. Here we describe the status of LLVM, including
major improvements from the previous release, improvements in various subprojects
of LLVM, and some of the current users of the code. All LLVM releases may be
downloaded from the [LLVM releases web site](https://llvm.org/releases/).
For more information about LLVM, including information about the latest
release, please check out the [main LLVM web site](https://llvm.org/). If you
have questions or comments, the [Discourse forums](https://discourse.llvm.org)
is a good place to ask them.
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
one. To see the release notes for a specific release, please see the
[releases page](https://llvm.org/releases/).
Non-comprehensive list of changes in this release
=================================================
<!-- 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
point (e.g. maybe you would like to give an example of the
functionality, or simply have a lot to talk about), see the comment below
for adding a new subsection. -->
* ...
<!-- If you would like to document a larger change, then you can add a
subsection about it right here. You can copy the following boilerplate:
Special New Feature
-------------------
Makes programs 10x faster by doing Special New Thing.
-->
Changes to the LLVM IR
----------------------
Changes to LLVM infrastructure
------------------------------
Changes to building LLVM
------------------------
Changes to TableGen
-------------------
Changes to Interprocedural Optimizations
----------------------------------------
Changes to the AArch64 Backend
------------------------------
Changes to the AMDGPU Backend
-----------------------------
Changes to the ARM Backend
--------------------------
Changes to the AVR Backend
--------------------------
Changes to the DirectX Backend
------------------------------
Changes to the Hexagon Backend
------------------------------
Changes to the LoongArch Backend
--------------------------------
Changes to the MIPS Backend
---------------------------
Changes to the PowerPC Backend
------------------------------
Changes to the RISC-V Backend
-----------------------------
Changes to the WebAssembly Backend
----------------------------------
Changes to the Windows Target
-----------------------------
Changes to the X86 Backend
--------------------------
Changes to the OCaml bindings
-----------------------------
Changes to the Python bindings
------------------------------
Changes to the C API
--------------------
Changes to the CodeGen infrastructure
-------------------------------------
Changes to the Metadata Info
---------------------------------
Changes to the Debug Info
---------------------------------
Changes to the LLVM tools
---------------------------------
Changes to LLDB
---------------------------------
Changes to BOLT
---------------------------------
Changes to Sanitizers
---------------------
Other Changes
-------------
External Open Source Projects Using LLVM {{env.config.release}}
===============================================================
* A project...
Additional Information
======================
A wide variety of additional information is available on the
[LLVM web page](https://llvm.org/), in particular in the
[documentation](https://llvm.org/docs/) section. The web page also contains
versions of the API documentation which is up-to-date with the Git version of
the source code. You can access versions of these documents specific to this
release by going into the `llvm/docs/` directory in the LLVM tree.
If you have any questions or comments about LLVM, please feel free to contact
us via the [Discourse forums](https://discourse.llvm.org).
Reference in New Issue Copy Permalink