This is an archive of the discontinued LLVM Phabricator instance.

Differential D110124

[NFC] Update the list of subprojects in docs.
ClosedPublic

Authored by omasanori on Sep 20 2021, 9:01 PM.

Details

Reviewers
sscalpone
jdoerfert
rovka
Commits
rG17a26f585127: [NFC] Update the list of subprojects in docs.
Summary

The updated list is based on the output of cmake -G Ninja -S llvm -B build -DLLVM_ENABLE_PROJECTS='foo'.

Diff Detail

Event Timeline

omasanori created this revision.Sep 20 2021, 9:01 PM
Herald added a reviewer: sscalpone. · View Herald TranscriptSep 20 2021, 9:01 PM
omasanori requested review of this revision.Sep 20 2021, 9:01 PM
Herald added a reviewer: jdoerfert. · View Herald TranscriptSep 20 2021, 9:01 PM
Herald added a project: Restricted Project. · View Herald Transcript
Herald added subscribers: llvm-commits, sstefan1. · View Herald Transcript
omasanori edited the summary of this revision. (Show Details)Sep 20 2021, 9:02 PM
Harbormaster completed remote builds in B124805: Diff 373776.Sep 20 2021, 9:56 PM
rovka added a subscriber: rovka.Sep 21 2021, 3:06 AM

Can you also update README.md with the same list? Thanks!

llvm/docs/GettingStarted.rst
621

Nit: This seems pretty well sorted alphabetically, except for the 'flang' at the end. Maybe you should move it after cross-project-tests.

omasanori added a comment.Sep 21 2021, 4:27 AM

Thank you for reviewing, @rovka!

In D110124#3011750, @rovka wrote:

Can you also update README.md with the same list? Thanks!

Oh, I had overlooked it. I will update the patch. Thanks a lot!

omasanori added inline comments.Sep 21 2021, 4:33 AM
llvm/docs/GettingStarted.rst
621

The ordering is as is displayed by CMake, and the root cause is that flang is not in the all projects list due to its C++ requirements. However, it makes sense to order projects lexicographically in documentation anyway. I will update. Thank you for pointing it out!

omasanori updated this revision to Diff 373863.Sep 21 2021, 4:44 AM

Re-order subprojects alphabetically.

It addresses comments by Diana Picus. Thanks for reviewing!

rovka accepted this revision.Sep 21 2021, 5:12 AM

Thanks, LGTM! Do you have commit access or do you need someone to commit it for you?

This revision is now accepted and ready to land.Sep 21 2021, 5:12 AM
Harbormaster completed remote builds in B124867: Diff 373863.Sep 21 2021, 5:28 AM
omasanori added a comment.Sep 21 2021, 6:14 AM

I do not have permission. Would you mind if I asked for help to find a committer?

rovka added a comment.Sep 21 2021, 6:48 AM

I'll commit it for you :)

Closed by commit rG17a26f585127: [NFC] Update the list of subprojects in docs. (authored by omasanori, committed by rovka). · Explain WhySep 21 2021, 6:54 AM
This revision was automatically updated to reflect the committed changes.
rovka added a commit: rG17a26f585127: [NFC] Update the list of subprojects in docs..

Revision Contents

PathSize
5 lines
llvm/
docs/
6 lines

Diff 373904

README.md

Show First 20 Lines • Show All 59 Lines • ▼ Show 20 Lines * ``cmake -S llvm -B build -G <generator> [options]``
* ``Visual Studio`` --- for generating Visual Studio projects and * ``Visual Studio`` --- for generating Visual Studio projects and
solutions. solutions.
* ``Xcode`` --- for generating Xcode projects. * ``Xcode`` --- for generating Xcode projects.
Some Common options: Some Common options:
* ``-DLLVM_ENABLE_PROJECTS='...'`` --- semicolon-separated list of the LLVM * ``-DLLVM_ENABLE_PROJECTS='...'`` --- semicolon-separated list of the LLVM
sub-projects you'd like to additionally build. Can include any of: clang, sub-projects you'd like to additionally build. Can include any of: clang,
clang-tools-extra, libcxx, libcxxabi, libunwind, lldb, compiler-rt, lld, clang-tools-extra, compiler-rt,cross-project-tests, flang, libc, libclc,
polly, or cross-project-tests. libcxx, libcxxabi, libunwind, lld, lldb, mlir, openmp, parallel-libs,
polly, or pstl.
For example, to build LLVM, Clang, libcxx, and libcxxabi, use For example, to build LLVM, Clang, libcxx, and libcxxabi, use
``-DLLVM_ENABLE_PROJECTS="clang;libcxx;libcxxabi"``. ``-DLLVM_ENABLE_PROJECTS="clang;libcxx;libcxxabi"``.
* ``-DCMAKE_INSTALL_PREFIX=directory`` --- Specify for *directory* the full * ``-DCMAKE_INSTALL_PREFIX=directory`` --- Specify for *directory* the full
path name of where you want the LLVM tools and libraries to be installed path name of where you want the LLVM tools and libraries to be installed
(default ``/usr/local``). (default ``/usr/local``).
Show All 29 Lines

llvm/docs/GettingStarted.rst

Show First 20 Lines • Show All 609 Lines • ▼ Show 20 Lines
| LLVM_ENABLE_DOXYGEN | Build doxygen-based documentation from the source | | LLVM_ENABLE_DOXYGEN | Build doxygen-based documentation from the source |
| | code This is disabled by default because it is | | | code This is disabled by default because it is |
| | slow and generates a lot of output. | | | slow and generates a lot of output. |
+-------------------------+----------------------------------------------------+ +-------------------------+----------------------------------------------------+
| LLVM_ENABLE_PROJECTS | A semicolon-delimited list selecting which of the | | LLVM_ENABLE_PROJECTS | A semicolon-delimited list selecting which of the |
| | other LLVM subprojects to additionally build. (Only| | | other LLVM subprojects to additionally build. (Only|
| | effective when using a side-by-side project layout | | | effective when using a side-by-side project layout |
| | e.g. via git). The default list is empty. Can | | | e.g. via git). The default list is empty. Can |
| | include: clang, libcxx, libcxxabi, libunwind, lldb,| | | include: clang, clang-tools-extra, compiler-rt, |
| | compiler-rt, lld, polly, or debuginfo-tests. | | | cross-project-tests, flang, libc, libclc, libcxx, |
| | libcxxabi, libunwind, lld, lldb, mlir, openmp, |
| | parallel-libs, polly, or pstl. |
rovkaUnsubmitted
Not Done
ReplyInline Actions

Nit: This seems pretty well sorted alphabetically, except for the 'flang' at the end. Maybe you should move it after cross-project-tests.

rovka: Nit: This seems pretty well sorted alphabetically, except for the 'flang' at the end. Maybe you…
omasanoriAuthorUnsubmitted
Done
ReplyInline Actions

The ordering is as is displayed by CMake, and the root cause is that flang is not in the all projects list due to its C++ requirements. However, it makes sense to order projects lexicographically in documentation anyway. I will update. Thank you for pointing it out!

omasanori: The ordering is as is displayed by CMake, and the root cause is that flang is not in the…
+-------------------------+----------------------------------------------------+ +-------------------------+----------------------------------------------------+
| LLVM_ENABLE_SPHINX | Build sphinx-based documentation from the source | | LLVM_ENABLE_SPHINX | Build sphinx-based documentation from the source |
| | code. This is disabled by default because it is | | | code. This is disabled by default because it is |
| | slow and generates a lot of output. Sphinx version | | | slow and generates a lot of output. Sphinx version |
| | 1.5 or later recommended. | | | 1.5 or later recommended. |
+-------------------------+----------------------------------------------------+ +-------------------------+----------------------------------------------------+
| LLVM_BUILD_LLVM_DYLIB | Generate libLLVM.so. This library contains a | | LLVM_BUILD_LLVM_DYLIB | Generate libLLVM.so. This library contains a |
| | default set of LLVM components that can be | | | default set of LLVM components that can be |
▲ Show 20 Lines • Show All 608 Lines • Show Last 20 Lines