[PATCH] D100230: [docs][scudo] Update Scudo documentation

[Mitch Phillips via Phabricator via llvm-commits]

hctim accepted this revision.
hctim added a comment.
This revision is now accepted and ready to land.

It would be nice to include some details about MTE support (like the header size is 16 bytes rather than 8 bytes, etc). But we can make those changes afterwards.



================
Comment at: llvm/docs/ScudoHardenedAllocator.rst:13
+The Scudo Hardened Allocator is a user-mode allocator, originally based on LLVM
+Sanitizers' `CombinedAllocator <https://github.com/llvm/llvm-project/blob/main/compiler-rt/lib/sanitizer_common/sanitizer_allocator_combined.h>`_. It aims at providing
+additional mitigation against heap based vulnerabilities, while maintaining good
----------------
nit, push url onto newline to help with line length?


================
Comment at: llvm/docs/ScudoHardenedAllocator.rst:16
+performance. Scudo is currently the default allocator in `Fuchsia <https://fuchsia.dev/>`_,
+and in `Android <https://www.android.com/>`_ since R.
 
----------------
Android 11


================
Comment at: llvm/docs/ScudoHardenedAllocator.rst:18
 
-Currently, the allocator supports (was tested on) the following architectures:
-
-- i386 (& i686) (32-bit);
-- x86_64 (64-bit);
-- armhf (32-bit);
-- AArch64 (64-bit);
-- MIPS (32-bit & 64-bit).
-
-The name "Scudo" has been retained from the initial implementation (Escudo
-meaning Shield in Spanish and Portuguese).
+The name "Scudo" comes from the Italian word for `shield <https://www.collinsdictionary.com/dictionary/italian-english/scudo>`_
+(and Escudo in Spanish).
----------------
nit - start on newline?


================
Comment at: llvm/docs/ScudoHardenedAllocator.rst:66
+  checksummed and corruption of the header will be detected when said header is
+  accessed (note that is the corrupted header is not accessed, the corruption
+  will remain undetected).
----------------
if


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D100230/new/

https://reviews.llvm.org/D100230