Skip to content

Rename spirv_headers => spirv and reset to version 0.1.0+1.5.4 #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions MAINTENANCE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Making a new release

1. If you don't have cargo-release installed run `cargo install cargo-release`
1. For `spirv_headers` we don't follow Semantic Versioning, instead we follow the versioning SPIR-V uses, and reserve the patch version to do our own version increments. To prevent breakage, one should release `spirv_headers` before releasing a new `rspirv` because it has an obvious dependency.
1. For `rspirv` run `cargo release` in the `rspriv` directory, this should follow Semantic Versioning
1. To prevent breakage, one should release `spirv` before releasing a new `rspirv` because it has an obvious dependency.
1. For `rspirv` run `cargo release` in the `rspirv` directory, this should follow Semantic Versioning
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ Rust.
Documentation
-------------

The current implementation supports SPIR-V 1.4 (Revision 1).
The current implementation supports SPIR-V 1.5 (Revision 4).
Copy link
Collaborator Author

@MarijnS95 MarijnS95 Jul 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really am not sure about this. https://www.khronos.org/registry/spir-v/ mentions Revision 5 but we're on the 1.5.4.raytracing.fixed tag. There is no 1.5.5 tag.

EDIT: Relevant issue about creating a new spirv-headers tag/release: KhronosGroup/SPIRV-Headers#199.


Multiple crates are published from this project:

| Name | Crate | Docs |
| :------------: | :-------: | :------: |
| rspirv | [![Crate][img-crate-rspirv]][crate-rspirv] | [![Documentation][img-doc-rspirv]][doc-rspirv] |
| spirv\_headers | [![Crate][img-crate-headers]][crate-headers] | [![Documentation][img-doc-headers]][doc-headers] |
| Name | Crate | Docs |
| :----: | :-------: | :------: |
| rspirv | [![Crate][img-crate-rspirv]][crate-rspirv] | [![Documentation][img-doc-rspirv]][doc-rspirv] |
| spirv | [![Crate][img-crate-headers]][crate-headers] | [![Documentation][img-doc-headers]][doc-headers] |

In total rspirv APIs contains:
* The [SPIR-V header][doc-headers] (all SPIR-V structs, enums, and constants)
Expand Down Expand Up @@ -79,9 +79,6 @@ Examples
Building a SPIR-V module, assembling it, parsing it, and then disassembling it:

```rust
extern crate rspirv;
extern crate spirv_headers as spirv;

use rspirv::binary::Assemble;
use rspirv::binary::Disassemble;

Expand Down Expand Up @@ -145,7 +142,7 @@ There are multiple crates inside this repo:
- `autogen/`: Crate to generate various Rust code snippets used in the modules
in `spirv/` and `rspirv/`, from SPIR-V's JSON grammar. If you are not
modifying `spirv/` or `rspirv/`, you don't need to care about this directory.
- `spirv/`: The `spirv_headers` crate.
- `spirv/`: The `spirv` crate.
- `rspirv/`: The core `rspirv` crate.
- `dis/`: A binary SPIR-V disassembler based on the `rspirv` crate.
- `spirv-blobs`: SPIR-V blobs provided by the user for testing.
Expand All @@ -157,7 +154,7 @@ Build
git clone https://github.com/gfx-rs/rspirv.git /path/to/rspirv
```

If you just want to compile and use the `spirv_headers` crate:
If you just want to compile and use the `spirv` crate:

```sh
cd /path/to/rspirv/spirv
Expand All @@ -171,7 +168,7 @@ cd /path/to/rspirv/rspirv
cargo build
```

If you want to refresh the `spirv_headers` or `rspirv` crate with new code
If you want to refresh the `spirv` or `rspirv` crate with new code
snippets generated from SPIR-V's JSON grammar:

```sh
Expand Down Expand Up @@ -206,10 +203,10 @@ developed by the gfx-rs [Translators][github-translators] team.
[img-doc-rspirv]: https://docs.rs/rspirv/badge.svg
[crate-rspirv]: https://crates.io/crates/rspirv
[doc-rspirv]: https://docs.rs/rspirv
[img-crate-headers]: https://img.shields.io/crates/v/spirv_headers.svg
[img-doc-headers]: https://docs.rs/spirv_headers/badge.svg
[crate-headers]: https://crates.io/crates/spirv_headers
[doc-headers]: https://docs.rs/spirv_headers
[img-crate-headers]: https://img.shields.io/crates/v/spirv.svg
[img-doc-headers]: https://docs.rs/spirv/badge.svg
[crate-headers]: https://crates.io/crates/spirv
[doc-headers]: https://docs.rs/spirv
[spirv]: https://www.khronos.org/registry/spir-v/
[vulkan]: https://www.khronos.org/vulkan/
[opengl]: https://www.opengl.org/
Expand Down
4 changes: 2 additions & 2 deletions rspirv/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ derive_more = "0.99"
fxhash = "0.2"
num-traits = "0.2"

[dependencies.spirv_headers]
version = "~1.5.0"
[dependencies.spirv]
version = "=0.1"
path = "../spirv"

[dev-dependencies]
Expand Down
3 changes: 0 additions & 3 deletions rspirv/binary/decoder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@ const WORD_NUM_BYTES: usize = 4;
/// # Examples
///
/// ```
/// extern crate rspirv;
/// extern crate spirv_headers as spirv;
///
/// use rspirv::binary::{Decoder, DecodeError};
/// use spirv::SourceLanguage;
///
Expand Down
3 changes: 0 additions & 3 deletions rspirv/binary/parser.rs
Original file line number Diff line number Diff line change
Expand Up @@ -180,9 +180,6 @@ pub fn parse_words(binary: impl AsRef<[u32]>, consumer: &mut dyn Consumer) -> Re
/// # Examples
///
/// ```
/// extern crate rspirv;
/// extern crate spirv_headers as spirv;
///
/// use spirv::{AddressingModel, MemoryModel};
/// use rspirv::binary::Parser;
/// use rspirv::dr::{Loader, Operand};
Expand Down
3 changes: 0 additions & 3 deletions rspirv/dr/build/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,6 @@ type BuildResult<T> = result::Result<T, Error>;
/// # Examples
///
/// ```
/// extern crate rspirv;
/// extern crate spirv_headers as spirv;
///
/// use rspirv::binary::Disassemble;
///
/// fn main() {
Expand Down
7 changes: 1 addition & 6 deletions rspirv/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
#![doc(html_root_url = "https://docs.rs/rspirv/0.7/")]

//! Library APIs for SPIR-V module processing functionalities.
//!
//! This library provides:
Expand Down Expand Up @@ -31,9 +29,6 @@
//! disassembling it:
//!
//! ```
//! extern crate rspirv;
//! extern crate spirv_headers as spirv;
//!
//! use rspirv::binary::Assemble;
//! use rspirv::binary::Disassemble;
//!
Expand Down Expand Up @@ -80,7 +75,7 @@
//! }
//! ```

pub extern crate spirv_headers as spirv;
pub use spirv;

pub mod binary;
pub mod dr;
Expand Down
6 changes: 3 additions & 3 deletions spirv/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[package]
name = "spirv_headers"
version = "1.5.1"
name = "spirv"
version = "0.1.0+1.5.4"
authors = ["Lei Zhang <[email protected]>"]
edition = "2018"

description = "Rust definition of SPIR-V structs and enums"
documentation = "https://docs.rs/spirv_headers"
documentation = "https://docs.rs/spirv"
repository = "https://github.com/gfx-rs/rspirv"
readme = "README.md"
license = "Apache-2.0"
Expand Down
10 changes: 5 additions & 5 deletions spirv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ First add to your `Cargo.toml`:

```toml
[dependencies]
spirv_headers = "1.5.1"
spirv = "1.5.1"
```

Version
Expand All @@ -36,9 +36,9 @@ Examples
Please see the [documentation][doc-headers] and project's
[README][project-readme] for examples.

[img-crate-headers]: https://img.shields.io/crates/v/spirv_headers.svg
[img-doc-headers]: https://docs.rs/spirv_headers/badge.svg
[crate-headers]: https://crates.io/crates/spirv_headers
[doc-headers]: https://docs.rs/spirv_headers
[img-crate-headers]: https://img.shields.io/crates/v/spirv.svg
[img-doc-headers]: https://docs.rs/spirv/badge.svg
[crate-headers]: https://crates.io/crates/spirv
[doc-headers]: https://docs.rs/spirv
[project-readme]: https://github.com/gfx-rs/rspirv/blob/master/README.md
[rust-1.20]: https://blog.rust-lang.org/2017/08/31/Rust-1.20.html
2 changes: 0 additions & 2 deletions spirv/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
#![doc(html_root_url = "https://docs.rs/spirv_headers/1.5/")]

//! The SPIR-V header.
//!
//! This crate contains Rust definitions of all SPIR-V structs, enums,
Expand Down
3 changes: 2 additions & 1 deletion spirv/release.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ sign-commit = true
sign-tag = true

pre-release-replacements = [
{file="README.md", search="spirv_headers = .*", replace="{{crate_name}} = \"{{version}}\""},
{file="README.md", search="spirv = .*", replace="{{crate_name}} = \"{{version}}\""},
{file="../rspirv/Cargo.toml", search="spirv = .*", replace="{{crate_name}} = \"={{version}}\""},
]