[libc] [llvm] [libc] Updated GettingStarted.rst with PyYAML version (PR #100649)

via llvm-commits llvm-commits at lists.llvm.org
Fri Jul 26 11:12:29 PDT 2024


https://github.com/RoseZhang03 updated https://github.com/llvm/llvm-project/pull/100649

>From d5284e39d68dfc22531ce29a7b0765c1f1878876 Mon Sep 17 00:00:00 2001
From: Rose Zhang <rosezhang at google.com>
Date: Thu, 25 Jul 2024 20:22:12 +0000
Subject: [PATCH 1/2] [libc] Updated GettingStarted.rst with PyYAML version

New Headergen requires PyYAML version 5.1 or newer in order to generate
header files .
---
 llvm/docs/GettingStarted.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst
index 0a1913dca8aac..2810ce3308373 100644
--- a/llvm/docs/GettingStarted.rst
+++ b/llvm/docs/GettingStarted.rst
@@ -295,6 +295,7 @@ Package                                                     Version      Notes
 `python <http://www.python.org/>`_                          >=3.8        Automated test suite\ :sup:`1`
 `zlib <http://zlib.net>`_                                   >=1.2.3.4    Compression library\ :sup:`2`
 `GNU Make <http://savannah.gnu.org/projects/make>`_         3.79, 3.79.1 Makefile/build processor\ :sup:`3`
+`PyYAML <https://pypi.org/project/PyYAML/>`                 >=5.1        Header generator\ :sup:`4`
 =========================================================== ============ ==========================================
 
 .. note::
@@ -305,6 +306,7 @@ Package                                                     Version      Notes
    #. Optional, adds compression / uncompression capabilities to selected LLVM
       tools.
    #. Optional, you can use any other build tool supported by CMake.
+   #. Only needed when building libc with New Headergen. Mainly used by libc.
 
 Additionally, your compilation host is expected to have the usual plethora of
 Unix utilities. Specifically:

>From cde945c4974a0f9fba41584c191ae4197b996af3 Mon Sep 17 00:00:00 2001
From: Rose Zhang <rosezhang at google.com>
Date: Fri, 26 Jul 2024 18:12:13 +0000
Subject: [PATCH 2/2] addressed comments

---
 libc/docs/dev/header_generation.rst | 2 +-
 llvm/docs/GettingStarted.rst        | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/libc/docs/dev/header_generation.rst b/libc/docs/dev/header_generation.rst
index 32ce91da83f3d..598c8b8c8a6e8 100644
--- a/libc/docs/dev/header_generation.rst
+++ b/libc/docs/dev/header_generation.rst
@@ -22,7 +22,7 @@ Instructions
 ------------
 
 Required Versions:
-  - Python Version: 3.6
+  - Python Version: 3.8
   - PyYAML Version: 5.1
 
 1. Keep full-build mode on when building, otherwise headers will not be
diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst
index 2810ce3308373..e03ae5effcdc4 100644
--- a/llvm/docs/GettingStarted.rst
+++ b/llvm/docs/GettingStarted.rst
@@ -291,11 +291,11 @@ uses the package and provides other details.
 =========================================================== ============ ==========================================
 Package                                                     Version      Notes
 =========================================================== ============ ==========================================
-`CMake <http://cmake.org/>`__                               >=3.20.0     Makefile/workspace generator
+`CMake <http://cmake.org/>`_                                >=3.20.0     Makefile/workspace generator
 `python <http://www.python.org/>`_                          >=3.8        Automated test suite\ :sup:`1`
 `zlib <http://zlib.net>`_                                   >=1.2.3.4    Compression library\ :sup:`2`
 `GNU Make <http://savannah.gnu.org/projects/make>`_         3.79, 3.79.1 Makefile/build processor\ :sup:`3`
-`PyYAML <https://pypi.org/project/PyYAML/>`                 >=5.1        Header generator\ :sup:`4`
+`PyYAML <https://pypi.org/project/PyYAML/>`_                >=5.1        Header generator\ :sup:`4`
 =========================================================== ============ ==========================================
 
 .. note::



More information about the llvm-commits mailing list