From a64c2bc28e641aefaa433333ae8fd44660bc0dd5 Mon Sep 17 00:00:00 2001 From: Zygmunt Krynicki Date: Wed, 1 Feb 2023 15:24:34 +0100 Subject: [PATCH] Fix several typos (#1314) Those were discorvered while casually browsing the source code in an IDE. Signed-off-by: Zygmunt Krynicki --- CONTRIBUTING.md | 2 +- docs/content/ui.md | 2 +- docs/content/whatishawkbit.md | 4 ++-- .../DistributedResourceBundleMessageSource.java | 4 ++-- .../artifact/repository/ArtifactRepository.java | 4 ++-- .../eclipse/hawkbit/cache/DefaultDownloadIdCache.java | 2 +- .../repository/jpa/HawkBitEclipseLinkJpaDialect.java | 2 +- .../hawkbit/repository/jpa/rsql/PropertyMapper.java | 10 +++++----- 8 files changed, 15 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1755abb19..32be36d87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,7 @@ Examples: ### Test documentation -Please documented the test cases that you contribute by means of [Allure](https://docs.qameta.io/allure/) annotations and proper test method naming. +Please document the test cases that you contribute by means of [Allure](https://docs.qameta.io/allure/) annotations and proper test method naming. All test classes are documented with [Allure's](https://docs.qameta.io/allure/#_behaviours_mapping) **@Feature** and **@Story** annotations in the following format: diff --git a/docs/content/ui.md b/docs/content/ui.md index 5eea41da3..7ab53d10e 100644 --- a/docs/content/ui.md +++ b/docs/content/ui.md @@ -104,7 +104,7 @@ Software rollout in large scale, rollout status overview and rollout management. - Selection of _distribution set_ - Auto-splitting of the input target list based on _group number_ defined - _Trigger threshold_ to define the percentage of installation to be completed , to trigger the start of next group - - _Error threshold_ defines the percentage of error tolerance of a group before calling for a emergency shutdown of a rollout + - _Error threshold_ defines the percentage of error tolerance of a group before calling for an emergency shutdown of a rollout ![Rollout Management view](../images/ui/rollout_mgmt.png) diff --git a/docs/content/whatishawkbit.md b/docs/content/whatishawkbit.md index 9fd1f9b5a..c1b091fdb 100755 --- a/docs/content/whatishawkbit.md +++ b/docs/content/whatishawkbit.md @@ -2,7 +2,7 @@ title: What is hawkBit? weight: 10 --- -Eclipse hawkBit™ is an domain-independent back-end framework for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure. +Eclipse hawkBit™ is a domain-independent back-end framework for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure. ![](../images/hawkbit_logo.png) @@ -11,7 +11,7 @@ Having software update capabilities ensures a secure IoT by means that it gives A more charming argument for software update is that it enables agile development for hardware and hardware near development. Concepts like a minimum viable product can be applied for devices as not all features need to be ready at manufacturing time. Changes on the cloud side of the IoT project can be applied to the devices at runtime as well. -Sometimes Software Update is a business model on its own as it makes devices much more attractive to the customer if they are updateable, i.e. they do not only buy a product because of its current feature set but make also a bet on its future capabilities. In addition new revenue streams may arise from the fact that feature extensions can potentially be monetized (e.g. Apps) without the need to design, manufacture and ship a new device (revision). +Sometimes Software Update is a business model on its own as it makes devices much more attractive to the customer if they are updatable, i.e. they do not only buy a product because of its current feature set but make also a bet on its future capabilities. In addition new revenue streams may arise from the fact that feature extensions can potentially be monetized (e.g. Apps) without the need to design, manufacture and ship a new device (revision). ## Why hawkBit? diff --git a/hawkbit-core/src/main/java/org/eclipse/hawkbit/DistributedResourceBundleMessageSource.java b/hawkbit-core/src/main/java/org/eclipse/hawkbit/DistributedResourceBundleMessageSource.java index 0f5301c40..e772c98c3 100644 --- a/hawkbit-core/src/main/java/org/eclipse/hawkbit/DistributedResourceBundleMessageSource.java +++ b/hawkbit-core/src/main/java/org/eclipse/hawkbit/DistributedResourceBundleMessageSource.java @@ -46,7 +46,7 @@ public class DistributedResourceBundleMessageSource extends ReloadableResourceBu long lastModified = -1; if (!(resourceLoader instanceof ResourcePatternResolver)) { LOGGER.warn( - "Resource Loader {} doensn't support getting multiple resources. Default properties mechanism will used", + "Resource Loader {} doesn't support getting multiple resources. Default properties mechanism will used", resourceLoader.getClass().getName()); return super.refreshProperties(filename, propHolder); } @@ -63,7 +63,7 @@ public class DistributedResourceBundleMessageSource extends ReloadableResourceBu } } } catch (final IOException ignored) { - LOGGER.warn("Resource with filname " + filename + " couldn't load", ignored); + LOGGER.warn("Resource with filename " + filename + " couldn't load", ignored); } return new PropertiesHolder(properties, lastModified); } diff --git a/hawkbit-core/src/main/java/org/eclipse/hawkbit/artifact/repository/ArtifactRepository.java b/hawkbit-core/src/main/java/org/eclipse/hawkbit/artifact/repository/ArtifactRepository.java index fc2a5f8db..f1adcba84 100644 --- a/hawkbit-core/src/main/java/org/eclipse/hawkbit/artifact/repository/ArtifactRepository.java +++ b/hawkbit-core/src/main/java/org/eclipse/hawkbit/artifact/repository/ArtifactRepository.java @@ -64,7 +64,7 @@ public interface ArtifactRepository { void deleteBySha1(@NotEmpty String tenant, @NotEmpty String sha1Hash); /** - * Retrieves a {@link AbstractDbArtifact} from the store by it's SHA1 hash. + * Retrieves a {@link AbstractDbArtifact} from the store by its SHA1 hash. * * @param tenant * the tenant to store the artifact @@ -93,7 +93,7 @@ public interface ArtifactRepository { * @param sha1Hash * the sha1-hash of the file to lookup. * - * @return the boolean whether the atrifact exists or not + * @return the boolean whether the artifact exists or not */ boolean existsByTenantAndSha1(@NotEmpty String tenant, @NotEmpty String sha1Hash); } diff --git a/hawkbit-core/src/main/java/org/eclipse/hawkbit/cache/DefaultDownloadIdCache.java b/hawkbit-core/src/main/java/org/eclipse/hawkbit/cache/DefaultDownloadIdCache.java index 0b6c7029d..9ac106c47 100644 --- a/hawkbit-core/src/main/java/org/eclipse/hawkbit/cache/DefaultDownloadIdCache.java +++ b/hawkbit-core/src/main/java/org/eclipse/hawkbit/cache/DefaultDownloadIdCache.java @@ -20,7 +20,7 @@ import org.springframework.cache.CacheManager; */ public class DefaultDownloadIdCache implements DownloadIdCache { - static final String DOWNLOAD_ID_CACHE = "DowonloadIdCache"; + static final String DOWNLOAD_ID_CACHE = "DownloadIdCache"; private final CacheManager cacheManager; diff --git a/hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/HawkBitEclipseLinkJpaDialect.java b/hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/HawkBitEclipseLinkJpaDialect.java index d9e8a7ccc..8f902b9c7 100644 --- a/hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/HawkBitEclipseLinkJpaDialect.java +++ b/hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/HawkBitEclipseLinkJpaDialect.java @@ -44,7 +44,7 @@ import org.springframework.orm.jpa.vendor.EclipseLinkJpaDialect; * 3.a) here a cause might be an {@link SQLException} which might be mappable by * {@link SQLStateSQLExceptionTranslator} or *

- * 3.b.) the the cause is not an {@link SQLException} and as a result cannot be + * 3.b.) the cause is not an {@link SQLException} and as a result cannot be * mapped. * */ diff --git a/hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/rsql/PropertyMapper.java b/hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/rsql/PropertyMapper.java index e3560e81c..a7787dd54 100644 --- a/hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/rsql/PropertyMapper.java +++ b/hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/rsql/PropertyMapper.java @@ -12,14 +12,14 @@ import java.util.HashMap; import java.util.Map; /** - * Maps property of entity to its allias . + * Maps property of entity to its alias . * * * */ public final class PropertyMapper { - private static Map, Map> allowedColmns = new HashMap<>(); + private static Map, Map> allowedColumns = new HashMap<>(); private PropertyMapper() { @@ -36,15 +36,15 @@ public final class PropertyMapper { * property name */ public static void addNewMapping(final Class type, final String property, final String mapping) { - allowedColmns.computeIfAbsent(type, k -> new HashMap<>()); - allowedColmns.get(type).put(property, mapping); + allowedColumns.computeIfAbsent(type, k -> new HashMap<>()); + allowedColumns.get(type).put(property, mapping); } /** * @return the allowedcolmns */ public static Map, Map> getAllowedcolmns() { - return allowedColmns; + return allowedColumns; } }