翻译 GDB 官方文档

翻译 GDB 官方文档

项目地址

https://github.com/shootercheng/gdb-translate.git

项目结构

bash 复制代码
$ tree -L 1
.
├── cmd
├── go.mod
├── input
├── internal
├── LICENSE
├── output
├── README.md
├── sys_prompt.md
└── tests
  1. input 文件夹:输入的原始英文html,根据 gdb 源码生成的
  2. output 文件夹:存放调用大模型翻译后生成的中文 HTML 文件。这些文件是机器翻译的初稿,可能存在不准确或生硬之处,欢迎社区成员审阅、修正并提交合并请求(Pull Request)来共同完善。

项目简介
gdb-translate 是一个旨在将 GNU 调试器 (GDB) 官方文档(英文)实现自动化翻译的工具项目。GDB 是 Linux/Unix 系统下强大的源代码级调试器,但其官方手册内容庞大,对中文开发者存在一定的语言门槛。本项目通过结合大模型 API 与本地处理,尝试为中文社区提供一份可读性更强的 GDB 文档。

项目目标

  1. 自动化翻译:批量处理 GDB 官方 HTML 文档,调用大模型服务生成中文初稿。
  2. 保持结构:确保翻译后的文档保持原有的章节结构、代码示例和超链接。
  3. 社区共建:生成的翻译初稿作为基础,鼓励开发者根据专业知识进行校对、润色和术语统一,最终产出高质量的本地化文档。

如何参与贡献?

我们非常欢迎任何形式的贡献,让这份文档变得更好:

  • 代码贡献 :如果您熟悉 Go 语言、HTML 解析或网络请求,可以查看项目的 Issues 列表,修复 Bug 或实现新功能。
  • 文档校对 :这是最重要的环节!即使不懂编程,您也可以帮助我们。项目运行后会生成翻译后的 .html 文件,您可以:
    • 通读翻译内容,修正明显的机器翻译错误。
    • 统一专业术语(例如,将 "breakpoint" 统一译为"断点")。
    • 优化句子,使其更符合中文技术文档的表达习惯。
  • 反馈与建议:在使用翻译文档或本项目过程中遇到任何问题,或有好的想法,都欢迎在 GitHub 仓库提交 Issue 进行讨论。

贡献流程简述

  1. Fork 本仓库到您的 GitHub 账户。
  2. 克隆您的 Fork 到本地,创建新的分支进行修改。
  3. 完成修改后,提交代码并推送到您的仓库。
  4. 向本仓库发起 Pull Request (PR),并描述您的修改内容。

让我们共同努力,降低 GDB 的学习门槛,助力中文开发者社区!

官方文档地址

https://sourceware.org/gdb/documentation/

下载源码包

  1. https://ftp.gnu.org/gnu/gdb
  2. 下载 https://ftp.gnu.org/gnu/gdb/gdb-17.2.tar.xz

编译html

  1. 检查环境,解决依赖,生成Makefile
bash 复制代码
$ ./configure
  1. 根据错误提示安装依赖
bash 复制代码
$ sudo apt update
$ sudo apt install libgmp-dev libmpfr-dev texinfo
  1. 编译html
bash 复制代码
$ make html

html 文档在 ${workdir}/gdb-17.2/gdb/doc/gdb 中生成

bash 复制代码
~/gdb-17.2/gdb/doc/gdb$ ls -lt|grep ".html"|wc -l
866

一共有866个html文件

运行翻译程序

  1. 安装环境变量加载工具
bash 复制代码
$ go install github.com/joho/godotenv/cmd/godotenv@latest
$ godotenv

Run a process with an env setup from a .env file

godotenv [-o] [-f ENV_FILE_PATHS] COMMAND_ARGS

ENV_FILE_PATHS: comma separated paths to .env files
COMMAND_ARGS: command and args you want to run

example
  godotenv -f /path/to/something/.env,/another/path/.env fortune
  1. 运行测试
bash 复制代码
$ godotenv -f .env go test ./tests/...
ok  	github.com/shootercheng/gdb-translate/tests/internal/request	26.403s
  1. 运行主程序
bash 复制代码
$ godotenv -f .env go run ./cmd/main/main.go
相关推荐
ttkwzyttk7 天前
GDB TUI窗口管理
gdb
ttkwzyttk8 天前
GDB观察点与捕获点使用
gdb
ttkwzyttk13 天前
GDB函数调用栈管理
gdb
ttkwzyttk14 天前
GDB调试变量、内存与寄存器查看与修改
gdb
ttkwzyttk15 天前
GDB调试简介与调试配置
gdb
modelmd1 个月前
GDB 摘要
gdb
源分享1 个月前
GDB下载和安装保姆级教程
gdb
kidwjb2 个月前
一次多进程信号量同步失效的排查实录
gdb·进程通信·信号量
炘爚2 个月前
C++11实现线程池:项目实现过程的报错与gdb调试
stl·gdb·shared_ptr