Skip to content

[libc] Updated GettingStarted.rst with PyYAML version #100649

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 26, 2024
Merged

[libc] Updated GettingStarted.rst with PyYAML version #100649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5284e3
[libc] Updated GettingStarted.rst with PyYAML version
RoseZhang03 Jul 25, 2024
cde945c
addressed comments
RoseZhang03 Jul 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion libc/docs/dev/header_generation.rst
View file
Open in desktop
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
View file
Open in desktop
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`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Side note: This looks like it's different from what is posted at

llvm-project/libc/docs/dev/header_generation.rst

Line 25 in 888ae90

- Python Version: 3.6
? Should we just adjust the version on the header generation page to say 3.8 given that is the LLVM project-wide minimum?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I can edit the header generation page to match

`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
Loading