From c003bb964352c51dcace4895aa20049b442b741c Mon Sep 17 00:00:00 2001 From: Avril Date: Wed, 24 Mar 2021 18:28:24 +0000 Subject: [PATCH] add description --- Cargo.toml | 1 + src/ffi.rs | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 64b6ddd..958f8ec 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "stackalloc" version = "0.1.0" +description = "allocate arbitrary bytes on the stack at runtime" authors = ["Avril "] edition = "2018" diff --git a/src/ffi.rs b/src/ffi.rs index 5e9e3b6..17d28ae 100644 --- a/src/ffi.rs +++ b/src/ffi.rs @@ -16,7 +16,7 @@ extern "C" { /// * `cb` is guaranteed to be called unless allocating `size` bytes on the stack causes a stack overflow, in which case the program will terminate. /// * The data pointed to by `ptr` is guaranteed to be popped from the stack once this function returns (even in the case of a `longjmp`, but `panic!()` within the callback is still undefined behaviour). // Never inline this, in case LTO inlines the call to `_alloca_trampoline`, we always want this function to pop the alloca'd memory. -// (NOTE: Test to see if this can ever happen. If it can't, the change this to `inline(always)` or remove the `inline` attribute +// (NOTE: Test to see if this can ever happen. If it can't, the change this to `inline(always)` or remove the `inline` attribute.) #[inline(never)] pub unsafe fn alloca_trampoline(size: usize, cb: CallbackRaw, data: *mut c_void) { _alloca_trampoline(size, Some(cb), data);