maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[docs] Remove hard-coded version numbers from sphinx configs 

This updates all the non-runtime project release notes to use the
version number from CMake instead of the hard-coded version numbers
in conf.py.

It also hides warnings about pre-releases when the git suffix
is dropped from the LLVM version in CMake.

Reviewed By: MaskRay

Differential Revision: https://reviews.llvm.org/D112181
This commit is contained in:
Tom Stellard 2022-02-01 23:13:01 -08:00
parent 76f37d41b7
commit e80c52986e
11 changed files with 71 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
clang-tools-extra/docs/ReleaseNotes.rst
View File

@ -1,5 +1,5 @@
====================================================
Extra Clang Tools 14.0.0 (In-Progress) Release Notes
Extra Clang Tools |release| |ReleaseNotesTitle|
====================================================
.. contents::
@ -8,17 +8,18 @@ Extra Clang Tools 14.0.0 (In-Progress) Release Notes
Written by the `LLVM Team <https://llvm.org/>`_
.. warning::
.. only:: PreRelease
These are in-progress notes for the upcoming Extra Clang Tools 14 release.
Release notes for previous releases can be found on
`the Download Page <https://releases.llvm.org/download.html>`_.
.. warning::
These are in-progress notes for the upcoming Extra Clang Tools |version| 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 Extra Clang Tools, part of the
Clang release 14.0.0. Here we describe the status of the Extra Clang Tools in
Clang release |release|. Here we describe the status of the Extra Clang Tools in
some detail, including major improvements from the previous release and new
feature work. All LLVM releases may be downloaded from the `LLVM releases web
site <https://llvm.org/releases/>`_.
@ -32,8 +33,8 @@ main Clang 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/>`_.
What's New in Extra Clang Tools 14.0.0?
=======================================
What's New in Extra Clang Tools |release|?
==========================================
Some of the major new features and improvements to Extra Clang Tools are listed
here. Generic improvements to Extra Clang Tools as a whole or to its underlying

14
clang-tools-extra/docs/conf.py
View File

@ -44,15 +44,6 @@ master_doc = 'index'
project = u'Extra Clang Tools'
copyright = u'2007-%d, The Clang Team' % date.today().year
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short version.
version = '14'
# The full version, including alpha/beta/rc tags.
release = '14'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
@ -87,6 +78,11 @@ pygments_style = 'friendly'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
in_progress_title = "(In-Progress) " if tags.has("PreRelease") else ""
rst_epilog = f"""
.. |ReleaseNotesTitle| replace:: {in_progress_title} Release Notes
"""
# -- Options for HTML output ---------------------------------------------------

21
clang/docs/ReleaseNotes.rst
View File

@ -1,6 +1,6 @@
========================================
Clang 14.0.0 (In-Progress) Release Notes
========================================
===========================================
Clang |release| |ReleaseNotesTitle|
===========================================
.. contents::
:local:
@ -8,17 +8,18 @@ Clang 14.0.0 (In-Progress) Release Notes
Written by the `LLVM Team <https://llvm.org/>`_
.. warning::
.. only:: PreRelease
These are in-progress notes for the upcoming Clang 14 release.
Release notes for previous releases can be found on
`the Download Page <https://releases.llvm.org/download.html>`_.
.. warning::
These are in-progress notes for the upcoming Clang |version| 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 Clang C/C++/Objective-C
frontend, part of the LLVM Compiler Infrastructure, release 14.0.0. Here we
frontend, part of the LLVM Compiler Infrastructure, release |release|. Here we
describe the status of Clang in some detail, including major
improvements from the previous release and new feature work. For the
general LLVM release notes, see `the LLVM
@ -35,8 +36,8 @@ main Clang 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/>`_.
What's New in Clang 14.0.0?
===========================
What's New in Clang |release|?
==============================
Some of the major new features and improvements to Clang are listed
here. Generic improvements to Clang as a whole or to its underlying

14
clang/docs/conf.py
View File

@ -62,15 +62,6 @@ master_doc = 'index'
project = u'Clang'
copyright = u'2007-%d, The Clang Team' % date.today().year
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short version.
version = '13'
# The full version, including alpha/beta/rc tags.
release = '13'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
@ -105,6 +96,11 @@ pygments_style = 'friendly'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
in_progress_title = "(In-Progress) " if tags.has("PreRelease") else ""
rst_epilog = f"""
.. |ReleaseNotesTitle| replace:: {in_progress_title} Release Notes
"""
# -- Options for HTML output ---------------------------------------------------

18
lld/docs/ReleaseNotes.rst
View File

@ -1,19 +1,21 @@
========================
lld 14.0.0 Release Notes
========================
===========================
lld |release| Release Notes
===========================
.. contents::
:local:
.. warning::
These are in-progress notes for the upcoming LLVM 14.0.0 release.
Release notes for previous releases can be found on
`the Download Page <https://releases.llvm.org/download.html>`_.
.. only:: PreRelease
.. warning::
These are in-progress notes for the upcoming LLVM |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 lld linker, release 14.0.0.
This document contains the release notes for the lld linker, release |release|.
Here we describe the status of lld, including major improvements
from the previous release. All lld releases may be downloaded
from the `LLVM releases web site <https://llvm.org/releases/>`_.

9
lld/docs/conf.py
View File

@ -43,15 +43,6 @@ master_doc = 'index'
project = u'lld'
copyright = u'2011-%d, LLVM Project' % date.today().year
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short version.
version = '14'
# The full version, including alpha/beta/rc tags.
release = '14'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

7
llvm/cmake/modules/AddSphinxTarget.cmake
View File

@ -39,6 +39,10 @@ function (add_sphinx_target builder project)
set(ARG_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
endif()
if ("${LLVM_VERSION_SUFFIX}" STREQUAL "git")
set(PreReleaseTag "-tPreRelease")
endif()
add_custom_target(${SPHINX_TARGET_NAME}
COMMAND ${CMAKE_COMMAND} -E env ${ARG_ENV_VARS}
${SPHINX_EXECUTABLE}
@ -46,6 +50,9 @@ function (add_sphinx_target builder project)
-d "${SPHINX_DOC_TREE_DIR}"
-q # Quiet: no output other than errors and warnings.
-t builder-${builder} # tag for builder
-D version=${LLVM_VERSION_MAJOR}
-D release=${PACKAGE_VERSION}
${PreReleaseTag}
${SPHINX_WARNINGS_AS_ERRORS_FLAG} # Treat warnings as errors if requested
"${ARG_SOURCE_DIR}" # Source
"${SPHINX_BUILD_DIR}" # Output

18
llvm/docs/ReleaseNotes.rst
View File

@ -1,21 +1,23 @@
=========================
LLVM 14.0.0 Release Notes
=========================
============================
LLVM |release| Release Notes
============================
.. contents::
:local:
.. warning::
These are in-progress notes for the upcoming LLVM 14 release.
Release notes for previous releases can be found on
`the Download Page <https://releases.llvm.org/download.html>`_.
.. only:: PreRelease
.. warning::
These are in-progress notes for the upcoming LLVM |version| 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 14.0.0. Here we describe the status of LLVM, including major improvements
release |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/>`_.

9
llvm/docs/conf.py
View File

@ -61,15 +61,6 @@ master_doc = 'index'
project = u'LLVM'
copyright = u'2003-%d, LLVM Project' % date.today().year
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short version.
version = '13'
# The full version, including alpha/beta/rc tags.
release = '13'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

17
polly/docs/ReleaseNotes.rst
View File

@ -1,14 +1,15 @@
=============================
Release Notes 14.0 (upcoming)
=============================
===========================================
Release Notes |release| |ReleaseNotesTitle|
===========================================
In Polly 14 the following important changes have been incorporated.
In Polly |version| the following important changes have been incorporated.
.. warning::
.. only:: PreRelease
These release notes are for the next release of Polly and describe
the new features that have recently been committed to our development
branch.
.. warning::
These release notes are for the next release of Polly and describe
the new features that have recently been committed to our development
branch.
- The command line option -polly-opt-fusion has been removed. What the
flag does was frequently misunderstood and is rarely useful. However,

14
polly/docs/conf.py
View File

@ -44,15 +44,6 @@ master_doc = 'index'
project = u'Polly'
copyright = u'2010-%d, The Polly Team' % date.today().year
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '14.0-devel'
# The full version, including alpha/beta/rc tags.
release = '14.0-devel'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
@ -87,6 +78,11 @@ pygments_style = 'friendly'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
in_progress_title = "(In-Progress) " if tags.has("PreRelease") else ""
rst_epilog = f"""
.. |ReleaseNotesTitle| replace:: {in_progress_title} Release Notes
"""
# -- Options for HTML output ---------------------------------------------------