From e7ad94c1c7e2aa71c43f52aff830bb0cae92ed35 Mon Sep 17 00:00:00 2001 From: Ashley Mannix Date: Mon, 21 Sep 2020 10:14:17 +1000 Subject: [PATCH 1/2] fill in initial details --- CHARTER.md | 47 +++++++++++++++++++++------------------- README.md | 63 +++++++++--------------------------------------------- book.toml | 6 +++--- 3 files changed, 38 insertions(+), 78 deletions(-) diff --git a/CHARTER.md b/CHARTER.md index e0b3180..0d40446 100644 --- a/CHARTER.md +++ b/CHARTER.md @@ -1,32 +1,35 @@ -# {{GROUP_NAME}} Charter - +# Portable SIMD Charter + +Build and stabilize a portable SIMD API to the standard library under `core::simd` and `std::simd`. +Draw elements from the existing portable SIMD implementations out in the ecosystem: + +- [`generic-simd`] +- [`packed_simd`] +- [`wide`] ## Goals - +- Determine the shape of the portable SIMD API. +- Get an unstable `std::simd` and `core::simd` API in the standard library. +This may mean renaming `packed_simd` to `stdsimd` and working directly on it, or creating a new repository and pulling in chunks of code as needed. +- Produce a stabilization plan to allow portions of the API to be stabilized when they're ready, and coordinate with other unstable features. +- Respond to user feedback and review contributions to the API. +- Update [RFC 2948] based on the final API and stabilization plan. +- Stabilize! ## Constraints And Considerations - - +The initial implementation will be built on LLVM intrinsics directly rather than `core::arch`. +This is so we don't have to block the portable API on filling in a lot of missing intrinsics in `core::arch` on non-x86 platforms. +Migrating from LLVM intrinsics to `core::arch` is kept as a future possibility. ## Membership - +**Shepherds:** @hsivonen, @KodrAus, @Lokathor +**Team Liason:** @KodrAus +**Members:** @BurntSushi, @calebzulawski, @hsivonen, @KodrAus, @Lokathor, @workingjubilee -**Shepherd:** -**Team Liason:** -**Members:** +[`packed_simd`]: https://github.com/rust-lang/packed_simd +[`wide`]: https://github.com/Lokathor/wide +[`generic-simd`]: https://github.com/calebzulawski/generic-simd +[RFC 2948]: https://github.com/rust-lang/rfcs/pull/2948 diff --git a/README.md b/README.md index 62d1ff8..0000d75 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,37 @@ -# {{GROUP_NAME}} {{GROUP_TYPE}} Group - - - ![project group status: active](https://img.shields.io/badge/status-active-brightgreen.svg) [![project group documentation](https://img.shields.io/badge/MDBook-View%20Documentation-blue)][gh-pages] - -**FIX ME** - - - -Welcome the repository for the {{GROUP_NAME}} Project Group! This is the +Welcome the repository for the Portable SIMD Project Group! This is the repository we use to organise our work. Please refer to our [charter] as well as our [github pages website][gh-pages] for more information on our goals and current scope. [charter]: ./CHARTER.md -[gh-pages]: https://rust-lang.github.io/{{GROUP_SLUG}} - -**/FIX ME** - +[gh-pages]: https://rust-lang.github.io/portable-simd ## How Can I Get Involved? -**FIX ME** - - - [You can find a list of the current members available on `rust-lang/team`.][team-toml] If you'd like to participate be sure to check out any of our [open issues] on this repository. -We also participate on [{{CHAT_PLATFORM}}][chat-link], feel free to introduce +We also participate on [Zulip][chat-link], feel free to introduce yourself over there and ask us any questions you have. +Group meetings happen every two weeks via [Zulip][chat-link]. +You can find them on the [Libs team calendar][calendar]! [open issues]: /issues -[chat-link]: {{CHAT_LINK}} -[team-toml]: https://github.com/rust-lang/team/blob/master/teams/{{GROUP_TYPE}}-{{GROUP_SLUG}}.toml - -**/FIX ME** +[chat-link]: https://rust-lang.zulipchat.com/#narrow/stream/257879-project-portable-simd +[team-toml]: https://github.com/rust-lang/team/blob/master/teams/project-portable-simd.toml +[calendar]: https://calendar.google.com/calendar/u/0/embed?src=9kuu8evq4eh6uacm262k0phri8@group.calendar.google.com ## Building Documentation + This repository is also an mdbook project. You can view and build it using the following command. diff --git a/book.toml b/book.toml index 93b82ea..6e5379d 100644 --- a/book.toml +++ b/book.toml @@ -1,10 +1,10 @@ [book] -authors = ["{{GROUP_NAME}} Members"] +authors = ["Portable SIMD Members"] language = "en" multilingual = false src = "." -title = "{{GROUP_NAME}} {{GROUP_TYPE}} Group" +title = "Portable SIMD Project Group" [output.html] no-section-label=true -git-repository-url="https://github.com/rust-lang/{{GROUP_SLUG}}" +git-repository-url="https://github.com/rust-lang/portable-simd" From 3cb6e47529a97dc16663984a7773d37c6132cc3b Mon Sep 17 00:00:00 2001 From: Ashley Mannix Date: Mon, 21 Sep 2020 17:14:23 +1000 Subject: [PATCH 2/2] remove note about migrating to core::arch --- CHARTER.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHARTER.md b/CHARTER.md index 0d40446..4840fa8 100644 --- a/CHARTER.md +++ b/CHARTER.md @@ -21,7 +21,6 @@ This may mean renaming `packed_simd` to `stdsimd` and working directly on it, or The initial implementation will be built on LLVM intrinsics directly rather than `core::arch`. This is so we don't have to block the portable API on filling in a lot of missing intrinsics in `core::arch` on non-x86 platforms. -Migrating from LLVM intrinsics to `core::arch` is kept as a future possibility. ## Membership