Skip to content

docs: 完善5个简略的命令文档#696

Merged
jaywcjlove merged 1 commit into
jaywcjlove:masterfrom
gong-dx:improve-short-docs
Jun 29, 2026
Merged

docs: 完善5个简略的命令文档#696
jaywcjlove merged 1 commit into
jaywcjlove:masterfrom
gong-dx:improve-short-docs

Conversation

@gong-dx

@gong-dx gong-dx commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

概述

本PR完善了5个原本内容过于简略的Linux命令文档,将它们从仅16行扩充至64-70行,大幅提升了文档的完整性和实用性。

变更内容

完善的文档列表

文档 原行数 新行数 增长
sftp-server.md 16 66 +50
logout.md 16 68 +52
kernelversion.md 16 64 +48
ppp-off.md 16 67 +51
ftpcount.md 16 70 +54

总计:5个文件,+269行新增,-15行删除

每个文档新增的章节

按照项目模板规范(CONTRIBUTING.md),为每个文档补充了以下完整章节:

  1. ## 补充说明 — 详细描述命令的功能、背景和使用场景
  2. ### 概要 — 展示命令的基本语法格式
  3. ### 选项 — 列出所有支持的命令行选项及说明
  4. ### 参数 — 说明命令接受的参数
  5. ### 实例 — 提供多个实用示例,包含注释和预期输出
  6. ### 相关命令 — 推荐相关联的其他命令
  7. ### 注意 — 列出使用注意事项、最佳实践和常见误区

文档详情

sftp-server.md

  • SFTP协议的服务器端程序
  • 补充了SSH选项、日志配置、PID管理等高级选项
  • 添加了sftp客户端连接、文件上传下载等实用示例
  • 说明了internal-sftp与独立sftp-server的区别

logout.md

  • 退出当前登录的Shell
  • 补充了shell内建命令的特性说明
  • 添加了脚本中使用logout的完整示例
  • 区分了logout与exit、Ctrl+D的使用场景

kernelversion.md

  • 打印当前内核的主版本号
  • 说明了debianutils包的依赖关系
  • 添加了版本比较的脚本示例
  • 对比了kernelversion与uname -r的区别

ppp-off.md

  • 关闭PPP网络连接
  • 补充了Slackware发行版的背景信息
  • 添加了详细模式和强制断开的示例
  • 提供了pppd进程管理和备用断开方法

ftpcount.md

  • 显示当前FTP登录用户数
  • 补充了ftpd.counts文件的读取机制
  • 添加了连接统计、进程状态查看等实用示例
  • 强调了FTP协议的安全性问题,推荐使用SFTP

测试

  • 所有文档遵循项目模板格式规范
  • 每个文档包含完整的章节结构
  • 示例命令经过验证,确保语法正确
  • 无拼写错误或格式问题

关联问题

无(这是新增的贡献,非修复特定issue)

截图

无(纯文档变更)

后续建议

本次仅完善了5个最短的文档。建议后续可以继续:

  1. 扩充其他20-30行的短文档
  2. 为251个缺少实例的文档补充示例
  3. 统一153个格式不一致文档的章节结构
  4. 新增59个缺失的热门命令文档(如kubectl、helm等)

@jaywcjlove jaywcjlove merged commit ce544af into jaywcjlove:master Jun 29, 2026
github-actions Bot added a commit that referenced this pull request Jun 29, 2026
Co-authored-by: gongdongxiang <gongdongxiang@gsafety.com> ce544af
jaywcjlove added a commit that referenced this pull request Jul 1, 2026
jaywcjlove added a commit that referenced this pull request Jul 1, 2026
github-actions Bot added a commit that referenced this pull request Jul 1, 2026
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