From 26b43fadb4552d522c158a9b62d3b21144076570 Mon Sep 17 00:00:00 2001
From: Whisperity <whisperity@gmail.com>
Date: Wed, 8 Jun 2022 11:39:14 +0200
Subject: [PATCH] chore(docs): Explicitly mention that `llvm-version` must be
 the major version

---
 README.md  | 12 ++++++------
 action.yml |  2 +-
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 6db6428..d649c54 100644
--- a/README.md
+++ b/README.md
@@ -300,12 +300,12 @@ Please refer to earlier parts of the documentation for the configuration of thes
 
 ### Versions to install
 
-| Variable         | Default                                                          | Description                                                                                                                                                                                                                                                               |
-|------------------|------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `llvm-version`   | `latest`                                                         | The major version of LLVM to install and use. LLVM is installed from [PPA](http://apt.llvm.org/). If `latest`, automatically gather the latest version. If `ignore`, don't install anything. (Not recommended)                                                            |
-| `install-custom` | `false`                                                          | If set to `true`, opens the ability to locally clone and install CodeChecker from the specified `repository` and `version`. Otherwise, `version` is taken as a release version, and the [CodeChecker suite from PyPI](http://pypi.org/project/codechecker) is downloaded. |
-| `repository`     | [`Ericsson/CodeChecker`](http://github.com/Ericsson/CodeChecker) | The CodeChecker repository to check out and build, if `install-custom` is `true`.                                                                                                                                                                                         |
-| `version`        | `master`                                                         | If `install-custom` is `false`, the release version (e.g. `6.18.0`) to download from PyPI, or `master` to fetch the latest release. Otherwise, the branch (defaulting to `master`), tag, or commit SHA in the `repository` to check out.                                  |
+| Variable         | Default                                                          | Description                                                                                                                                                                                                                                                                                                                                      |
+|------------------|------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `llvm-version`   | `latest`                                                         | The major version of LLVM to install and use. LLVM is installed from the community [PPA](http://apt.llvm.org/). The value **MUST** be a major version (e.g. `13`) that is supported by the _PPA_ for the OS used! If `latest`, automatically gather the latest (yet unreleased) version. If `ignore`, don't install anything. (Not recommended.) |
+| `install-custom` | `false`                                                          | If set to `true`, opens the ability to locally clone and install CodeChecker from the specified `repository` and `version`. Otherwise, `version` is taken as a release version, and the [CodeChecker suite from PyPI](http://pypi.org/project/codechecker) is downloaded.                                                                        |
+| `repository`     | [`Ericsson/CodeChecker`](http://github.com/Ericsson/CodeChecker) | The CodeChecker repository to check out and build, if `install-custom` is `true`.                                                                                                                                                                                                                                                                |
+| `version`        | `master`                                                         | If `install-custom` is `false`, the release version (e.g. `6.18.0`) to download from PyPI, or `master` to fetch the latest release. Otherwise, the branch (defaulting to `master`), tag, or commit SHA in the `repository` to check out.                                                                                                         |
 
 ### Build log configuration
 
diff --git a/action.yml b/action.yml
index 1a5f2e6..7ba81a2 100644
--- a/action.yml
+++ b/action.yml
@@ -19,7 +19,7 @@ inputs:
     required: true
     default: 'master'
   llvm-version:
-    description: 'The major version of LLVM to install and use. LLVM is installed from PPA. If "latest", automatically gather the latest version. If "ignore", do not install anything. (Not recommended)'
+    description: 'The major version of LLVM to install and use. LLVM is installed from the community PPA at http://apt.llvm.org. The value MUST be a major version (e.g. 13) that is supported by the PPA for the OS used! If "latest", automatically gather the latest version. If "ignore", do not install anything. (Not recommended.)'
     required: true
     default: 'latest'