revert-update-doc

commit e80c52986e1bb3afa6a92c58b1cb897877923a66
Author: Tom Stellard <tstellar@redhat.com>
Date:   Tue Feb 1 23:13:01 2022 -0800

    [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

Gbp-Pq: Name revert-update-doc.diff

diff --git a/clang-tools-extra/docs/conf.py b/clang-tools-extra/docs/conf.py
index ee5daa2d047c0afbd5b0f918c99d33c454cf637e..ca5ab73987363e8296d53e649119e346c01a7a09 100644 (file)
--- a/clang-tools-extra/docs/conf.py
+++ b/clang-tools-extra/docs/conf.py
@@ -44,6 +44,15 @@ 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 = '15'
+# The full version, including alpha/beta/rc tags.
+release = '15'
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None
@@ -78,11 +87,6 @@ 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 ---------------------------------------------------
 

diff --git a/clang/docs/conf.py b/clang/docs/conf.py
index 86ecc72c070dd47081a6d572d01c146bc66ba264..3e71790a46d345880b2b6edeb010bc731de694bb 100644 (file)
--- a/clang/docs/conf.py
+++ b/clang/docs/conf.py
@@ -62,6 +62,15 @@ 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 = '15'
+# The full version, including alpha/beta/rc tags.
+release = '15'
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None
@@ -93,11 +102,6 @@ exclude_patterns = ['_build']
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'friendly'
 
-in_progress_title = "(In-Progress) " if tags.has("PreRelease") else ""
-
-rst_epilog = f"""
-.. |ReleaseNotesTitle| replace:: {in_progress_title} Release Notes
-"""
 
 # -- Options for HTML output ---------------------------------------------------
 

diff --git a/lld/docs/conf.py b/lld/docs/conf.py
index 95befddf80ea35f769e7a8afc8ab174f15e23db8..dc880584555bd71084ea1b09edd749bea51230e5 100644 (file)
--- a/lld/docs/conf.py
+++ b/lld/docs/conf.py
@@ -43,6 +43,15 @@ 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 = '15'
+# The full version, including alpha/beta/rc tags.
+release = '15'
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None

diff --git a/llvm/cmake/modules/AddSphinxTarget.cmake b/llvm/cmake/modules/AddSphinxTarget.cmake
index b90639fbbf073bb94a8744d12f56a92c23ca143b..8183ee893cea03f33c612a122eea0c2084640f3d 100644 (file)
--- a/llvm/cmake/modules/AddSphinxTarget.cmake
+++ b/llvm/cmake/modules/AddSphinxTarget.cmake
@@ -39,10 +39,6 @@ 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}
@@ -50,9 +46,6 @@ 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

diff --git a/llvm/docs/conf.py b/llvm/docs/conf.py
index 617ce564bbeef9c0d144faf5aa533741dee2fbca..cf491f78a1ffa4fa4668752e176155cc429b021f 100644 (file)
--- a/llvm/docs/conf.py
+++ b/llvm/docs/conf.py
@@ -61,6 +61,15 @@ 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 = '15'
+# The full version, including alpha/beta/rc tags.
+release = '15'
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None

diff --git a/polly/docs/conf.py b/polly/docs/conf.py
index 44623f4fcd1a010a22f0ec880b26f5307c3b591d..131d6a7289efdc33877b4e27afca259eb7bacfdc 100644 (file)
--- a/polly/docs/conf.py
+++ b/polly/docs/conf.py
@@ -44,6 +44,15 @@ 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 = '15.0'
+# The full version, including alpha/beta/rc tags.
+release = '15.0'
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None
@@ -78,11 +87,6 @@ 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 ---------------------------------------------------