blob42/rusty-man
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
f0245bada3
rusty-man/CHANGELOG.md

40 lines
1.3 KiB
Markdown
Raw Normal View History

Release v0.1.0
2020-07-24 12:16:34 +00:00
<!---
SPDX-FileCopyrightText: 2020 Robin Krahl <robin.krahl@ireas.org>
SPDX-License-Identifier: MIT
-->
Add top-level heading to changelog
2020-07-25 11:24:11 +00:00
# Changelog for rusty-man
Use rustc --print sysroot for default sources 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).
2020-07-25 17:06:27 +00:00
## Unreleased
- Use `rustc --print sysroot` to determine the Rust installation directory
instead of always using `/usr`.
Fix definition for methods in documentation parser This patch changes the documentation parser for methods to use the first code child of the subheading as the definition instead of the first child. This fixes a problems when there is additional information in the subheading, for example about the relevant traits.
2020-07-26 08:42:17 +00:00
- Improve the documentation parser:
- Fix the definition of methods to only contain the actual definition.
Remove spurious members from module documentation With this patch, we require that the identifier element for a member in the module documentation is a direct child of the table cell. This fixes problems with spurious member elements if there are more elements in the table cell, e. g. stability annotations.
2020-07-26 09:04:13 +00:00
- Remove spurious members in module documentation.
Show definition for constants Similar to the fix for functions in 1a242e5, we have to use a different selector to query the definition for constants, "pre.const" instead of ".docblock.type-decl".
2020-07-26 09:19:54 +00:00
- Show the definition for constants.
Use rustc --print sysroot for default sources 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).
2020-07-25 17:06:27 +00:00
Release v0.1.2 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.
2020-07-25 11:27:56 +00:00
## 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 changelog entry for logging functionality We introduced basic logging in commit e69e4af but didn’t update the changelog. This patch adds the missing changelog entry.
2020-07-25 09:44:57 +00:00
- 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.
Fix definition selector for functions Previosuly, we always used the selector ".docblock.type-decl" to select the definition for an item. But this did not work for functions. Therefore we change the selector to "pre.fn" for functions.
2020-07-25 10:18:32 +00:00
- Show the definition for global functions.
Add -e/--example option to only show examples As requested here [0], this patch adds a new -e/--example option that extracts the examples from the documentation string instead of printing the full documentation for an item. Syntax highlighting will be added in the future. [0] https://old.reddit.com/r/rust/comments/hx16j0/rustyman_a_commandline_viewer_for_rustdoc/fz3utjf/
2020-07-25 10:58:52 +00:00
- Add the `-e`/`--examples` option to only show the examples instead of opening
the full documentation for an item.
Add changelog entry for logging functionality We introduced basic logging in commit e69e4af but didn’t update the changelog. This patch adds the missing changelog entry.
2020-07-25 09:44:57 +00:00
Add top-level heading to changelog
2020-07-25 11:24:11 +00:00
## v0.1.1 (2020-07-24)
Release v0.1.1 This patch release fixes some minor issues with the documentation displayed on crates.io.
2020-07-24 12:24:57 +00:00
This patch release fixes some minor issues with the documentation displayed on
crates.io.
Add top-level heading to changelog
2020-07-25 11:24:11 +00:00
## v0.1.0 (2020-07-24)
Release v0.1.0
2020-07-24 12:16:34 +00:00
Initial release with support for directory sources and including viewers for
plain and rich text.
Reference in New Issue Copy Permalink