From 4efb940080f6693d952eb19ba44c8a3f10e61e36 Mon Sep 17 00:00:00 2001 From: Tony Arcieri Date: Thu, 26 Jul 2018 21:00:11 -0700 Subject: [PATCH] README.md: Documented `affected_arch` and `affected_os` These are new attributes as of `rustsec` crate v0.9.0 which use enums from the `platforms` crate to represent CPU architectures and operating systems. This replaces the previous `affected_platforms` attribute (only used in one advisory) --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 118be59..4b91c74 100644 --- a/README.md +++ b/README.md @@ -73,9 +73,15 @@ patched_versions = [">= 1.2.0"] # Versions which were never vulnerable (optional) unaffected_versions = ["< 1.1.0"] -# Platforms this vulnerability specifically affects (optional) -# See: https://docs.rs/rustsec/latest/rustsec/advisory/struct.PlatformReq.html -#affected_platforms = ["*windows*"] +# CPU architectures impacted by this vulnerability (optional) +# For a list of CPU architecture strings, see the "platforms" crate: +# +#affected_arch = ["x86", "x86_64"] + +# Operating systems impacted by this vulnerability (optional) +# For a list of OS strings, see the "platforms" crate: +# +#affected_os = ["windows"] # Vulnerability aliases, e.g. CVE IDs (optional but recommended) # Request a CVE for your RustSec vulns: https://iwantacve.org/