You are viewing a plain text version of this content. The canonical link for it is here.
Posted to gitbox@yetus.apache.org by aw...@apache.org on 2020/10/31 21:53:06 UTC
[yetus] branch main updated: YETUS-1066. fix spelling mistakes
(#186)
This is an automated email from the ASF dual-hosted git repository.
aw pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/yetus.git
The following commit(s) were added to refs/heads/main by this push:
new 1b98330 YETUS-1066. fix spelling mistakes (#186)
1b98330 is described below
commit 1b983301794578fd038d3369b3bc34d3ed39a86a
Author: Allen Wittenauer <aw...@apache.org>
AuthorDate: Sat Oct 31 14:52:53 2020 -0700
YETUS-1066. fix spelling mistakes (#186)
---
.codespellrc | 17 +++++++++++++++++
Jenkinsfile | 2 +-
asf-site-src/source/contribute.html.md | 2 +-
asf-site-src/source/contribute/releases.html.md | 2 +-
asf-site-src/source/documentation/in-progress.html.md | 4 ++--
.../in-progress/precommit/buildtools.html.md | 2 +-
.../in-progress/precommit/docker-cleanup.html.md | 2 +-
.../documentation/in-progress/precommit/docker.html.md | 2 +-
precommit/src/main/shell/core.d/00-yetuslib.sh | 2 +-
precommit/src/main/shell/core.d/01-common.sh | 2 +-
precommit/src/main/shell/core.d/docker.sh | 4 ++--
precommit/src/main/shell/robots.d/jenkins.sh | 2 +-
precommit/src/main/shell/test-patch-docker/Dockerfile | 2 +-
precommit/src/main/shell/test-patch.d/github.sh | 6 +++---
precommit/src/main/shell/test-patch.sh | 8 ++++----
.../src/main/python/releasedocmaker/__init__.py | 2 +-
.../src/main/python/releasedocmaker/utils.py | 2 +-
start-build-env.sh | 2 +-
18 files changed, 41 insertions(+), 24 deletions(-)
diff --git a/.codespellrc b/.codespellrc
new file mode 100644
index 0000000..f34e714
--- /dev/null
+++ b/.codespellrc
@@ -0,0 +1,17 @@
+# 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.
+
+[codespell]
+skip = ./*.css.*,./*.js,./.git/*,./.asf.yaml,./asf-site-src/config.rb,./asf-site-src/Gemfile.lock
\ No newline at end of file
diff --git a/Jenkinsfile b/Jenkinsfile
index 5bbcfd9..0840c93 100644
--- a/Jenkinsfile
+++ b/Jenkinsfile
@@ -64,7 +64,7 @@ pipeline {
USE_DOCKER_FLAG=${USE_DOCKER_FLAG:-true}
# clean and make a new directory for our output artifacts, temporary
- # storage, etc just incase the workspace directory
+ # storage, etc just in case the workspace directory
# delete in post is removed
if [[ -d "${WORKSPACE}/${YETUS_RELATIVE_PATCHDIR}" ]]; then
rm -rf "${WORKSPACE}/${YETUS_RELATIVE_PATCHDIR}"
diff --git a/asf-site-src/source/contribute.html.md b/asf-site-src/source/contribute.html.md
index b8d9801..ab5ec7f 100644
--- a/asf-site-src/source/contribute.html.md
+++ b/asf-site-src/source/contribute.html.md
@@ -42,4 +42,4 @@ The naming of the patch should be in (JIRA).(patch number).patch or, if it needs
Below are guides meant to give you help accomplishing specific tasks for the project:
* [Maintaining the Yetus Website](website) - walks through how to view the website locally, update various static and generated pages, and render the html for publishing.
-* [Working with Release Candiates](releases) - covers managing the release process, validating proposed release candidates, and publishing project approved artifacts.
+* [Working with Release Candidates](releases) - covers managing the release process, validating proposed release candidates, and publishing project approved artifacts.
diff --git a/asf-site-src/source/contribute/releases.html.md b/asf-site-src/source/contribute/releases.html.md
index 288da4d..ed4da51 100644
--- a/asf-site-src/source/contribute/releases.html.md
+++ b/asf-site-src/source/contribute/releases.html.md
@@ -614,7 +614,7 @@ Once a release candidate obtains majority approval from the PMC, there are sever
1. Type the tag that you just pushed into the 'tag' box.
1. Use categories 'Code quality' and 'Continuous integration'
1. Release Title should reflect the version
-1. Describe this release should be a cut-down version of the anouncement email (drop SHA and direct download links. main page, github actions, and release notes should be mentioned)
+1. Describe this release should be a cut-down version of the announcement email (drop SHA and direct download links. main page, github actions, and release notes should be mentioned)
1. Mark 'This is a pre-release'
1. Verify everything looks good.
1. Publish release
diff --git a/asf-site-src/source/documentation/in-progress.html.md b/asf-site-src/source/documentation/in-progress.html.md
index 7046bdb..dac3a07 100644
--- a/asf-site-src/source/documentation/in-progress.html.md
+++ b/asf-site-src/source/documentation/in-progress.html.md
@@ -23,8 +23,8 @@ The [Yetus Precommit build, patch, and CI suite](precommit) allows projects to c
# Yetus Release Doc Maker
-The Release Documentation Maker allows projects to generate nicely formated Markdown Changelogs and Release Notes based upon JIRA. You can view that
-documenation [here](releasedocmaker). See also the [yetus-maven-plugin](#yetus-maven-plugin) for Apache Maven-specific information.
+The Release Documentation Maker allows projects to generate nicely formatted Markdown Changelogs and Release Notes based upon JIRA. You can view that
+documentation [here](releasedocmaker). See also the [yetus-maven-plugin](#yetus-maven-plugin) for Apache Maven-specific information.
# Yetus Shelldocs
diff --git a/asf-site-src/source/documentation/in-progress/precommit/buildtools.html.md b/asf-site-src/source/documentation/in-progress/precommit/buildtools.html.md
index 9e87cec..1cb270f 100644
--- a/asf-site-src/source/documentation/in-progress/precommit/buildtools.html.md
+++ b/asf-site-src/source/documentation/in-progress/precommit/buildtools.html.md
@@ -197,4 +197,4 @@ By default, test-patch will pass -Ptest-patch to Maven. This will allow you to c
Maven will test eclipse and site if maven is being used as the build tool and appropriate files trigger them.
-Maven will trigger add a maven install test when the `maven_add_install` function has been used and the related tests are requierd. Plug-ins that need to run maven before MUST call it as part of their respective initialize functions, otherwise maven may fail unexpectedly. All Apache Yetus provided plug-ins that require maven will trigger the maven install functionality.
+Maven will trigger add a maven install test when the `maven_add_install` function has been used and the related tests are required. Plug-ins that need to run maven before MUST call it as part of their respective initialize functions, otherwise maven may fail unexpectedly. All Apache Yetus provided plug-ins that require maven will trigger the maven install functionality.
diff --git a/asf-site-src/source/documentation/in-progress/precommit/docker-cleanup.html.md b/asf-site-src/source/documentation/in-progress/precommit/docker-cleanup.html.md
index 50ad1fa..c16af5c 100644
--- a/asf-site-src/source/documentation/in-progress/precommit/docker-cleanup.html.md
+++ b/asf-site-src/source/documentation/in-progress/precommit/docker-cleanup.html.md
@@ -29,7 +29,7 @@
# Usage
-Executing `docker-cleanup` will peform the same Docker image as the `--robot` option.
+Executing `docker-cleanup` will perform the same Docker image as the `--robot` option.
```bash
$ docker-cleanup
diff --git a/asf-site-src/source/documentation/in-progress/precommit/docker.html.md b/asf-site-src/source/documentation/in-progress/precommit/docker.html.md
index 131a503..592181c 100644
--- a/asf-site-src/source/documentation/in-progress/precommit/docker.html.md
+++ b/asf-site-src/source/documentation/in-progress/precommit/docker.html.md
@@ -76,7 +76,7 @@ Additionally, if bash v4 and Linux is in use, a separate process is launched to
# Privileged Mode
-In some cases, the work being preformed inside the Docker container requires extra permissions. Using the `--docker-privd` option enables Docker's extended privileges to the container.
+In some cases, the work being performed inside the Docker container requires extra permissions. Using the `--docker-privd` option enables Docker's extended privileges to the container.
# Docker in Docker
diff --git a/precommit/src/main/shell/core.d/00-yetuslib.sh b/precommit/src/main/shell/core.d/00-yetuslib.sh
index 13754f8..1ef0607 100755
--- a/precommit/src/main/shell/core.d/00-yetuslib.sh
+++ b/precommit/src/main/shell/core.d/00-yetuslib.sh
@@ -255,7 +255,7 @@ function yetus_array_to_comma
}
## @description Convert a file to an array.
-## @description Comments on the beginning of the line and emtpy lines are stripped.
+## @description Comments on the beginning of the line and empty lines are stripped.
## @audience public
## @stability evolving
## @replaceable no
diff --git a/precommit/src/main/shell/core.d/01-common.sh b/precommit/src/main/shell/core.d/01-common.sh
index 0f37733..d8f2c87 100755
--- a/precommit/src/main/shell/core.d/01-common.sh
+++ b/precommit/src/main/shell/core.d/01-common.sh
@@ -852,7 +852,7 @@ function generate_stack
exit 1
}
-## @description remove entries from paramater tracker
+## @description remove entries from parameter tracker
## @audience public
## @stability stable
## @replaceable no
diff --git a/precommit/src/main/shell/core.d/docker.sh b/precommit/src/main/shell/core.d/docker.sh
index 4dbf656..82dccff 100755
--- a/precommit/src/main/shell/core.d/docker.sh
+++ b/precommit/src/main/shell/core.d/docker.sh
@@ -306,7 +306,7 @@ function dockercmd
"${DOCKERCMD}" "${subcmd}" "$@"
}
-## @description Convet docker's time format to ctime
+## @description Convert docker's time format to ctime
## @audience private
## @stability evolving
## @replaceable no
@@ -777,7 +777,7 @@ function docker_run_image
--tag "${patchimagename}" \
"${randir}" >/dev/null
retval=$?
- popd >/dev/null || retun 1
+ popd >/dev/null || return 1
rm -rf "${randir}"
diff --git a/precommit/src/main/shell/robots.d/jenkins.sh b/precommit/src/main/shell/robots.d/jenkins.sh
index 8a4c6b4..1be0bfb 100755
--- a/precommit/src/main/shell/robots.d/jenkins.sh
+++ b/precommit/src/main/shell/robots.d/jenkins.sh
@@ -32,7 +32,7 @@ if [[ -n "${JENKINS_URL}" && -n "${EXECUTOR_NUMBER}" ]] &&
USER_PARAMS+=("--empty-patch")
# if we are running in an Jenkins docker container
- # spawed by using agent, then there is a good chance
+ # spawned by using agent, then there is a good chance
# that the user running the test is in a bad state:
# no password entry, no home directory, etc.
if [[ "${HOME}" == / ]]; then
diff --git a/precommit/src/main/shell/test-patch-docker/Dockerfile b/precommit/src/main/shell/test-patch-docker/Dockerfile
index bb0f7d8..d5873f3 100644
--- a/precommit/src/main/shell/test-patch-docker/Dockerfile
+++ b/precommit/src/main/shell/test-patch-docker/Dockerfile
@@ -340,7 +340,7 @@ RUN curl -sSL \
####
# YETUS CUT HERE
-# Anthing after the above line is ignored by Yetus, so could
+# Anything after the above line is ignored by Yetus, so could
# include other requirements not needed by your development
# (but not build) environment
###
diff --git a/precommit/src/main/shell/test-patch.d/github.sh b/precommit/src/main/shell/test-patch.d/github.sh
index 1b10005..eb01f1e 100755
--- a/precommit/src/main/shell/test-patch.d/github.sh
+++ b/precommit/src/main/shell/test-patch.d/github.sh
@@ -147,7 +147,7 @@ function github_breakup_url
fi
}
-## @description initalize github
+## @description initialize github
function github_initialize
{
if [[ -z "${GITHUB_REPO}" ]]; then
@@ -733,7 +733,7 @@ function github_finalreport
# Customize the message based upon type of passing:
# - if there were no warnings, then just put a single message
- # - if there were warningss, but no logs, then just mention warnings
+ # - if there were warnings, but no logs, then just mention warnings
# - if there were warnings and logs, handle in the next section
if [[ "${result}" == 0 ]]; then
i=0
@@ -782,7 +782,7 @@ function github_finalreport
# give a separate status for each:
# - failure
# - failure w/log
- # - successs w/warning log
+ # - success w/warning log
i=0
until [[ ${i} -eq ${#TP_VOTE_TABLE[@]} ]]; do
diff --git a/precommit/src/main/shell/test-patch.sh b/precommit/src/main/shell/test-patch.sh
index f806515..f0cf777 100755
--- a/precommit/src/main/shell/test-patch.sh
+++ b/precommit/src/main/shell/test-patch.sh
@@ -1294,7 +1294,7 @@ function git_checkout
}
## @description Confirm the given branch is a git reference
-## @descriptoin or a valid gitXYZ commit hash
+## @description or a valid gitXYZ commit hash
## @audience private
## @stability evolving
## @replaceable no
@@ -2394,7 +2394,7 @@ function runtests
## @description Calculate the differences between the specified files
## @description using just the column+ messages (third+ column in a
-## @descriptoin colon delimated flie) and output it to stdout.
+## @description colon delimated file) and output it to stdout.
## @audience public
## @stability evolving
## @replaceable no
@@ -2439,7 +2439,7 @@ function column_calcdiffs
## @description Calculate the differences between the specified files
## @description using just the error messages (last column in a
-## @descriptoin colon delimated flie) and output it to stdout.
+## @description colon delimated file) and output it to stdout.
## @audience public
## @stability evolving
## @replaceable no
@@ -2516,7 +2516,7 @@ function calcdiffs
fi
}
-## @description generate a standarized calcdiff status message
+## @description generate a standardized calcdiff status message
## @audience public
## @stability evolving
## @replaceable no
diff --git a/releasedocmaker/src/main/python/releasedocmaker/__init__.py b/releasedocmaker/src/main/python/releasedocmaker/__init__.py
index 5778c06..16fa7ed 100755
--- a/releasedocmaker/src/main/python/releasedocmaker/__init__.py
+++ b/releasedocmaker/src/main/python/releasedocmaker/__init__.py
@@ -305,7 +305,7 @@ class Jira(object):
return self.incompat
def get_important(self):
- """ get importat flag """
+ """ get important flag """
if self.important is None:
field = self.parent.field_id_map['Flags']
self.important = False
diff --git a/releasedocmaker/src/main/python/releasedocmaker/utils.py b/releasedocmaker/src/main/python/releasedocmaker/utils.py
index ae57fd1..3964671 100755
--- a/releasedocmaker/src/main/python/releasedocmaker/utils.py
+++ b/releasedocmaker/src/main/python/releasedocmaker/utils.py
@@ -172,7 +172,7 @@ class Outputs(object):
self.others[key].write(pattern % both)
def write_key_raw(self, key, input_string):
- """ write everything withotu changes """
+ """ write everything without changes """
self.base.write(input_string)
if key in self.others:
self.others[key].write(input_string)
diff --git a/start-build-env.sh b/start-build-env.sh
index aeb1bff..8c192ca 100755
--- a/start-build-env.sh
+++ b/start-build-env.sh
@@ -117,7 +117,7 @@ if [[ ! -d ${HOME}/.gnupg ]]; then
fi
dockerargs+=(-v "${HOME}/.gnupg:/home/${USER_NAME}/.gnupg${V_OPTS:-}")
-# git opertions
+# git operations
if [[ ! -d ${HOME}/.ssh ]]; then
mkdir "${HOME}/.ssh"
fi