Skip to content

Commit

Permalink
Improved docs with custom logo and favicon
Browse files Browse the repository at this point in the history
  • Loading branch information
syrusakbary committed Sep 4, 2019
1 parent 1a35cdd commit d8471e2
Show file tree
Hide file tree
Showing 24 changed files with 44 additions and 9 deletions.
3 changes: 3 additions & 0 deletions lib/clif-backend/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
unused_unsafe,
unreachable_patterns
)]
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

mod cache;
mod code;
mod libcalls;
Expand Down
3 changes: 3 additions & 0 deletions lib/dev-utils/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

pub mod file_descriptor;
pub mod stdio;
3 changes: 3 additions & 0 deletions lib/emscripten/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
unused_unsafe,
unreachable_patterns
)]
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

#[macro_use]
extern crate wasmer_runtime_core;

Expand Down
3 changes: 3 additions & 0 deletions lib/kernel-loader/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

pub mod service;

use service::{ImportInfo, LoadProfile, RunProfile, ServiceContext, TableEntryRequest};
Expand Down
2 changes: 2 additions & 0 deletions lib/kernel-net/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
#![cfg(all(target_arch = "wasm32", target_os = "wasi"))]
#![feature(wasi_ext)]
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

use std::cell::RefCell;
use std::fs::File;
Expand Down
2 changes: 2 additions & 0 deletions lib/llvm-backend/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
)]
#![cfg_attr(not(target_os = "windows"), deny(dead_code))]
#![cfg_attr(nightly, feature(unwind_attributes))]
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

mod backend;
mod code;
Expand Down
1 change: 0 additions & 1 deletion lib/middleware-common-tests/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -148,5 +148,4 @@ mod tests {
// verify it used the correct number of points
assert_eq!(get_points_used(&instance), 109); // Used points will be slightly more than `limit` because of the way we do gas checking.
}

}
3 changes: 3 additions & 0 deletions lib/middleware-common/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,8 @@
unused_unsafe,
unreachable_patterns
)]
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

pub mod call_trace;
pub mod metering;
4 changes: 4 additions & 0 deletions lib/runtime-abi/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
#![deny(dead_code, unused_imports, unused_variables, unused_unsafe, unreachable_patterns)]

#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

#[cfg(not(target_os = "windows"))]
#[macro_use]
extern crate failure;
Expand Down
3 changes: 3 additions & 0 deletions lib/runtime-c-api/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

//! # Wasmer Runtime C API
//!
//! Wasmer is a standalone JIT WebAssembly runtime, aiming to be fully
Expand Down
1 change: 0 additions & 1 deletion lib/runtime-core/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,5 @@ fn main() {
.file("image-loading-macos-x86-64.s")
.compile("image-loading");
} else {

}
}
2 changes: 2 additions & 0 deletions lib/runtime-core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
unreachable_patterns
)]
#![cfg_attr(nightly, feature(unwind_attributes))]
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

#[cfg(test)]
#[macro_use]
Expand Down
1 change: 0 additions & 1 deletion lib/runtime-core/src/memory/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -363,5 +363,4 @@ mod memory_tests {
"Max number of pages is required for shared memory"
)
}

}
1 change: 0 additions & 1 deletion lib/runtime-core/src/table/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -165,5 +165,4 @@ mod table_tests {
.unwrap();
assert_eq!(table.size(), 10);
}

}
1 change: 0 additions & 1 deletion lib/runtime-core/src/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -590,5 +590,4 @@ mod tests {
f64::from_native(f64::from_binary((yf64).to_native().to_binary()))
);
}

}
1 change: 0 additions & 1 deletion lib/runtime/src/cache.rs
Original file line number Diff line number Diff line change
Expand Up @@ -173,5 +173,4 @@ mod tests {
// verify it works
assert_eq!(value, 43);
}

}
3 changes: 3 additions & 0 deletions lib/runtime/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
unused_unsafe,
unreachable_patterns
)]
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

//! Wasmer-runtime is a library that makes embedding WebAssembly
//! in your application easy, efficient, and safe.
//!
Expand Down
3 changes: 2 additions & 1 deletion lib/singlepass-backend/src/codegen_x64.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1318,7 +1318,8 @@ impl X64FunctionCode {
}
m.state
.stack_values
.push(MachineValue::CopyStackBPRelative(offset)); // TODO: Read value at this offset
.push(MachineValue::CopyStackBPRelative(offset));
// TODO: Read value at this offset
}
_ => {
m.state.stack_values.push(MachineValue::Undefined);
Expand Down
2 changes: 2 additions & 0 deletions lib/singlepass-backend/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
unreachable_patterns
)]
#![feature(proc_macro_hygiene)]
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

#[cfg(not(any(
all(target_os = "macos", target_arch = "x86_64"),
Expand Down
1 change: 0 additions & 1 deletion lib/singlepass-backend/src/machine.rs
Original file line number Diff line number Diff line change
Expand Up @@ -502,5 +502,4 @@ mod test {

machine.release_locations_keep_state(&mut assembler, &locs);
}

}
1 change: 0 additions & 1 deletion lib/spectests/tests/spectest.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1265,5 +1265,4 @@ mod tests {
self.to_bits() == 0x7FF8_0000_0000_0000 || self.to_bits() == 0xFFF8_0000_0000_0000
}
}

}
3 changes: 3 additions & 0 deletions lib/wasi/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
unused_unsafe,
unreachable_patterns
)]
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

#[cfg(target = "windows")]
extern crate winapi;

Expand Down
3 changes: 3 additions & 0 deletions lib/win-exception-handler/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
unused_unsafe,
unreachable_patterns
)]
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

#[cfg(windows)]
mod exception_handling;

Expand Down
3 changes: 3 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
unused_unsafe,
unreachable_patterns
)]
#![doc(html_favicon_url = "https://wasmer.io/static/icons/favicon.ico")]
#![doc(html_logo_url = "https://avatars3.githubusercontent.com/u/44205449?s=200&v=4")]

#[macro_use]
extern crate wasmer_runtime_core;
// extern crate wasmer_emscripten;
Expand Down

0 comments on commit d8471e2

Please sign in to comment.