64dd5a55ae
Previously, we were used /usr/share/doc/rust{,-doc}/html as a default
source, assuming that it would contain the standard library
documentation. This is true if the user installed the Rust
documentation manually or using a package manager. If they use rustup
instead, the documentation is placed in a subdirectory of ~/.rustup.
With this patch, we call `rustc --print sysroot` to determine the
installation directory of the currently activated Rust toolchain –
either the system Rust installation or a Rust installation managed by
rustup. We then use `$(sysroot)/share/doc/…` as a default path for the
standard library documentation (with /usr as a fallback if the call to
rustc does not return a valid path).
36 lines
1.1 KiB
Markdown
36 lines
1.1 KiB
Markdown
<!---
|
|
SPDX-FileCopyrightText: 2020 Robin Krahl <robin.krahl@ireas.org>
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# Changelog for rusty-man
|
|
|
|
## Unreleased
|
|
|
|
- Use `rustc --print sysroot` to determine the Rust installation directory
|
|
instead of always using `/usr`.
|
|
|
|
## v0.1.2 (2020-07-25)
|
|
|
|
This patch release adds basic logging output and a new `-e`/`--examples` option
|
|
to extract only the examples from the documentation. It also fixes a bug when
|
|
displaying the documentation for a function.
|
|
|
|
- Add basic logging using `env_logger` that can be enabled by setting the
|
|
environment variable `RUST_LOG=info`.
|
|
- Add `env_logger` dependency in version 0.7.1.
|
|
- Add `log` dependency in version 0.4.11.
|
|
- Show the definition for global functions.
|
|
- Add the `-e`/`--examples` option to only show the examples instead of opening
|
|
the full documentation for an item.
|
|
|
|
## v0.1.1 (2020-07-24)
|
|
|
|
This patch release fixes some minor issues with the documentation displayed on
|
|
crates.io.
|
|
|
|
## v0.1.0 (2020-07-24)
|
|
|
|
Initial release with support for directory sources and including viewers for
|
|
plain and rich text.
|