Auto merge of #385 - posborne:gh-pages-docs, r=fiveop

Publish docs to gh-pages, add coveralls, update README

See the commit messages for some additional details.  This started out with just an update to publish the docs to gh-pages but snowballed into a few other changes along the way.

Author: homu

.travis.yml

@@ -1,35 +1,42 @@
+#
+# Operating Environment
+#
 language: rust
 sudo: false
 dist: trusty
 services:
   - docker
+addons:
+  apt:
+    packages:
+      - gcc-multilib
+      - libcurl4-openssl-dev
+      - libelf-dev
+      - libdw-dev
+      - binutils-dev
 
 rust:
   - 1.1.0  # Oldest supported version
-  - 1.2.0
-  - 1.3.0
-  - 1.4.0
-  - 1.5.0
-  - 1.6.0
+  - 1.7.0
+  - 1.8.0
   - stable
   - beta
   - nightly
 
-script:
-  - bash ci/run-travis.sh
-
+#
+# Environment Variables and Build Matrix
+#
 env:
-  - ARCH=x86_64
-  - ARCH=i686
+  global:
+    - PATH=$HOME/.local/bin:$PATH
+    - TRAVIS_CARGO_NIGHTLY_FEATURE=""
+  matrix:
+    - ARCH=x86_64
+    - ARCH=i686
 
-os:
+os:  # OSX included in build matrix explicitly
   - linux
 
-addons:
-  apt:
-    packages:
-      - gcc-multilib
-
 # Failures on nightly shouldn't fail the overall build.
 matrix:
   fast_finish: true
@@ -74,22 +81,27 @@ matrix:
     - env: TARGET=mipsel-unknown-linux-gnu DOCKER_IMAGE=posborne/rust-cross:mips
     - env: TARGET=arm-linux-androideabi DOCKER_IMAGE=posborne/rust-cross:android
 
-# Deploy documentation to S3 for specific branches. At some
-# point, it would be nice to also support building docs for
-# a specific tag
-deploy:
-  provider: s3
-  access_key_id: AKIAIGFX36YKEFRZJAXA
-  secret_access_key:
-    secure: Q10KEdtBoYxaGXtt23L00J0obv9fpVWtao8YKFEroZMOmvu8Sq2+9aTNGEQRp2OojOxuu+DjZInJlUDFhq6trmV3kpZH2BF7cNRxiZQpQ2FEmlr6ZpYN38GhcIUKdxXqVwXiASJi6j+vz6QdpaOGCs5lQC3VhM5sn49MFXNUrFU=
-  bucket: rustdoc
-  endpoint: "rustdoc.s3-website-us-east-1.amazonaws.com"
-  skip_cleanup: true
-  local-dir: target/doc
-  upload-dir: nix/${TRAVIS_BRANCH}/${TRAVIS_OS_NAME}
-  acl: public_read
-  on:
-    condition: "\"$TRAVIS_RUST_VERSION/$ARCH\" == \"1.1.0/x86_64\""
-    repo: nix-rust/nix
-    branch:
-      - master
+
+#
+# Build/Test/Deploy Steps
+#
+before_script:
+  - pip install 'travis-cargo<0.2' --user
+
+script:
+  - bash ci/run-travis.sh
+  - |
+    if [ "$TRAVIS_OS_NAME" = "linux" ]; then
+        travis-cargo --only stable doc
+    fi
+
+after_success:
+  - |
+    if [ "$TRAVIS_OS_NAME" = "linux" ] && \
+       [ "$TRAVIS_RUST_VERSION" = "stable" ] && \
+       [ "$ARCH" = "x86_64" ]; then
+        # Upload docs for stable (on master) to gh-pages
+        travis-cargo --only stable doc-upload
+        # Measure code coverage using kcov and upload to coveralls.io
+        travis-cargo coveralls --no-sudo --verify
+    fi

README.md

@@ -1,18 +1,32 @@
 # Rust bindings to *nix APIs
 
-Rust friendly bindings to various *nix platform APIs (Linux, Darwin,
+[![Build Status](https://travis-ci.org/nix-rust/nix.svg?branch=master)](https://travis-ci.org/nix-rust/nix)
+[![crates.io](http://meritbadge.herokuapp.com/nix)](https://crates.io/crates/nix)
+
+[Documentation](https://nix-rust.github.io/nix/nix/index.html)
+
+Nix seeks to provide friendly bindings to various *nix platform APIs (Linux, Darwin,
 ...). The goal is to not provide a 100% unified interface, but to unify
 what can be while still providing platform specific APIs.
 
-[![Build Status](https://travis-ci.org/nix-rust/nix.svg?branch=master)](https://travis-ci.org/nix-rust/nix)
-[![crates.io](http://meritbadge.herokuapp.com/nix)](https://crates.io/crates/nix)
+For many system APIs, Nix provides a safe alternative to the unsafe APIs
+exposed by the [libc crate](https://github.com/rust-lang/libc).  This is done by
+wrapping the libc functionality with types/abstractions that enforce legal/safe
+usage.
 
-## Documentation
 
-API documentation generated by rustdoc:
+As an example of what Nix provides, examine the differences between what is
+exposed by libc and nix for the
+[gethostname](http://man7.org/linux/man-pages/man2/gethostname.2.html) system
+call:
 
-- Linux: [master](http://rustdoc.s3-website-us-east-1.amazonaws.com/nix/master/linux/nix/)
-- OS X: [master](http://rustdoc.s3-website-us-east-1.amazonaws.com/nix/master/osx/nix/)
+```rust,ignore
+// libc api (unsafe, requires handling return code/errno)
+pub unsafe extern fn gethostname(name: *mut c_char, len: size_t) -> c_int;
+
+// nix api (returns a nix::Result)
+pub fn gethostname(name: &mut [u8]) -> Result<()>;
+```
 
 ## Usage
 
@@ -25,10 +39,14 @@ nix = "0.6.0"
 
 Then, add this to your crate root:
 
-```rust
+```rust,ignore
 extern crate nix;
 ```
-
 ## Contributing
 
-See [CONTRIBUTING](CONTRIBUTING.md).
+Contributions are very welcome.  Please See [CONTRIBUTING](CONTRIBUTING.md) for
+additional details.
+
+## License
+
+Nix is licensed under the MIT license.  See [LICENSE](LICENSE) for more details.

ci/run-travis.sh

@@ -33,7 +33,6 @@ fi
 if [ "$DOCKER_IMAGE" = "" ]; then
   export RUST_TEST_THREADS=1
   curl -sSL "https://raw.githubusercontent.com/carllerche/travis-rust-matrix/master/test" | bash
-  cargo doc --no-deps
 else
   export RUST_VERSION=${TRAVIS_RUST_VERSION}
   export RUST_TARGET=${TARGET}