Skip to content

docs: fix GitHub workspace path and pybind guidance#553

Merged
zhangstevenunity merged 1 commit into
hw-native-sys:mainfrom
HecreReed:docs/readme-workspace-pybind
Apr 23, 2026
Merged

docs: fix GitHub workspace path and pybind guidance#553
zhangstevenunity merged 1 commit into
hw-native-sys:mainfrom
HecreReed:docs/readme-workspace-pybind

Conversation

@HecreReed
Copy link
Copy Markdown
Collaborator

Summary

  • update the README workspace example to use the GitHub clone directory name
  • pin the documented install command to
  • add a short note for the known 3.x build error

Testing

  • doc-only change

Copy link
Copy Markdown

@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 updates the project name casing from 'pto-as' to 'PTOAS' throughout the README and pins the pybind11 dependency to version 2.12.0 to ensure compatibility with LLVM/MLIR Python bindings. It also adds a troubleshooting note for specific compilation errors. Feedback suggests refining the version incompatibility note to specify that issues begin with pybind11 version 2.13.0 rather than 3.x to provide more accurate guidance for users.

Comment thread README.md
Comment on lines +78 to +80
> 说明:当前 LLVM/MLIR Python 绑定与 `pybind11` 3.x 不兼容。
> 如果编译 LLVM 时遇到 `def_property family does not currently support keep_alive` 等报错,
> 请先执行上面的降级命令。
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The note mentions incompatibility with pybind11 3.x, but the specific error def_property family does not currently support keep_alive actually started appearing with pybind11 2.13.0. Since pybind11 3.x is not yet a released version and the breakage begins at 2.13.0, it would be more accurate to reference version 2.13.0 or later to avoid confusion for users who might have 2.13.x installed.

Suggested change
> 说明:当前 LLVM/MLIR Python 绑定与 `pybind11` 3.x 不兼容
> 如果编译 LLVM 时遇到 `def_property family does not currently support keep_alive` 等报错,
> 请先执行上面的降级命令。
> 说明:当前 LLVM/MLIR Python 绑定与 `pybind11` 2.13.0 及以上版本不兼容
> 如果编译 LLVM 时遇到 `def_property family does not currently support keep_alive` 等报错,
> 请先执行上面的降级命令。

@reedhecre
Copy link
Copy Markdown

Codex Review

该评论由 review 机器人自动更新。

  • PR: docs: fix GitHub workspace path and pybind guidance #553 docs: fix GitHub workspace path and pybind guidance
  • Author: HecreReed
  • Base/Head: main / docs/readme-workspace-pybind
  • Head SHA: eb5b2fb26948
  • Trigger: 检测到新的 open PR
  • Generated At: 2026-04-23T04:11:25Z
  • Status: completed

Summary

未检查到 PR #553 存在问题

Findings

No issues found.

@HecreReed HecreReed marked this pull request as ready for review April 23, 2026 06:04
@zhangstevenunity zhangstevenunity merged commit f3da6f1 into hw-native-sys:main Apr 23, 2026
11 checks passed
@reedhecre
Copy link
Copy Markdown

A3 板测完成(有跳过)

  • 触发方式:merged
  • 源码提交:f3da6f1a5738
  • 结果汇总:OK 202 / FAIL 0 / SKIP 1
  • 日志:/home/zhongxuan/ptoas-board-monitor/runtime/logs/20260423_205605_merged_pr553.log
  • 结果 TSV:/home/zhongxuan/ptoas-board-monitor/runtime/logs/20260423_205605_merged_pr553.tsv

@reedhecre
Copy link
Copy Markdown

A5 板测成功

  • 触发方式:merged
  • 源码提交:f3da6f1a5738
  • 结果汇总:OK 17 / FAIL 0 / SKIP 0
  • 日志:/root/ptoas-board-monitor-a5/logs/20260423_205605_merged_pr553.log
  • 结果 TSV:/root/ptoas-board-monitor-a5/logs/20260423_205605_merged_pr553.tsv

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.

3 participants