Fix up versions and doc-lints

MarcusGrass · Aug 24, 2024 · cbcdaba · cbcdaba
1 parent acd7c63
commit cbcdaba
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 22 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/rusl/Cargo.toml b/rusl/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "rusl"
-version = "0.3.0"
+version = "0.3.1"
 edition = "2021"
 license = "MPL-2.0"
 readme = "../Readme.md"

diff --git a/rusl/Changelog.md b/rusl/Changelog.md
@@ -10,7 +10,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
-## [0.3.1] - RELEASE DATE
+## [0.3.1] - 2024-08-24
+
 ### Fixed
 
 ### Added

diff --git a/tiny-cli/Cargo.toml b/tiny-cli/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "tiny-cli"
-version = "0.2.1"
+version = "0.3.0"
 edition = "2021"
 license = "MPL-2.0"
 readme = "../Readme.md"

diff --git a/tiny-cli/Changelog.md b/tiny-cli/Changelog.md
@@ -11,6 +11,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
+## [v0.3.0] - 2024-08-24
+
+### Fixed
+- Some aliases not registering properly
+
+### Added
+- Positional arguments now accepted, and the default for untagged fields
+
+### Changed
+- Bools are always optional and should never be specified as `True` or `False`
+- Options must now be specified as either `long` or `short` with their alias
+
 ## [v0.2.1] - 2024-05-05
 ### Fixed
 

diff --git a/tiny-std/src/allocator/dlmalloc.rs b/tiny-std/src/allocator/dlmalloc.rs
@@ -1455,7 +1455,7 @@ impl Dlmalloc {
             released += self.release_unused_segments();
 
             if released == 0 && self.topsize > self.trim_check {
-                self.trim_check = usize::max_value();
+                self.trim_check = usize::MAX;
             }
         }
 

diff --git a/tiny-std/src/elf/vdso.rs b/tiny-std/src/elf/vdso.rs
@@ -24,13 +24,13 @@ const CLOCK_GETTIME_NAME: &[u8] = b"__vdso_clock_gettime\0";
 /// go through a syscall each time we want to get the time.
 /// To do this we need to do a few things:
 /// 1. Find the `.shstrtab` which contain section names (could maybe use section types instead,
-/// but .dynstr shares type and attributes with .strtab which could be an issue disambiguating without names)
+///    but .dynstr shares type and attributes with .strtab which could be an issue disambiguating without names)
 /// 2. Find the `.dynstr` name offset of the symbol `CLOCK_GETTIME_NAME`, the name offset is in practice like an alias
 /// 3. Find the `.dynsym` entry corresponding to the "alias", and get the address offset of the function pointer and the table index of the section containing it
 /// 4. Find the required alignment of the containing section by reading its section header
 /// 5. Align the offset, transmute to appropriate `extern fn`
-/// See [Linux vdso docs](https://man7.org/linux/man-pages/man7/vdso.7.html)
-/// See also [Linux elf docs](https://man7.org/linux/man-pages/man5/elf.5.html)
+///    See [Linux vdso docs](https://man7.org/linux/man-pages/man7/vdso.7.html)
+///    See also [Linux elf docs](https://man7.org/linux/man-pages/man5/elf.5.html)
 #[allow(clippy::cast_possible_truncation)]
 unsafe fn find_vdso_clock_get_time(
     vdso: *const u8,

diff --git a/tiny-std/src/thread/spawn.rs b/tiny-std/src/thread/spawn.rs
@@ -71,11 +71,11 @@ impl<T: Sized> Drop for JoinHandle<T> {
 /// 3. This struct's layout size (usize)
 /// 4. This struct's layout align (usize)
 /// 5. Some return value wrapped in an `UnsafeCell`
-/// This is useful because we don't need to allocate/deallocate/dereference
-/// 3 separate pointers, we just chunk them into one with the proper alignment.
-/// Ideally this would be a pointer to a struct and not just raw bytes, but since
-/// we don't know the size of `T` in the panic handler we need to keep it as anonymous bytes.
-/// Alignment when creating is important for this not to result in UB
+///    This is useful because we don't need to allocate/deallocate/dereference
+///    3 separate pointers, we just chunk them into one with the proper alignment.
+///    Ideally this would be a pointer to a struct and not just raw bytes, but since
+///    we don't know the size of `T` in the panic handler we need to keep it as anonymous bytes.
+///    Alignment when creating is important for this not to result in UB
 #[repr(transparent)]
 #[derive(Copy, Clone, Debug)]
 struct Tsm(*mut u8);
@@ -401,14 +401,14 @@ extern "C" {
     /// - `tls`, x86: arg5/`r8`, aarch64: arg4/`x3`
     ///
     /// Input arguments with c-conventions:
-    /// start_fn: `rdi` / `x0`,
-    /// stack_ptr: `rsi` / `x1`,
-    /// flags: `rdx` / `x2`,
-    /// args_ptr: `rcx` / `x3`,
-    /// tls_ptr: `r8` / `x4`,
-    /// child_tid_ptr: `r9` / `x5`,
-    /// stack_unmap_ptr: `stack first 8 bytes` / `x6`,
-    /// stack_sz: `stack second 8 bytes` / `x7`,
+    /// `start_fn`: `rdi` / `x0`,
+    /// `stack_ptr`: `rsi` / `x1`,
+    /// `flags`: `rdx` / `x2`,
+    /// `args_ptr`: `rcx` / `x3`,
+    /// `tls_ptr`: `r8` / `x4`,
+    /// `child_tid_ptr`: `r9` / `x5`,
+    /// `stack_unmap_ptr`: `stack first 8 bytes` / `x6`,
+    /// `stack_sz`: `stack second 8 bytes` / `x7`,
     fn __clone(
         start_fn: usize,
         stack_ptr: usize,