-
Notifications
You must be signed in to change notification settings - Fork 690
chore: update attributions files post 0.3.0 release #1438
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.
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
Conversation
WalkthroughA new documentation file, Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (12)
ATTRIBUTIONS.md (12)
22-29: Convert bare URL to markdown link
Avoid bare URLs to satisfy MD034 and improve readability by embedding the link in descriptive text.Apply this diff:
- The complete text of the GPL-2.0 license can be found at: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html + The complete text of the GPL-2.0 license can be found at: [GPL-2.0 license](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
29-29: Bare URL used
null(MD034, no-bare-urls)
31-39: Convert bare URL to markdown link
Wrap the LGPL license URL in link text to remove the bare URL warning.- The complete text of the LGPL-2.1 license can be found at: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html + The complete text of the LGPL-2.1 license can be found at: [LGPL-2.1+ license](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
38-38: Bare URL used
null(MD034, no-bare-urls)
40-48: Convert bare URL to markdown link
Use descriptive link text for the libdl license reference.- The complete text of the LGPL-2.1 license can be found at: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html + The complete text of the LGPL-2.1 license can be found at: [LGPL-2.1+ license](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
47-47: Bare URL used
null(MD034, no-bare-urls)
49-57: Convert bare URL to markdown link
Replace the bare URL with inline link syntax for libpthread.- The complete text of the LGPL-2.1 license can be found at: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html + The complete text of the LGPL-2.1 license can be found at: [LGPL-2.1+ license](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
56-56: Bare URL used
null(MD034, no-bare-urls)
58-66: Convert bare URL to markdown link
Embed the libm license link in text to eliminate the MD034 warning.- The complete text of the LGPL-2.1 license can be found at: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html + The complete text of the LGPL-2.1 license can be found at: [LGPL-2.1+ license](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
65-65: Bare URL used
null(MD034, no-bare-urls)
67-75: Convert bare URL to markdown link
Change the libc license reference to inline link form.- The complete text of the LGPL-2.1 license can be found at: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html + The complete text of the LGPL-2.1 license can be found at: [LGPL-2.1+ license](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
74-74: Bare URL used
null(MD034, no-bare-urls)
76-84: Convert bare URL to markdown link
Wrap the librt license link in descriptive text.- The complete text of the LGPL-2.1 license can be found at: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html + The complete text of the LGPL-2.1 license can be found at: [LGPL-2.1+ license](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
83-83: Bare URL used
null(MD034, no-bare-urls)
85-93: Convert bare URL to markdown link
Convert the ld-linux-x86-64 license URL into inline link syntax.- The complete text of the LGPL-2.1 license can be found at: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html + The complete text of the LGPL-2.1 license can be found at: [LGPL-2.1+ license](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html).<details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 92-92: Bare URL used null (MD034, no-bare-urls) </details> </details> --- `94-105`: **Convert bare URLs to markdown links** Replace both the GPL-3.0 and GCC exception URLs with inline link text. ```diff - The complete text of the GPL-3.0 license can be found at: https://www.gnu.org/licenses/gpl-3.0.html + The complete text of the GPL-3.0 license can be found at: [GPL-3.0 license](https://www.gnu.org/licenses/gpl-3.0.html). - The GCC Runtime Library Exception can be found at: https://www.gnu.org/licenses/gcc-exception-3.1.html + The GCC Runtime Library Exception can be found at: [GCC exception 3.1](https://www.gnu.org/licenses/gcc-exception-3.1.html).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
103-103: Bare URL used
null(MD034, no-bare-urls)
104-104: Bare URL used
null(MD034, no-bare-urls)
106-117: Convert bare URLs to markdown links
Embed the libstdc++ license and exception URLs in descriptive link text.- The complete text of the GPL-3.0 license can be found at: https://www.gnu.org/licenses/gpl-3.0.html + The complete text of the GPL-3.0 license can be found at: [GPL-3.0 license](https://www.gnu.org/licenses/gpl-3.0.html). - The GCC Runtime Library Exception can be found at: https://www.gnu.org/licenses/gcc-exception-3.1.html + The GCC Runtime Library Exception can be found at: [GCC exception 3.1](https://www.gnu.org/licenses/gcc-exception-3.1.html).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
115-115: Bare URL used
null(MD034, no-bare-urls)
116-116: Bare URL used
null(MD034, no-bare-urls)
118-128: Convert bare URLs to markdown links
Use inline link syntax for the libgomp license references.- The complete text of the GPL-3.0 license can be found at: https://www.gnu.org/licenses/gpl-3.0.html + The complete text of the GPL-3.0 license can be found at: [GPL-3.0 license](https://www.gnu.org/licenses/gpl-3.0.html). - The GCC Runtime Library Exception can be found at: https://www.gnu.org/licenses/gcc-exception-3.1.html + The GCC Runtime Library Exception can be found at: [GCC exception 3.1](https://www.gnu.org/licenses/gcc-exception-3.1.html).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
127-127: Bare URL used
null(MD034, no-bare-urls)
128-128: Bare URL used
null(MD034, no-bare-urls)
132-139: Convert bare URLs to markdown links
Wrap the source code availability URLs in descriptive link text and consider using canonical domains (e.g., https://www.kernel.org/).- **glibc and related libraries:** https://www.gnu.org/software/libc/ + **glibc and related libraries:** [GNU C Library](https://www.gnu.org/software/libc/) - **Linux kernel:** https://kernel.org/ + **Linux kernel:** [kernel.org](https://www.kernel.org/) - **GCC runtime libraries:** https://gcc.gnu.org/ + **GCC runtime libraries:** [GCC](https://gcc.gnu.org/)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
136-136: Bare URL used
null(MD034, no-bare-urls)
137-137: Bare URL used
null(MD034, no-bare-urls)
138-138: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
ATTRIBUTIONS.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
ATTRIBUTIONS.md
29-29: Bare URL used
null
(MD034, no-bare-urls)
38-38: Bare URL used
null
(MD034, no-bare-urls)
47-47: Bare URL used
null
(MD034, no-bare-urls)
56-56: Bare URL used
null
(MD034, no-bare-urls)
65-65: Bare URL used
null
(MD034, no-bare-urls)
74-74: Bare URL used
null
(MD034, no-bare-urls)
83-83: Bare URL used
null
(MD034, no-bare-urls)
92-92: Bare URL used
null
(MD034, no-bare-urls)
103-103: Bare URL used
null
(MD034, no-bare-urls)
104-104: Bare URL used
null
(MD034, no-bare-urls)
115-115: Bare URL used
null
(MD034, no-bare-urls)
116-116: Bare URL used
null
(MD034, no-bare-urls)
127-127: Bare URL used
null
(MD034, no-bare-urls)
128-128: Bare URL used
null
(MD034, no-bare-urls)
136-136: Bare URL used
null
(MD034, no-bare-urls)
137-137: Bare URL used
null
(MD034, no-bare-urls)
138-138: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build and Test - vllm
🔇 Additional comments (3)
ATTRIBUTIONS.md (3)
1-16: License header is correctly specified
The SPDX license header is properly applied with valid identifiers and years, ensuring clear licensing for this documentation.
18-21: Introduction is clear and concise
The section title and description accurately convey the purpose of this attributions file.
140-142: License compliance section is clear
The compliance statement succinctly explains dynamic linking and exception handling.
Overview:
update attributions files post 0.3.0 release
closes: OPS-195
Summary by CodeRabbit