GH-46215: [C++][Docs] Add README for Meson subprojects directory #46216
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
github-actions
bot
added
Component: C++
Component: Documentation
awaiting review
pitrou
reviewed
Apr 23, 2025
| @@ -0,0 +1,64 @@ | |||
| # Meson Subprojects | |||
There was a problem hiding this comment.
I think you need to add a license header above.
cpp/subprojects/README.md
Outdated
|
|
||
| The easiest way to populate subprojects is to use Meson's | ||
| [WrapDB system](https://mesonbuild.com/Wrapdb-projects.html). To illustrate how this | ||
| works, let's take a look at the ``googletest`` library that Arrow depends upon for |
There was a problem hiding this comment.
If this is a markdown file, you need to use markdown markup not reST :) Therefore only single backticks
Suggested change
| works, let's take a look at the ``googletest`` library that Arrow depends upon for | |
| works, let's take a look at the `googletest` library that Arrow depends upon for |
cpp/subprojects/README.md
Outdated
| The ``method = cmake`` line is important here; it instructs Meson to inspect any | ||
| CMakeLists.txt files from the downloaded source and auto generate Meson configuration | ||
| files therefrom. The generated meson.build configuration(s) will be placed in | ||
| <build_directory>/subprojects/<subproject_name> at project configuration time. |
There was a problem hiding this comment.
Suggested change
| <build_directory>/subprojects/<subproject_name> at project configuration time. | |
| `<build_directory>/subprojects/<subproject_name>` at project configuration time. |
github-actions
bot
added
awaiting committer review
WillAyd
force-pushed
the
meson-add-subprojects-readme
branch
2 times, most recently
from
6782516 to
479c639
Compare
kou
reviewed
Apr 24, 2025
cpp/subprojects/README.md
Outdated
Comment on lines
1
to
16
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. |
There was a problem hiding this comment.
Could you use <!-- ... --> for comment in .md?
github-actions
bot
added
awaiting changes
WillAyd
force-pushed
the
meson-add-subprojects-readme
branch
from
479c639 to
eae3117
Compare
github-actions
bot
added
awaiting change review
github-actions
bot
added
awaiting changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rationale for this change
This clarifies what the subprojects directory does, for developers not familiar with Meson
What changes are included in this PR?
This adds a README.md file to cpp/subprojects
Are these changes tested?
N/A
Are there any user-facing changes?
No