Bug#934938: [cargo-docs] missing files

[jnq...@gmail.com]

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`...

[Ximin Luo]

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

jnq...@gmail.com:

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

[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?

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.

[Ximin Luo]

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.
>

[Mario González Troncoso]

Hey, I might be able to help build deb packages. Because I've been
learning rust for a few, this seems a good place to start contributing
to Debian.

May I know what's the bug's latest status and where should I start first?
Thanks!

--
https://www.linkedin.com/in/gonzalemario

[Aaron Burdick]

Hello Mario,

I'm new like you and have no idea where to start. I too have some
experience with rust and thought this would be a good way to contribute
to Debian.

So far I've read this guide for Debian maintainers

https://www.debian.org/doc/manuals/debmake-doc/

It seems like the Debian package is source-controlled here (I'm not
sure, but I see Ximin Luo as a member of that group)

https://salsa.debian.org/rust-team/cargo

I signed up for a Gitlab account, but it seems an administrator has to
let you in.

It seems like what needs to be done in regards to this bug is described
in some detail here

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=969210#10

And one of the maintainers said "Patches welcome", but again, I'm not
sure how to do that. I'm guessing by making a merge request?
https://salsa.debian.org/rust-team/cargo/-/merge_requests

It's a really big stab in the dark, but maybe you can clone the repo and
try and get a feel for what is being talked about and see if you can
"fix it".

Sorry that's all I know. If anybody can confirm this, I wouldn't mind
helping either.

Thanks,

Aaron