Skip to content

Commit

Permalink
[libc] Updated GettingStarted.rst with PyYAML version (llvm#100649)
Browse files Browse the repository at this point in the history
New Headergen requires PyYAML version 5.1 or newer in order to generate
header files .
  • Loading branch information
RoseZhang03 authored Jul 26, 2024
1 parent 247251a commit 134b448
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion libc/docs/dev/header_generation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion llvm/docs/GettingStarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -291,10 +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`
=========================================================== ============ ==========================================

.. note::
Expand All @@ -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:
Expand Down

0 comments on commit 134b448

Please sign in to comment.