Add dox feature to fix docs.rs compilation issue in dependent crates

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 
 ## [Unreleased]
+### Added
+- `dox` feature to disable linking to `vitasdk` stubs during compilation (use in  `docs.rs`)
+
+
 ### Fixed
 
 - Links in `CHANGELOG.md` file.

Cargo.toml

@@ -10,6 +10,9 @@ keywords    = ["ps-vita", "psp2"]
 categories  = ["no-std", "external-ffi-bindings", "os", "hardware-support"]
 exclude     = ["ci/travis/setup.sh", "Makefile.toml"]
 
+[package.metadata.docs.rs]
+features = ["dox"]
+
 [lib]
 name        = "psp2_sys"
 path        = "src/lib.rs"
@@ -21,3 +24,5 @@ maintenance = { status = "actively-developed" }
 [features]
 default = []
 unsafe = []
+dox = []
+

src/dialog/common.rs

@@ -102,7 +102,10 @@ pub struct SceCommonDialogParam {
     pub magic: SceUInt32,
 }
 
-#[link(name = "SceCommonDialog_stub", kind = "static")]
+#[cfg_attr(
+    not(feature = "dox"),
+    link(name = "SceCommonDialog_stub", kind = "static")
+)]
 extern "C" {
     pub fn sceCommonDialogSetConfigParam(configParam: *const SceCommonDialogConfigParam) -> i32;
     pub fn sceCommonDialogUpdate(updateParam: *const SceCommonDialogUpdateParam) -> i32;

src/dialog/message.rs

@@ -158,7 +158,10 @@ pub struct SceMsgDialogResult {
 // 	param->sdkVersion = 0x03150021;
 // }
 
-#[link(name = "SceCommonDialog_stub", kind = "static")]
+#[cfg_attr(
+    not(feature = "dox"),
+    link(name = "SceCommonDialog_stub", kind = "static")
+)]
 extern "C" {
     pub fn sceMsgDialogInit(param: *const SceMsgDialogParam) -> i32;
     pub fn sceMsgDialogGetStatus() -> SceCommonDialogStatus;

src/display.rs

@@ -37,7 +37,10 @@ pub struct SceDisplayFrameBuf {
     pub height: u32,       //  framebuffer height
 }
 
-#[link(kind = "static", name = "SceDisplay_stub")]
+#[cfg_attr(
+    not(feature = "dox"),
+    link(kind = "static", name = "SceDisplay_stub")
+)]
 extern "C" {
     pub fn sceDisplaySetFrameBuf(
         pParam: *const SceDisplayFrameBuf,

src/io/devctl.rs

@@ -10,7 +10,10 @@ pub struct SceIoDevInfo {
     pub unk: *mut ::void,
 }
 
-#[link(kind = "static", name = "SceLibKernel_stub")]
+#[cfg_attr(
+    not(feature = "dox"),
+    link(kind = "static", name = "SceLibKernel_stub")
+)]
 extern "C" {
     pub fn sceIoDevctl(
         dev: *const u8,

src/io/dirent.rs

@@ -10,7 +10,10 @@ pub struct SceIoDirent {
     pub dummy: i32,
 }
 
-#[link(kind = "static", name = "SceLibKernel_stub")]
+#[cfg_attr(
+    not(feature = "dox"),
+    link(kind = "static", name = "SceLibKernel_stub")
+)]
 extern "C" {
     pub fn sceIoDopen(dirname: *const u8) -> SceUID;
     pub fn sceIoDread(fd: SceUID, dir: *mut SceIoDirent) -> i32;

src/io/fcntl.rs

@@ -41,7 +41,10 @@ pub enum SceIoDevType {
     SCE_DEV_TYPE_MOUNTPT = 0x40, // Mount point
 }
 
-#[link(kind = "static", name = "SceIofilemgr_stub")]
+#[cfg_attr(
+    not(feature = "dox"),
+    link(kind = "static", name = "SceIofilemgr_stub")
+)]
 extern "C" {
     pub fn sceIoOpen(file: *const u8, flags: i32, mode: SceIoMode) -> SceUID;
     pub fn sceIoOpenAsync(file: *const u8, flags: i32, mode: SceIoMode) -> SceUID;

src/io/stat.rs

@@ -52,7 +52,10 @@ pub struct SceIoStat {
     pub st_private: [u32; 6],  // Device-specific data
 }
 
-#[link(kind = "static", name = "SceLibKernel_stub")]
+#[cfg_attr(
+    not(feature = "dox"),
+    link(kind = "static", name = "SceLibKernel_stub")
+)]
 extern "C" {
     pub fn sceIoMkdir(dir: *const u8, mode: SceMode) -> i32;
     pub fn sceIoRmdir(path: *const u8) -> i32;

src/kernel/clib.rs

@@ -1,6 +1,9 @@
 use types::SceSize;
 
-#[link(kind = "static", name = "SceLibKernel_stub")]
+#[cfg_attr(
+    not(feature = "dox"),
+    link(kind = "static", name = "SceLibKernel_stub")
+)]
 extern "C" {
 
     pub type va_list;