diff --git a/Cargo.toml b/Cargo.toml index 81b8007..78ec8aa 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,6 +7,8 @@ license = "MIT/Apache-2.0" repository = "https://github.com/alexcrichton/gcc-rs" documentation = "https://docs.rs/gcc" description = """ +**Deprecated** crate, renamed to `cc` + A build-time dependency for Cargo build scripts to assist in invoking the native C compiler to compile native C code into a static archive to be linked into Rust code. diff --git a/README.md b/README.md index 06bfa27..b5d4bb4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # gcc-rs +> **NOTE**: This crate has been deprecated and is renamed to `cc`. It's +> recommended to not use this crate and instead use `cc` + A library to compile C/C++ code into a Rust library/application. [![Build Status](https://travis-ci.org/alexcrichton/gcc-rs.svg?branch=master)](https://travis-ci.org/alexcrichton/gcc-rs) diff --git a/src/lib.rs b/src/lib.rs index 4c5e724..1fe7301 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -75,6 +75,7 @@ pub mod windows_registry; /// Extra configuration to pass to gcc. #[derive(Clone, Debug)] +#[deprecated(note = "crate has been renamed to `cc`, the `gcc` name is not maintained")] pub struct Build { include_directories: Vec, definitions: Vec<(String, Option)>, @@ -232,8 +233,8 @@ impl ToolFamily { /// ```no_run /// gcc::compile_library("foo", &["foo.c", "bar.c"]); /// ``` -#[deprecated] #[doc(hidden)] +#[deprecated(note = "crate has been renamed to `cc`, the `gcc` name is not maintained")] pub fn compile_library(output: &str, files: &[&str]) { let mut c = Build::new(); for f in files.iter() { @@ -248,6 +249,7 @@ impl Build { /// This builder is finished with the [`compile`] function. /// /// [`compile`]: struct.Build.html#method.compile + #[deprecated(note = "crate has been renamed to `cc`, the `gcc` name is not maintained")] pub fn new() -> Build { Build { include_directories: Vec::new(),