From 42b4b4814875d4732ec220b704b24f4c5a6374d3 Mon Sep 17 00:00:00 2001 From: Casey Primozic Date: Thu, 17 Jan 2019 20:14:58 -0600 Subject: [PATCH] Fix book links when viewing via Github * Some pages of the book's documentation markdown pages used `.html` in their links rather than `.md`. This evidently works with `mdBook`, but fails when viewing the pages of the book from the Github source tree. * The `.html` links were replaced with `.md` to fix this. --- book/src/blacklisting.md | 2 +- book/src/cpp.md | 8 ++++---- book/src/replacing-types.md | 2 +- book/src/tutorial-2.md | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/book/src/blacklisting.md b/book/src/blacklisting.md index 8d4ee163bf..b56aacd983 100644 --- a/book/src/blacklisting.md +++ b/book/src/blacklisting.md @@ -5,7 +5,7 @@ because you need to wrap one of its fields in an `UnsafeCell`), you can explicitly blacklist generation of its definition. Uses of the blacklisted type will still appear in other types' definitions. (If you don't want the type to appear in the bindings at -all, [make it opaque](./opaque.html) instead of +all, [make it opaque](./opaque.md) instead of blacklisting it.) Blacklisted types are pessimistically assumed not to be able to `derive` any diff --git a/book/src/cpp.md b/book/src/cpp.md index 0324901676..c4eeb63767 100644 --- a/book/src/cpp.md +++ b/book/src/cpp.md @@ -11,14 +11,14 @@ it ends in `.hpp`. If it doesn't, adding `-x c++` clang args can be used to force C++ mode. You probably also want to use `-std=c++14` or similar clang args as well. -You pretty much **must** use [whitelisting](./whitelisting.html) when working +You pretty much **must** use [whitelisting](./whitelisting.md) when working with C++ to avoid pulling in all of the `std::*` types, many of which `bindgen` cannot handle. Additionally, you may want to mark other types as -[opaque](./opaque.html) that `bindgen` stumbles on. It is recommended to mark +[opaque](./opaque.md) that `bindgen` stumbles on. It is recommended to mark all of `std::*` opaque, and to whitelist only precisely the functions and types you intend to use. -You should read up on the [FAQs](./faq.html) as well. +You should read up on the [FAQs](./faq.md) as well. ## Supported Features @@ -50,7 +50,7 @@ Without further ado, here are C++ features that `bindgen` does not support or cannot translate into Rust: * Inline functions and methods: see -["Why isn't `bindgen` generating bindings to inline functions?"](./faq.html#why-isnt-bindgen-generating-bindings-to-inline-functions) +["Why isn't `bindgen` generating bindings to inline functions?"](./faq.md#why-isnt-bindgen-generating-bindings-to-inline-functions) * Template functions, methods of template classes and structs. We don't know which monomorphizations exist, and can't create new ones because we aren't a diff --git a/book/src/replacing-types.md b/book/src/replacing-types.md index 7426d2ea55..cf3dd17ace 100644 --- a/book/src/replacing-types.md +++ b/book/src/replacing-types.md @@ -24,4 +24,4 @@ That way, after code generation, the bindings for the `nsTArray` type are the ones that would be generated for `nsTArray_Simple`. Replacing is only available as an annotation. To replace a C or C++ definition -with a Rust definition, use [blacklisting](./blacklisting.html). +with a Rust definition, use [blacklisting](./blacklisting.md). diff --git a/book/src/tutorial-2.md b/book/src/tutorial-2.md index e1e88811b0..55cea77799 100644 --- a/book/src/tutorial-2.md +++ b/book/src/tutorial-2.md @@ -14,7 +14,7 @@ Here is our `wrapper.h`: #include ``` -This is also where we would add any [replacement types](./replacing-types.html), +This is also where we would add any [replacement types](./replacing-types.md), if we were using some. [spidermonkey]: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/SpiderMonkey/How_to_embed_the_JavaScript_engine