Fix some typos #123506
Merged
Fix some typos #123506
Conversation
This file contains 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
|
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be notified. If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers. If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
llvmbot
added
clang
|
@llvm/pr-subscribers-clang-tools-extra Author: None (DeNiCoN) ChangesFixes some typos I've found while reading the documentation Full diff: https://github.com/llvm/llvm-project/pull/123506.diff 6 Files Affected:
diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst
index ff8b05ff263c14..4f1df8d1144444 100644
--- a/clang-tools-extra/docs/clang-tidy/Contributing.rst
+++ b/clang-tools-extra/docs/clang-tidy/Contributing.rst
@@ -331,7 +331,7 @@ a starting point for your test cases. A rough outline of the process looks like
- Issue the necessary diagnostics and fix-its in the ``check`` method.
- Add the necessary ``CHECK-MESSAGES`` and ``CHECK-FIXES`` annotations to your
test case to validate the diagnostics and fix-its.
-- Build the target ``check-clang-tool`` to confirm the test passes.
+- Build the target ``check-clang-tools`` to confirm the test passes.
- Repeat the process until all aspects of your check are covered by tests.
The quickest way to prototype your matcher is to use :program:`clang-query` to
@@ -519,8 +519,8 @@ the check implements and what the current values are (e.g. for the
public:
MyCheck(StringRef Name, ClangTidyContext *Context)
: ClangTidyCheck(Name, Context),
- SomeOption(Options.get("SomeOption1", -1U)),
- SomeOption(Options.get("SomeOption2", "some default")) {}
+ SomeOption1(Options.get("SomeOption1", -1U)),
+ SomeOption2(Options.get("SomeOption2", "some default")) {}
void storeOptions(ClangTidyOptions::OptionMap &Opts) override {
Options.store(Opts, "SomeOption1", SomeOption1);
diff --git a/clang/docs/ClangTransformerTutorial.rst b/clang/docs/ClangTransformerTutorial.rst
index b07b83f80f17d1..e9b701203300a2 100644
--- a/clang/docs/ClangTransformerTutorial.rst
+++ b/clang/docs/ClangTransformerTutorial.rst
@@ -70,7 +70,7 @@ can express this a Transformer rewrite rule:
.. code-block:: c++
- makeRule(functionDecl(hasName("MkX").bind("fun"),
+ makeRule(functionDecl(hasName("MkX")).bind("fun"),
noopEdit(node("fun")),
cat("The name ``MkX`` is not allowed for functions; please rename"));
diff --git a/clang/include/clang/Basic/Diagnostic.h b/clang/include/clang/Basic/Diagnostic.h
index 510b782e35d065..8708bd10dc4014 100644
--- a/clang/include/clang/Basic/Diagnostic.h
+++ b/clang/include/clang/Basic/Diagnostic.h
@@ -224,7 +224,7 @@ class DiagStorageAllocator {
/// Concrete class used by the front-end to report problems and issues.
///
-/// This massages the diagnostics (e.g. handling things like "report warnings
+/// This messages the diagnostics (e.g. handling things like "report warnings
/// as errors" and passes them off to the DiagnosticConsumer for reporting to
/// the user. DiagnosticsEngine is tied to one translation unit and one
/// SourceManager.
diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst
index 6614d036a014e9..18b05d2e58e6e5 100644
--- a/llvm/docs/DeveloperPolicy.rst
+++ b/llvm/docs/DeveloperPolicy.rst
@@ -136,7 +136,7 @@ awareness of. For such changes, the following should be done:
.. warning::
- Phabricator is deprecated is available in read-only mode,
+ Phabricator is deprecated and is available in read-only mode,
for new code contributions use :ref:`GitHub Pull Requests <github-reviews>`.
This section contains old information that needs to be updated.
diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst
index 85766bfe94afd2..df0b4841a7bb58 100644
--- a/llvm/docs/GitHub.rst
+++ b/llvm/docs/GitHub.rst
@@ -50,7 +50,7 @@ documentation refer to `GitHub's documentation <https://docs.github.com/pull-req
.. note::
If you are using a Pull Request for purposes other than review
(eg: precommit CI results, convenient web-based reverts, etc)
- `skip-precommit-approval <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`_
+ add a `skip-precommit-approval <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`_
label to the PR.
GitHub Tools
diff --git a/llvm/docs/MyFirstTypoFix.rst b/llvm/docs/MyFirstTypoFix.rst
index 733b3eac141f27..5856615bee8bfa 100644
--- a/llvm/docs/MyFirstTypoFix.rst
+++ b/llvm/docs/MyFirstTypoFix.rst
@@ -378,7 +378,7 @@ your branch with more commits and push to your GitHub fork of ``llvm-project``.
It is best if you answer comments from the reviewer directly instead of expecting
them to read through all the changes again.
-For example you might comment "I have done this." or "I was able to this part
+For example you might comment "I have done this." or "I was able to do this part
but have a question about...".
Review expectations
|
|
@llvm/pr-subscribers-clang-tidy Author: None (DeNiCoN) ChangesFixes some typos I've found while reading the documentation Full diff: https://github.com/llvm/llvm-project/pull/123506.diff 6 Files Affected:
diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst
index ff8b05ff263c14..4f1df8d1144444 100644
--- a/clang-tools-extra/docs/clang-tidy/Contributing.rst
+++ b/clang-tools-extra/docs/clang-tidy/Contributing.rst
@@ -331,7 +331,7 @@ a starting point for your test cases. A rough outline of the process looks like
- Issue the necessary diagnostics and fix-its in the ``check`` method.
- Add the necessary ``CHECK-MESSAGES`` and ``CHECK-FIXES`` annotations to your
test case to validate the diagnostics and fix-its.
-- Build the target ``check-clang-tool`` to confirm the test passes.
+- Build the target ``check-clang-tools`` to confirm the test passes.
- Repeat the process until all aspects of your check are covered by tests.
The quickest way to prototype your matcher is to use :program:`clang-query` to
@@ -519,8 +519,8 @@ the check implements and what the current values are (e.g. for the
public:
MyCheck(StringRef Name, ClangTidyContext *Context)
: ClangTidyCheck(Name, Context),
- SomeOption(Options.get("SomeOption1", -1U)),
- SomeOption(Options.get("SomeOption2", "some default")) {}
+ SomeOption1(Options.get("SomeOption1", -1U)),
+ SomeOption2(Options.get("SomeOption2", "some default")) {}
void storeOptions(ClangTidyOptions::OptionMap &Opts) override {
Options.store(Opts, "SomeOption1", SomeOption1);
diff --git a/clang/docs/ClangTransformerTutorial.rst b/clang/docs/ClangTransformerTutorial.rst
index b07b83f80f17d1..e9b701203300a2 100644
--- a/clang/docs/ClangTransformerTutorial.rst
+++ b/clang/docs/ClangTransformerTutorial.rst
@@ -70,7 +70,7 @@ can express this a Transformer rewrite rule:
.. code-block:: c++
- makeRule(functionDecl(hasName("MkX").bind("fun"),
+ makeRule(functionDecl(hasName("MkX")).bind("fun"),
noopEdit(node("fun")),
cat("The name ``MkX`` is not allowed for functions; please rename"));
diff --git a/clang/include/clang/Basic/Diagnostic.h b/clang/include/clang/Basic/Diagnostic.h
index 510b782e35d065..8708bd10dc4014 100644
--- a/clang/include/clang/Basic/Diagnostic.h
+++ b/clang/include/clang/Basic/Diagnostic.h
@@ -224,7 +224,7 @@ class DiagStorageAllocator {
/// Concrete class used by the front-end to report problems and issues.
///
-/// This massages the diagnostics (e.g. handling things like "report warnings
+/// This messages the diagnostics (e.g. handling things like "report warnings
/// as errors" and passes them off to the DiagnosticConsumer for reporting to
/// the user. DiagnosticsEngine is tied to one translation unit and one
/// SourceManager.
diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst
index 6614d036a014e9..18b05d2e58e6e5 100644
--- a/llvm/docs/DeveloperPolicy.rst
+++ b/llvm/docs/DeveloperPolicy.rst
@@ -136,7 +136,7 @@ awareness of. For such changes, the following should be done:
.. warning::
- Phabricator is deprecated is available in read-only mode,
+ Phabricator is deprecated and is available in read-only mode,
for new code contributions use :ref:`GitHub Pull Requests <github-reviews>`.
This section contains old information that needs to be updated.
diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst
index 85766bfe94afd2..df0b4841a7bb58 100644
--- a/llvm/docs/GitHub.rst
+++ b/llvm/docs/GitHub.rst
@@ -50,7 +50,7 @@ documentation refer to `GitHub's documentation <https://docs.github.com/pull-req
.. note::
If you are using a Pull Request for purposes other than review
(eg: precommit CI results, convenient web-based reverts, etc)
- `skip-precommit-approval <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`_
+ add a `skip-precommit-approval <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`_
label to the PR.
GitHub Tools
diff --git a/llvm/docs/MyFirstTypoFix.rst b/llvm/docs/MyFirstTypoFix.rst
index 733b3eac141f27..5856615bee8bfa 100644
--- a/llvm/docs/MyFirstTypoFix.rst
+++ b/llvm/docs/MyFirstTypoFix.rst
@@ -378,7 +378,7 @@ your branch with more commits and push to your GitHub fork of ``llvm-project``.
It is best if you answer comments from the reviewer directly instead of expecting
them to read through all the changes again.
-For example you might comment "I have done this." or "I was able to this part
+For example you might comment "I have done this." or "I was able to do this part
but have a question about...".
Review expectations
|
|
@llvm/pr-subscribers-clang Author: None (DeNiCoN) ChangesFixes some typos I've found while reading the documentation Full diff: https://github.com/llvm/llvm-project/pull/123506.diff 6 Files Affected:
diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst
index ff8b05ff263c14..4f1df8d1144444 100644
--- a/clang-tools-extra/docs/clang-tidy/Contributing.rst
+++ b/clang-tools-extra/docs/clang-tidy/Contributing.rst
@@ -331,7 +331,7 @@ a starting point for your test cases. A rough outline of the process looks like
- Issue the necessary diagnostics and fix-its in the ``check`` method.
- Add the necessary ``CHECK-MESSAGES`` and ``CHECK-FIXES`` annotations to your
test case to validate the diagnostics and fix-its.
-- Build the target ``check-clang-tool`` to confirm the test passes.
+- Build the target ``check-clang-tools`` to confirm the test passes.
- Repeat the process until all aspects of your check are covered by tests.
The quickest way to prototype your matcher is to use :program:`clang-query` to
@@ -519,8 +519,8 @@ the check implements and what the current values are (e.g. for the
public:
MyCheck(StringRef Name, ClangTidyContext *Context)
: ClangTidyCheck(Name, Context),
- SomeOption(Options.get("SomeOption1", -1U)),
- SomeOption(Options.get("SomeOption2", "some default")) {}
+ SomeOption1(Options.get("SomeOption1", -1U)),
+ SomeOption2(Options.get("SomeOption2", "some default")) {}
void storeOptions(ClangTidyOptions::OptionMap &Opts) override {
Options.store(Opts, "SomeOption1", SomeOption1);
diff --git a/clang/docs/ClangTransformerTutorial.rst b/clang/docs/ClangTransformerTutorial.rst
index b07b83f80f17d1..e9b701203300a2 100644
--- a/clang/docs/ClangTransformerTutorial.rst
+++ b/clang/docs/ClangTransformerTutorial.rst
@@ -70,7 +70,7 @@ can express this a Transformer rewrite rule:
.. code-block:: c++
- makeRule(functionDecl(hasName("MkX").bind("fun"),
+ makeRule(functionDecl(hasName("MkX")).bind("fun"),
noopEdit(node("fun")),
cat("The name ``MkX`` is not allowed for functions; please rename"));
diff --git a/clang/include/clang/Basic/Diagnostic.h b/clang/include/clang/Basic/Diagnostic.h
index 510b782e35d065..8708bd10dc4014 100644
--- a/clang/include/clang/Basic/Diagnostic.h
+++ b/clang/include/clang/Basic/Diagnostic.h
@@ -224,7 +224,7 @@ class DiagStorageAllocator {
/// Concrete class used by the front-end to report problems and issues.
///
-/// This massages the diagnostics (e.g. handling things like "report warnings
+/// This messages the diagnostics (e.g. handling things like "report warnings
/// as errors" and passes them off to the DiagnosticConsumer for reporting to
/// the user. DiagnosticsEngine is tied to one translation unit and one
/// SourceManager.
diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst
index 6614d036a014e9..18b05d2e58e6e5 100644
--- a/llvm/docs/DeveloperPolicy.rst
+++ b/llvm/docs/DeveloperPolicy.rst
@@ -136,7 +136,7 @@ awareness of. For such changes, the following should be done:
.. warning::
- Phabricator is deprecated is available in read-only mode,
+ Phabricator is deprecated and is available in read-only mode,
for new code contributions use :ref:`GitHub Pull Requests <github-reviews>`.
This section contains old information that needs to be updated.
diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst
index 85766bfe94afd2..df0b4841a7bb58 100644
--- a/llvm/docs/GitHub.rst
+++ b/llvm/docs/GitHub.rst
@@ -50,7 +50,7 @@ documentation refer to `GitHub's documentation <https://docs.github.com/pull-req
.. note::
If you are using a Pull Request for purposes other than review
(eg: precommit CI results, convenient web-based reverts, etc)
- `skip-precommit-approval <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`_
+ add a `skip-precommit-approval <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`_
label to the PR.
GitHub Tools
diff --git a/llvm/docs/MyFirstTypoFix.rst b/llvm/docs/MyFirstTypoFix.rst
index 733b3eac141f27..5856615bee8bfa 100644
--- a/llvm/docs/MyFirstTypoFix.rst
+++ b/llvm/docs/MyFirstTypoFix.rst
@@ -378,7 +378,7 @@ your branch with more commits and push to your GitHub fork of ``llvm-project``.
It is best if you answer comments from the reviewer directly instead of expecting
them to read through all the changes again.
-For example you might comment "I have done this." or "I was able to this part
+For example you might comment "I have done this." or "I was able to do this part
but have a question about...".
Review expectations
|
HerrCai0907
approved these changes
Jan 19, 2025
cor3ntin
reviewed
Jan 19, 2025
| @@ -224,7 +224,7 @@ class DiagStorageAllocator { | |||
|
|
|||
| /// Concrete class used by the front-end to report problems and issues. | |||
| /// | |||
| /// This massages the diagnostics (e.g. handling things like "report warnings | |||
| /// This messages the diagnostics (e.g. handling things like "report warnings | |||
There was a problem hiding this comment.
I think massages is correct here (as in adapts/cleans up)
There was a problem hiding this comment.
I'm not sure. This is an old comment so I think its better to left it as is. Reverted the change
llvm/docs/GitHub.rst
Outdated
| @@ -50,7 +50,7 @@ documentation refer to `GitHub's documentation <https://docs.github.com/pull-req | |||
| .. note:: | |||
| If you are using a Pull Request for purposes other than review | |||
| (eg: precommit CI results, convenient web-based reverts, etc) | |||
| `skip-precommit-approval <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`_ | |||
| add a `skip-precommit-approval <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`_ | |||
There was a problem hiding this comment.
Suggested change
| add a `skip-precommit-approval <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`_ | |
| add the `skip-precommit-approval <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`_ |
cor3ntin
approved these changes
Jan 19, 2025
|
@cor3ntin Yes. Thank you. Should I squash the commits or this can be done on your side? |
|
@DeNiCoN Congratulations on having your first Pull Request (PR) merged into the LLVM Project! Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR. Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues. How to do this, and the rest of the post-merge process, is covered in detail here. If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again. If you don't get any reports, no action is required from you. Your changes are working as expected, well done! |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/59/builds/11328 Here is the relevant piece of the build log for the reference |
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.
Fixes some typos I've found while reading the documentation