Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implementation -- Bugfixes #40

Merged
merged 7 commits into from
May 21, 2023
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 40 additions & 2 deletions thesis-en.tex
Original file line number Diff line number Diff line change
Expand Up @@ -744,8 +744,46 @@ \section{Healthier codebase}\label{r:section_healthier_codebase}

\section{Bugfixes}\label{r:section_bugfixes}

<Here write a list about found and fixed bugs>

Another important part of our work was diagnosing the issues present in the tool.
Throughout our contributions to the project, we managed to fix the following bugs:
\begin{itemize}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider sorting these in order of "how interesting they are" to the reader.

\item current and baseline's rustdoc being generated with different features, which
resulted in false-positives,
\item tests failing on Rust 1.67.0,
mgr0dzicki marked this conversation as resolved.
Show resolved Hide resolved
\item incorrect baseline version printed when the baseline was specified through
a path to the manifest,
\item trustfall-rustdoc-adapter incompatibility with the new version of rustdoc v23
which stopped exporting inlined items of external crates,
\item running the tool resulting in unwanted changes in the Cargo.lock file,
mgr0dzicki marked this conversation as resolved.
Show resolved Hide resolved
\item CI job wrongly checking the exit code in one of
the integration tests,
\item broken links appearing in the tool's output,
\item false-positives from target-specific optional features,
\item rustdoc command's output showing up without colors,
\item compilation error which happened because of changes
mgr0dzicki marked this conversation as resolved.
Show resolved Hide resolved
in one of the tool's dependencies,
\item the rustdoc of the current and the baseline crates overwriting each other,
\item CLI choosing the latest release from the registry as a baseline version
even when it had been yanked,
\item CLI ignoring the \texttt{-{}-release-type} option.
\end{itemize}
Apart from that, we reported a few bugs that were or are to be fixed by other contributors:
\begin{itemize}
\item incorrect path to the generated rustdoc when passing a
manifest path in the CLI,
\item output of the tool on the bevy-audio crate seeming
like it was producing a false positive,
\item duplicated lint's output on the bevy-render crate,
\item the tool failing to work when generating rustdoc of a crate
that has only yanked releases,
\item the tool printing some internal data while checking the clap
crate,
\item a false-positive related to re-exporting types, values and
macros with the same names,
\item CLI of v0.18.2 not looking for the baseline in the registry
as it was supposed to do,
\item the precompiled tool crashing on Windows machines.
\end{itemize}

% chapter semver-crater
\chapter{Tool's findings in popular crates}\label{r:chapter_results_popular_crates}
Expand Down