From fdd919ced811f0241aa0a024b89ecd3c0e81e150 Mon Sep 17 00:00:00 2001
From: Daniele Cattaneo <daniele3.cattaneo@mail.polimi.it>
Date: Tue, 11 Apr 2023 20:03:39 +0200
Subject: [PATCH] Minor fixes to the comments.
Signed-off-by: Terraneo Federico <fede.tft@miosix.org>
---
miosix/config/miosix_settings.h | 4 ++--
miosix/kernel/sync.h | 6 +++---
miosix/stdlib_integration/libc_integration.h | 4 ++--
3 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/miosix/config/miosix_settings.h b/miosix/config/miosix_settings.h
index 3d132c9a..57cdc3f7 100644
--- a/miosix/config/miosix_settings.h
+++ b/miosix/config/miosix_settings.h
@@ -78,8 +78,8 @@ namespace miosix {
/// \def WITH_CPU_TIME_COUNTER
/// Allows to enable/disable CPUTimeCounter to save code size and remove its
-/// overhead from the scheduling process. By default it is defined
-/// (CPUTimeCounter is enabled).
+/// overhead from the scheduling process. By default it is not defined
+/// (CPUTimeCounter is disabled).
//#define WITH_CPU_TIME_COUNTER
//
diff --git a/miosix/kernel/sync.h b/miosix/kernel/sync.h
index fde9399b..626846ae 100644
--- a/miosix/kernel/sync.h
+++ b/miosix/kernel/sync.h
@@ -244,7 +244,7 @@ private:
bool PKunlock(PauseKernelLock& dLock);
/**
- * Unlock mutex all levels of a recursive mutex, can be called only with
+ * Unlock all levels of a recursive mutex, can be called only with
* kernel paused one level deep (pauseKernel calls can be nested).<br>
* \param dLock the PauseKernelLock instance that paused the kernel.
* \return the mutex recursive depth (how many times it was locked by the
@@ -314,7 +314,7 @@ private:
};
/**
- * This class allows to temporarily re unlock a mutex in a scope where
+ * This class allows to temporarily re-unlock a mutex in a scope where
* it is locked <br>
* Example:
* \code
@@ -409,7 +409,7 @@ enum class TimedWaitResult
* A condition variable class for thread synchronization, available from
* Miosix 1.53.<br>
* One or more threads can wait on the condition variable, and the signal()
- * and broadcast() allow to wake ne or all the waiting threads.<br>
+ * and broadcast() methods allow to wake one or all the waiting threads.<br>
* This class is meant to be a static or global class. Dynamically creating a
* ConditionVariable with new or on the stack must be done with care, to avoid
* deleting a ConditionVariable while some threads are waiting, and to avoid
diff --git a/miosix/stdlib_integration/libc_integration.h b/miosix/stdlib_integration/libc_integration.h
index 16df08f8..8e60d294 100644
--- a/miosix/stdlib_integration/libc_integration.h
+++ b/miosix/stdlib_integration/libc_integration.h
@@ -82,8 +82,8 @@ inline void ll2timespec(long long ns, struct timespec *tp)
// Despite there being a single intrinsic, __aeabi_ldivmod, that computes
// both the result of the / and % operator, GCC 9.2.0 isn't smart enough and
// calls the intrinsic twice. This asm implementation takes ~188 cycles
- // instead of ~316 by calling it once. Sadly, I had to use asm as the
- // calling conventions of the intrinsic appear to be nonstandard.
+ // instead of ~316 by calling it once. Sadly I had to use asm, as the
+ // calling convention of the intrinsic appears to be nonstandard.
// NOTE: actually a and b, by being 64 bit numbers, occupy register pairs
register long long a asm("r0") = ns;
register long long b asm("r2") = nsPerSec;
--
GitLab