diff options
| -rw-r--r-- | CNAME | 1 | ||||
| -rw-r--r-- | Cargo.toml | 6 | ||||
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | ci/after-success.sh | 40 | ||||
| -rw-r--r-- | ci/install.sh | 23 | ||||
| -rw-r--r-- | macros/Cargo.toml | 6 | ||||
| -rw-r--r-- | macros/src/lib.rs | 4 | ||||
| -rw-r--r-- | redirect.html | 6 |
8 files changed, 63 insertions, 27 deletions
@@ -0,0 +1 @@ +rtfm.rs @@ -5,13 +5,13 @@ authors = [ ] categories = ["concurrency", "embedded", "no-std"] description = "Real Time For the Masses (RTFM): a concurrency framework for building real time systems" -documentation = "https://japaric.github.io/cortex-m-rtfm/book/en" +documentation = "https://rtfm.rs/" edition = "2018" keywords = ["arm", "cortex-m"] license = "MIT OR Apache-2.0" name = "cortex-m-rtfm" readme = "README.md" -repository = "https://github.com/japaric/cortex-m-rtfm" +repository = "https://github.com/rtfm-rs/cortex-m-rtfm" version = "0.5.0-beta.1" [lib] @@ -48,7 +48,7 @@ required-features = ["__v7"] [dependencies] cortex-m = "0.6.0" cortex-m-rtfm-macros = { path = "macros" } -rtfm-core = { git = "https://github.com/japaric/rtfm-core" } +rtfm-core = { git = "https://github.com/rtfm-rs/rtfm-core" } cortex-m-rt = "0.6.9" heapless = "0.5.0" @@ -43,9 +43,9 @@ A concurrency framework for building real time systems. - Applications must be written using the 2018 edition. -## [User documentation](https://japaric.github.io/rtfm5/book/en) +## [User documentation](https://rtfm.rs) -## [API reference](https://japaric.github.io/rtfm5/api/rtfm/index.html) +## [API reference](https://rtfm.rs/api/rtfm/index.html) ## Acknowledgments diff --git a/ci/after-success.sh b/ci/after-success.sh index 6c696937..54bea2c0 100644 --- a/ci/after-success.sh +++ b/ci/after-success.sh @@ -2,20 +2,53 @@ set -euxo pipefail main() { local langs=( en ru ) + local vers=( 0.4.3 ) rm -f .cargo/config - cargo doc --features timer-queue + cargo doc local td=$(mktemp -d) + + # build latest docs cp -r target/doc $td/api + sed 's|URL|rtfm/index.html|g' redirect.html > $td/api/index.html + mkdir $td/book/ - cp redirect.html $td/book/index.html + sed 's|URL|book/en|g' redirect.html > $td/index.html for lang in ${langs[@]}; do ( cd book/$lang && mdbook build ) cp -r book/$lang/book $td/book/$lang cp LICENSE-* $td/book/$lang/ done + local root=$(pwd) + # build older docs + for ver in ${vers[@]}; do + local prefix=${ver%.*} + + mkdir -p $td/$prefix/book + local src=$(mktemp -d) + curl -L https://github.com/rtfm-rs/cortex-m-rtfm/archive/v${ver}.tar.gz | tar xz --strip-components 1 -C $src + + pushd $src + rm -f .cargo/config + cargo doc || cargo doc --features timer-queue + cp -r target/doc $td/$prefix/api + sed 's|URL|rtfm/index.html|g' $root/redirect.html > $td/$prefix/api/index.html + for lang in ${langs[@]}; do + ( cd book/$lang && mdbook build ) + cp -r book/$lang/book $td/$prefix/book/$lang + cp LICENSE-* $td/$prefix/book/$lang/ + done + sed 's|URL|book/en|g' $root/redirect.html > $td/$prefix/index.html + popd + + rm -rf $src + done + + # forward CNAME file + cp CNAME $td/ + mkdir ghp-import curl -Ls https://github.com/davisp/ghp-import/archive/master.tar.gz | tar --strip-components 1 -C ghp-import -xz @@ -23,8 +56,7 @@ main() { ./ghp-import/ghp_import.py $td set +x - # NOTE push documentation to a different repository - git push -fq https://$GH_TOKEN@github.com/japaric/rtfm5.git gh-pages && echo OK + git push -fq https://$GH_TOKEN@github.com/rtfm-rs/cortex-m-rtfm.git gh-pages && echo OK rm -rf $td } diff --git a/ci/install.sh b/ci/install.sh index 6f8d8151..cbc2125b 100644 --- a/ci/install.sh +++ b/ci/install.sh @@ -1,22 +1,25 @@ set -euxo pipefail main() { - if [ $TARGET = x86_64-unknown-linux-gnu ]; then - ( cd .. && cargo install microamp-tools --version 0.1.0-alpha.2 -f ) - rustup target add thumbv6m-none-eabi thumbv7m-none-eabi - fi + # these are not needed for doc builds + if [ $TRAVIS_BRANCH != master ] || [ $TRAVIS_PULL_REQUEST != false ]; then + if [ $TARGET = x86_64-unknown-linux-gnu ]; then + ( cd .. && cargo install microamp-tools --version 0.1.0-alpha.2 -f ) + rustup target add thumbv6m-none-eabi thumbv7m-none-eabi + fi + + rustup target add $TARGET - rustup target add $TARGET + mkdir qemu + curl -L https://github.com/japaric/qemu-bin/raw/master/14.04/qemu-system-arm-2.12.0 > qemu/qemu-system-arm + chmod +x qemu/qemu-system-arm - mkdir qemu - curl -L https://github.com/japaric/qemu-bin/raw/master/14.04/qemu-system-arm-2.12.0 > qemu/qemu-system-arm - chmod +x qemu/qemu-system-arm + pip install linkchecker --user + fi # install mdbook curl -LSfs https://japaric.github.io/trust/install.sh | \ sh -s -- --git rust-lang-nursery/mdbook --tag v0.3.1 - - pip install linkchecker --user } main diff --git a/macros/Cargo.toml b/macros/Cargo.toml index ed7626f8..c7cce525 100644 --- a/macros/Cargo.toml +++ b/macros/Cargo.toml @@ -2,13 +2,13 @@ authors = ["Jorge Aparicio <jorge@japaric.io>"] categories = ["concurrency", "embedded", "no-std"] description = "Procedural macros of the cortex-m-rtfm crate" -documentation = "https://japaric.github.io/cortex-m-rtfm/api/cortex_m_rtfm" +documentation = "https://rtfm-rs.github.io/cortex-m-rtfm/api/cortex_m_rtfm" edition = "2018" keywords = ["arm", "cortex-m"] license = "MIT OR Apache-2.0" name = "cortex-m-rtfm-macros" readme = "../README.md" -repository = "https://github.com/japaric/cortex-m-rtfm" +repository = "https://github.com/rtfm-rs/cortex-m-rtfm" version = "0.5.0-alpha.1" [lib] @@ -20,7 +20,7 @@ quote = "1" syn = "1" [dependencies.rtfm-syntax] -git = "https://github.com/japaric/rtfm-syntax" +git = "https://github.com/rtfm-rs/rtfm-syntax" [features] heterogeneous = [] diff --git a/macros/src/lib.rs b/macros/src/lib.rs index fdde5c69..54282e1e 100644 --- a/macros/src/lib.rs +++ b/macros/src/lib.rs @@ -89,9 +89,9 @@ mod tests; /// /// - `resources: <fn-name>::Resources`. A `struct` that contains all the resources that can be /// accessed from this context. Each field is a different resource; each resource may appear as a -/// reference (`&[mut]-`) or as proxy structure that implements the [`rftm::Mutex`] trait. +/// reference (`&[mut]-`) or as proxy structure that implements the [`rftm::Mutex`][rtfm-mutex] trait. /// -/// [`rtfm::Mutex`]: ../rtfm/trait.Mutex.html +/// [rtfm-mutex]: ../rtfm/trait.Mutex.html /// /// - `schedule: <fn-name>::Schedule`. A `struct` that can be used to schedule *software* tasks. /// diff --git a/redirect.html b/redirect.html index c42694b4..b832e0b1 100644 --- a/redirect.html +++ b/redirect.html @@ -3,14 +3,14 @@ <html lang="en-US"> <head> <meta charset="UTF-8"> - <meta http-equiv="refresh" content="0; url=https://japaric.github.io/cortex-m-rtfm/book/en/"> + <meta http-equiv="refresh" content="0; url=URL"> <script type="text/javascript"> - window.location.href = "https://japaric.github.io/cortex-m-rtfm/book/en/" + window.location.href = "URL" </script> <title>Page Redirection</title> </head> <body> <!-- Note: don't tell people to `click` the link, just tell them that it is a link. --> - If you are not redirected automatically, follow this <a href='https://japaric.github.io/cortex-m-rtfm/book/en/'>link to example</a>. + If you are not redirected automatically, follow this <a href='URL'>link</a>. </body> </html> |