Bug#934938: [cargo-docs] missing files

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

Bug#934938: [cargo-docs] missing files

jnqnfe
Package: cargo-doc
Version: 0.37.0-3

This package surely is intended to bundle the docs as available here,
is it not?: https://doc.rust-lang.org/cargo/index.html

if I browse through the contents of /usr/share/doc/cargo-doc, there's
nothing useful at all, unlike /usr/share/doc/rust-doc/ from `rust-
doc`...

Reply | Threaded
Open this post in threaded view
|

Bug#934938: [cargo-docs] missing files

Ximin Luo-5
Hi, it will be non-trivial to fix this bug and I personally am unlikely to have time for it. You will need to:

1. vendor mdbook as well as cargo. This will involve editing the debian scripts in debian/make_orig_multi.sh, something that involves calling `cargo vendor` for the src/doc directory.
2. patch mdbook in the same way that we do so in the Debian rustc package, to make it not generate links to online javascript and other resources, but instead load them locally.
3. build mdbook during the cargo build
4. call mdbook to build the cargo doc

[hidden email]:

> Package: cargo-doc
> Version: 0.37.0-3
>
> This package surely is intended to bundle the docs as available here,
> is it not?: https://doc.rust-lang.org/cargo/index.html
>
> if I browse through the contents of /usr/share/doc/cargo-doc, there's
> nothing useful at all, unlike /usr/share/doc/rust-doc/ from `rust-
> doc`...
>


--
GPG: ed25519/56034877E1F87C35
GPG: rsa4096/1318EFAC5FBBDBCE
https://github.com/infinity0/pubkeys.git

Reply | Threaded
Open this post in threaded view
|

Bug#934938: [cargo-docs] missing files

Oleg Kostyuchenko-2
In reply to this post by jnqnfe
Hi,

So you actually removed the cargo book from the package. I'd say that made the package plain unusable.

If you are not able to ship the cargo book infrastructure now, why did you remove the book from the package in the first place, instead of sticking with the old working version?

In addition, the users have a poor indication of what's currently happening with the package. There is no "index.html" with a disclaimer "we cannot ship cargo book anymore", or a relevant entry in the changelog, or anything.

Reply | Threaded
Open this post in threaded view
|

Bug#934938: [cargo-docs] missing files

Ximin Luo-5
Oleg Kostyuchenko:
> Hi,
>
> So you actually removed the cargo book from the package. I'd say that made the package plain unusable.
>
> If you are not able to ship the cargo book infrastructure now, why did you remove the book from the package in the first place, instead of sticking with the old working version?

I'm a volunteer with limited amounts of free time. The rust upstream project changed how they the structure docs in the rust source code package, and I didn't notice this. So Debian build scripts were still working according to the old structure.

I don't personally have time to fix this. If you want this to be fixed, either do it yourself or find someone else with time to fix it.

>
> In addition, the users have a poor indication of what's currently happening with the package. There is no "index.html" with a disclaimer "we cannot ship cargo book anymore", or a relevant entry in the changelog, or anything.
>

--
GPG: ed25519/56034877E1F87C35
GPG: rsa4096/1318EFAC5FBBDBCE
https://github.com/infinity0/pubkeys.git