[all-commits] [llvm/llvm-project] 5ad919: [mlir] [docs] Broken link in MLIR Toy docs

Perry Gibson via All-commits all-commits at lists.llvm.org
Tue Dec 6 12:15:14 PST 2022


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 5ad919a1d6bbe449210f81e4ae7a5f765eb5a976
      https://github.com/llvm/llvm-project/commit/5ad919a1d6bbe449210f81e4ae7a5f765eb5a976
  Author: Wheest <Wheest at users.noreply.github.com>
  Date:   2022-12-06 (Tue, 06 Dec 2022)

  Changed paths:
    M mlir/docs/Tutorials/Toy/Ch-6.md

  Log Message:
  -----------
  [mlir] [docs] Broken link in MLIR Toy docs

In the Ch6 of the Toy Example for MLIR, there is a broken link.  If ones goes to [the page for Chapter 6](https://mlir.llvm.org/docs/Tutorials/Toy/Ch-6/), and click on the link "Conversion to the LLVM IR Dialect", one will see it takes you to a page that no longer exists.

I believe this should actually be [this link](https://mlir.llvm.org/docs/TargetLLVMIR/).

Note to reviewers that this is my first submitted patch to LLVM, and using the phabricator system, so there is a higher risk that I have made an error, and brief feedback on these patch notes would be appreciated.

Reviewer rational: Users who git blame say contributed to the tutorial.

I believe that automated tests on these markdown docs could reduce the risk of this kind of error occurring again.  For example, [this Python package](https://pypi.org/project/linkcheckmd/) checks for broken markdown links.  However, I am unsure where in the existing testing infrastructure this could go, I am only somewhat familiar with the C++ side.

Reviewed By: Mogball

Differential Revision: https://reviews.llvm.org/D133977




More information about the All-commits mailing list