Skip to content

[Docs] Update outdated references from recent refactors #18906

Merged
tlopex merged 1 commit intoapache:mainfrom
tlopex:fe1
Mar 16, 2026
Merged

[Docs] Update outdated references from recent refactors #18906
tlopex merged 1 commit intoapache:mainfrom
tlopex:fe1

Conversation

@tlopex
Copy link
Member

@tlopex tlopex commented Mar 15, 2026

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request comprehensively updates various documentation files to synchronize them with recent significant refactors within the codebase. The changes ensure that instructions for building, linting, and understanding core architectural components like the FFI system are accurate and reflect the current state of the project, improving the experience for both new and existing contributors and users.

Highlights

  • Python Version Update: The minimum required Python version in the documentation has been updated from 3.7/3.8 to 3.10 across relevant sections.
  • Linting Workflow Migration: Documentation for linting commands has been migrated from docker/lint.sh and python tests/scripts/ci.py lint to pre-commit hooks, reflecting a recent refactor.
  • Build System Command Updates: References to make and make runtime for building have been replaced with equivalent CMake commands, aligning with the removal of the root Makefile.
  • FFI Documentation Refinements: Outdated references to dmlc::ThreadLocalStore and apps/extension have been removed, and FFI header links (e.g., packed_func.h to tvm/ffi/function.h) have been updated to reflect the tvm-ffi subproject structure.
  • Error Handling Example Modernization: A stale tvm.testing.ErrorTest example in the error handling documentation has been removed and replaced with a more general explanation of how the FFI system maps C++ errors to Python exceptions.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • docs/arch/pass_infra.rst
    • Removed an outdated reference to dmlc::ThreadLocalStore.
  • docs/arch/runtime.rst
    • Updated links for PackedFunc, minimum C API, and TVMValue to point to the new 3rdparty/tvm-ffi location.
    • Replaced references to packed_func.h and c_runtime_api.cc with function.h and c_api.h respectively.
    • Removed a dead link to apps/extension and updated the explanation for extension types.
  • docs/contribute/code_guide.rst
    • Updated C++ and Python linting instructions to use pre-commit commands.
    • Updated the recommended Python version from 3.7 to 3.10.
  • docs/contribute/error_handling.rst
    • Removed the specific tvm.testing.ErrorTest example and its output.
    • Replaced the example with a general explanation of how FFI maps C++ error prefixes to Python exceptions.
  • docs/contribute/pull_request.rst
    • Replaced python tests/scripts/ci.py lint and docker/lint.sh commands with pre-commit commands for linting.
    • Updated build instructions from make to CMake commands for running tests.
  • docs/how_to/tutorials/cross_compilation_and_rpc.py
    • Updated build instructions within code blocks from make runtime to CMake commands.
  • docs/install/from_source.rst
    • Updated the minimum Python version requirement from 3.8 to 3.10.
    • Updated instructions for building C++ tests, replacing make cpptest with CMake-based commands.
Activity
  • No specific review comments or activities have been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request does a good job of updating outdated references in the documentation, including Python version requirements, build commands, and links to source files. The changes align well with recent refactorings in the codebase. I've found one minor issue where a reference to a removed type definition was not updated in the explanatory text, which could cause confusion for readers. Otherwise, the updates are accurate and improve the documentation's correctness.

I am having trouble creating individual review comments. Click here to see my feedback.

docs/arch/pass_infra.rst (165-167)

medium

While you've correctly removed this typedef, a reference to PassContextThreadLocalStore remains on line 119. This reference is now dangling and should be updated to reflect the current thread-local storage implementation, for example by referring to PassContextThreadLocalEntry.

@tlopex
Copy link
Member Author

tlopex commented Mar 15, 2026

cc @tqchen

@tlopex tlopex merged commit be2ea89 into apache:main Mar 16, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants