Docs: Remove all references to long-unused LitRe tool. Also incidentally removes redundant/duplicate check for sphinx-build binary.

2025-12-14 20:36:38 +01:00 · 2019-01-13 21:07:54 -06:00
parent 02603ca57a
commit 687585eafa
32 changed files with 0 additions and 174 deletions
--- a/docs/ABI/Mangling.rst
+++ b/docs/ABI/Mangling.rst
@@ -1,6 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
 .. _ABI:

 .. highlight:: none
--- a/docs/ABI/TypeLayout.rst
+++ b/docs/ABI/TypeLayout.rst
@@ -1,6 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
 .. _ABI:

 .. highlight:: none
--- a/docs/ABI/TypeMetadata.rst
+++ b/docs/ABI/TypeMetadata.rst
@@ -1,6 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
 .. _ABI:

 .. highlight:: none
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -24,112 +24,6 @@ else()
  message(WARNING "Unable to find sphinx-build program. Not building docs")
 endif()

-## Example testing
-
-find_program(LITRE_EXECUTABLE
-  NAMES litre
-  DOC "LitRe literate programming tool for docutils")
-
-find_program(SPHINX_EXECUTABLE
-  NAMES sphinx-build
-  HINTS $ENV{SPHINX_DIR}
-  PATH_SUFFIXES bin
-  DOC "Sphinx documentation generator")
-
-if(LITRE_EXECUTABLE)
-  # Find all the .rst files
-  file(GLOB_RECURSE rst_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.rst)
-  set(subdir_CMakeLists)
-
-  foreach(rst ${rst_files})
-    # Prepare a testing directory containing a CMakeLists.txt
-    # and example files extracted from the .rst
-    set(test_dir "litre-tests/${rst}.litre-tests")
-
-    add_custom_command(
-      OUTPUT
-        ${test_dir}/CMakeLists.txt
-      COMMAND
-        ${LITRE_EXECUTABLE}
-        --default_compiler=${CMAKE_BINARY_DIR}/bin/swift
-        "--dump_dir=${test_dir}"
-        --traceback
-        --report=severe  # suppress most .rst errors.  We have lots of them.
-        ${CMAKE_CURRENT_SOURCE_DIR}/${rst}
-      DEPENDS
-        ${CMAKE_CURRENT_SOURCE_DIR}/${rst}
-      COMMENT
-        "Generating/Updating LitRe tests for ${rst}"
-      VERBATIM
-      )
-
-    list(APPEND subdir_CMakeLists ${test_dir}/CMakeLists.txt)
-  endforeach()
-
-  # Create a top-level CMakeLists.txt in a temporary file
-  add_custom_command(
-    OUTPUT
-      litre-top-CMakeLists.cmake
-    COMMAND
-      ${CMAKE_COMMAND} -DOUTPUT=litre-top-CMakeLists.cmake
-                      -DSOURCE_DIR=${CMAKE_CURRENT_SOURCE_DIR}
-          -P ${CMAKE_CURRENT_SOURCE_DIR}/GenerateTopLevelLitreCMakeLists.cmake
-          ${rst_files}
-    DEPENDS
-      ${rst_files}
-    COMMENT
-      "Generating top-level LitRe CMakeLists.txt content"
-    VERBATIM
-    )
-
-  # Only update the real top-level CMakeLists.txt if something changed
-  add_custom_command(
-    OUTPUT
-      "litre-tests/CMakeLists.txt"
-    COMMAND
-      "${CMAKE_COMMAND}" "-E" "copy_if_different"
-      "litre-top-CMakeLists.cmake" "litre-tests/CMakeLists.txt"
-    DEPENDS
-      "litre-top-CMakeLists.cmake"
-    COMMENT
-      "Updating top-level LitRe CMakeLists.txt"
-    VERBATIM)
-
-  # Create a build directory
-  add_custom_command(
-    OUTPUT "litre-tests/build"
-    COMMAND "${CMAKE_COMMAND}" "-E" "make_directory" "litre-tests/build")
-
-  # Run CMake itself to configure/build the tests
-  add_custom_command(
-    OUTPUT
-      litre-tests/results
-    COMMAND
-      ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" "${CMAKE_CURRENT_BINARY_DIR}/litre-tests"
-    COMMAND
-      ${CMAKE_COMMAND} --build .
-    COMMAND
-      ${CMAKE_COMMAND} -E touch "${CMAKE_CURRENT_BINARY_DIR}/litre-tests/results"
-    WORKING_DIRECTORY
-      litre-tests/build
-    DEPENDS
-      ${CMAKE_BINARY_DIR}/bin/swift
-      litre-tests/CMakeLists.txt litre-tests/build ${subdir_CMakeLists}
-    COMMENT
-      "Running LitRe tests"
-    VERBATIM
-      )
-
-  # Add a target so these tests show up in the Xcode project.
-  add_custom_target(
-    LiterateTests SOURCES ${rst_files}
-    DEPENDS litre-tests/results
-    )
-  set_target_properties(LiterateTests PROPERTIES FOLDER "Tests")
-else()
-  message(WARNING "LitRe not found; code examples won't be tested.")
-endif()
-
 if (LLVM_ENABLE_DOXYGEN)
 if (DOXYGEN_FOUND)
  set(abs_srcdir ${CMAKE_CURRENT_SOURCE_DIR})
--- a/docs/DependencyAnalysis.rst
+++ b/docs/DependencyAnalysis.rst
@@ -1,7 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
-
 ===================
 Dependency Analysis
 ===================
--- a/docs/GenerateTopLevelLitreCMakeLists.cmake
+++ b/docs/GenerateTopLevelLitreCMakeLists.cmake
@@ -1,6 +0,0 @@
-cmake_minimum_required(VERSION 2.8)
-set(rst_files)
-foreach(i RANGE 5 ${CMAKE_ARGC})
-  list(APPEND rst_files ${CMAKE_ARGV${i}})
-endforeach()
-configure_file(${SOURCE_DIR}/LitReTemplate.cmake ${OUTPUT} @ONLY)
--- a/docs/Lexicon.rst
+++ b/docs/Lexicon.rst
@@ -3,8 +3,6 @@
 .. title:: Lexicon
 .. default-role:: term

-.. @raise litre.TestsAreMissing
-
 This file defines several terms used by the Swift compiler and standard library
 source code, tests, and commit messages. See also the `LLVM lexicon`_.

--- a/docs/Literals.rst
+++ b/docs/Literals.rst
@@ -1,7 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
-
 Literals
 ========

--- a/docs/LitreTemplate.cmake
+++ b/docs/LitreTemplate.cmake
@@ -1,18 +0,0 @@
-cmake_minimum_required(VERSION 2.8)
-
-find_program(LITRE_EXECUTABLE
-  NAMES litre
-  DOC "LitRe literate programming tool for docutils")
-
-# Make the LitreTesting cmake module available
-execute_process(
-  COMMAND ${LITRE_EXECUTABLE} --cmake_module_path
-  OUTPUT_VARIABLE litre_cmake_module_path
-  OUTPUT_STRIP_TRAILING_WHITESPACE
-  )
-
-list(APPEND CMAKE_MODULE_PATH ${litre_cmake_module_path})
-set(rst_files "@rst_files@")
-foreach(rst ${rst_files})
-  add_subdirectory("${rst}.litre-tests")
-endforeach()
--- a/docs/LogicalObjects.rst
+++ b/docs/LogicalObjects.rst
@@ -1,5 +1,3 @@
-.. @raise litre.TestsAreMissing
-
 Logical Objects
 ===============

--- a/docs/Modules.rst
+++ b/docs/Modules.rst
@@ -1,6 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
 .. default-role:: term
 .. title:: Modules User Model

--- a/docs/PatternMatching.rst
+++ b/docs/PatternMatching.rst
@@ -1,4 +1,3 @@
-.. @raise litre.TestsAreMissing
 .. _PatternMatching:

 Pattern Matching
--- a/docs/SIL.rst
+++ b/docs/SIL.rst
@@ -1,4 +1,3 @@
-.. @raise litre.TestsAreMissing
 .. highlight:: none

 Swift Intermediate Language (SIL)
--- a/docs/SequencesAndCollections.rst
+++ b/docs/SequencesAndCollections.rst
@@ -1,6 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
 .. default-role:: code

 ====================================
--- a/docs/StdlibRationales.rst
+++ b/docs/StdlibRationales.rst
@@ -1,7 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
-
 =================================================
 Rationales for the Swift standard library designs
 =================================================
--- a/docs/StoredAndComputedVariables.rst
+++ b/docs/StoredAndComputedVariables.rst
@@ -1,5 +1,3 @@
-.. @raise litre.TestsAreMissing
-
 =============================
 Stored and Computed Variables
 =============================
--- a/docs/StringDesign.rst
+++ b/docs/StringDesign.rst
@@ -1,7 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
-
 .. raw:: html

    <style>
--- a/docs/TypeChecker.rst
+++ b/docs/TypeChecker.rst
@@ -1,5 +1,3 @@
-.. @raise litre.TestsAreMissing
-
 Type Checker Design and Implementation
 ========================================

--- a/docs/archive/LangRefNew.rst
+++ b/docs/archive/LangRefNew.rst
@@ -1,7 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
-
 ===============================
 Swift Language Reference Manual
 ===============================
--- a/docs/archive/NamespaceLevelVarsAndTopLevelCode.rst
+++ b/docs/archive/NamespaceLevelVarsAndTopLevelCode.rst
@@ -1,7 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
-
 .. warning:: This document was used in planning Swift 1.0; it has not been kept
  up to date and does not describe the current or planned behavior of Swift.

--- a/docs/archive/Objective-CInteroperability.rst
+++ b/docs/archive/Objective-CInteroperability.rst
@@ -1,7 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
-
 ============================
 Objective-C Interoperability
 ============================
--- a/docs/archive/Resilience.rst
+++ b/docs/archive/Resilience.rst
@@ -1,6 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
 .. _Resilience:

 Resilience
--- a/docs/contents.rst
+++ b/docs/contents.rst
@@ -1,4 +1,3 @@
-.. @raise litre.TestsAreMissing
 .. _contents:

 Contents
--- a/docs/proposals/Concurrency.rst
+++ b/docs/proposals/Concurrency.rst
@@ -1,6 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
 .. ConcurrencyModel:

 *Note*: This document is **not an accepted Swift proposal**. It does not describe Swift's concurrency mechanisms as they currently exist, nor is it a roadmap for the addition of concurrency mechanisms in future versions of Swift.
--- a/docs/proposals/DeclarationTypeChecker.rst
+++ b/docs/proposals/DeclarationTypeChecker.rst
@@ -1,7 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
-
 Declaration Type Checker
 ========================

--- a/docs/proposals/Inplace.rst
+++ b/docs/proposals/Inplace.rst
@@ -1,7 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
-
 =====================
 In-Place Operations
 =====================
--- a/docs/proposals/TypeState.rst
+++ b/docs/proposals/TypeState.rst
@@ -1,7 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
-
 General Type State Notes
 ========================

--- a/docs/proposals/ValueSemantics.rst
+++ b/docs/proposals/ValueSemantics.rst
@@ -1,6 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
 .. _ValueSemantics:

 ==========================
--- a/docs/proposals/archive/MemoryAndConcurrencyModel.rst
+++ b/docs/proposals/archive/MemoryAndConcurrencyModel.rst
@@ -1,6 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
 .. _MemoryAndConcurrencyModel:

 Swift Memory and Concurrency Model
--- a/docs/proposals/archive/ProgramStructureAndCompilationModel.rst
+++ b/docs/proposals/archive/ProgramStructureAndCompilationModel.rst
@@ -1,6 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
 .. _ProgramStructureAndCompilationModel:

 .. highlight:: none
--- a/docs/proposals/rejected/Clonable.rst
+++ b/docs/proposals/rejected/Clonable.rst
@@ -1,7 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
-
 ==========
 Clonable
 ==========
--- a/docs/proposals/valref.rst
+++ b/docs/proposals/valref.rst
@@ -1,6 +1,5 @@
 :orphan:

-.. @raise litre.TestsAreMissing
 .. _valref:

 =======================