Merge pull request #2439 from gitbutlerapp/fix-docs

fix doc references and test docs in CI

.github/workflows/push.yaml

@@ -79,6 +79,21 @@ jobs:
       - run: cargo fmt --check --all
       - run: cargo build --locked --all-targets --tests
 
+  rust-docs:
+    needs: changes
+    if: ${{ needs.changes.outputs.rust == 'true' }}
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/gitbutlerapp/ci-base-image:latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/init-env-rust
+      # TODO(qix-): we have to exclude the app here for now because for some
+      # TODO(qix-): reason it doesn't build with the docs feature enabled.
+      - run: cargo doc --no-deps --all-features --document-private-items -p gitbutler-core -p gitbutler-git -p gitbutler-diff
+        env:
+          RUSTDOCFLAGS: -Dwarnings
+
   check-gitbutler-app:
     needs: [changes, rust-init]
     if: ${{ needs.changes.outputs.gitbutler-app == 'true' }}

gitbutler-diff/src/signature.rs

@@ -6,9 +6,9 @@
 //!
 //! Related issues:
 //!
-//! - https://github.com/serde-rs/serde/issues/2120
-//! - https://github.com/serde-rs/serde/issues/1937
-//! - https://github.com/serde-rs/serde/issues/1272
+//! - <https://github.com/serde-rs/serde/issues/2120>
+//! - <https://github.com/serde-rs/serde/issues/1937>
+//! - <https://github.com/serde-rs/serde/issues/1272>
 //!
 //! If/when those are fixed, we should be able to (trivially) add `serde` support.
 //! Otherwise, neither the length prefix imposed by `(de)serialize_bytes()` nor the

gitbutler-git/src/backend/cli.rs

@@ -5,7 +5,12 @@
 mod executor;
 mod repository;
 
-pub use self::{executor::GitExecutor, repository::Repository};
+#[cfg(unix)]
+pub use self::executor::Uid;
+pub use self::{
+    executor::{AskpassServer, FileStat, GitExecutor, Pid, Socket},
+    repository::Repository,
+};
 
 #[cfg(feature = "tokio")]
 pub use self::executor::tokio;

gitbutler-git/src/backend/cli/executor/tokio.rs

@@ -1,4 +1,4 @@
-//! A [Tokio](https://tokio.rs)-based [`GitExecutor`] implementation.
+//! A [Tokio](https://tokio.rs)-based [`super::GitExecutor`] implementation.
 
 use crate::prelude::*;
 use core::time::Duration;
@@ -7,7 +7,7 @@ use std::os::unix::fs::MetadataExt;
 use std::{fs::Permissions, os::unix::fs::PermissionsExt};
 use tokio::process::Command;
 
-/// A [`GitExecutor`] implementation using the `git` command-line tool
+/// A [`super::GitExecutor`] implementation using the `git` command-line tool
 /// via [`tokio::process::Command`].
 pub struct TokioExecutor;
 
@@ -95,7 +95,7 @@ impl super::Socket for tokio::io::BufStream<tokio::net::UnixStream> {
     }
 }
 
-/// A tokio-based [`AskpassServer`] implementation.
+/// A tokio-based [`super::AskpassServer`] implementation.
 #[cfg(unix)]
 pub struct TokioAskpassServer {
     // Always Some until dropped.

gitbutler-git/src/lib.rs

@@ -23,7 +23,6 @@
 //!
 //! This hampers certain use cases, such as implementing
 //! [`cli::GitExecutor`] for e.g. remote connections.
-
 #![cfg_attr(not(feature = "std"), no_std)] // must be first
 #![feature(error_in_core)]
 #![deny(missing_docs, unsafe_code)]

gitbutler-git/src/repository.rs

@@ -81,7 +81,6 @@ pub enum Authorization {
         password: String,
     },
     /// Specifies a set of credentials for logging in with SSH.
-    /// If
     Ssh {
         /// The path to the SSH private key to use for authentication.
         /// If `None`, the default SSH key will be used (i.e. `-i` will not