SublimeLinter-contrib-checkpatch
此 SublimeLinter 插件提供了用于 C 语言代码风格检查的 Linux 内核 'checkpatch.pl' 工具的界面。
详细信息
安装次数
- 总计 1K
- Win 723
- Mac 463
- Linux 285
8月6日 | 8月5日 | 8月4日 | 8月3日 | 8月2日 | 8月1日 | 7月31日 | 7月30日 | 7月29日 | 7月28日 | 7月27日 | 7月26日 | 7月25日 | 7月24日 | 7月23日 | 7月22日 | 7月21日 | 7月20日 | 7月19日 | 7月18日 | 7月17日 | 7月16日 | 7月15日 | 7月14日 | 7月13日 | 7月12日 | 7月11日 | 7月10日 | 7月9日 | 7月8日 | 7月7日 | 7月6日 | 7月5日 | 7月4日 | 7月3日 | 7月2日 | 7月1日 | 6月30日 | 6月29日 | 6月28日 | 6月27日 | 6月26日 | 6月25日 | 6月24日 | 6月23日 | 6月22日 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 2 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Mac | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Linux | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 |
说明文件
SublimeLinter-contrib-checkpatch
此 SublimeLinter 插件为 SublimeLinter 提供了 Linux 内核 checkpatch.pl 工具的接口。它将用于具有“C”语法的文件(它不会在“C++”语法上工作)。
安装
要使用此插件,必须安装 SublimeLinter 3。如果未安装 SublimeLinter 3,请按照此处的说明进行操作。
代码风格检查器安装
在使用此插件之前,您必须确保系统上已安装 checkpatch.pl
。要安装 checkpatch.pl
,请按以下步骤操作
- 通过在终端中输入以下内容验证系统上是否已安装 perl
perl -v
- 获取 Linux 内核的源代码。例如,您可以在终端中输入以下内容
git clone https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
- 将 checkpatch.pl 添加到您的路径中。例如,您可以在终端中输入以下内容创建符号链接
sudo ln -s /path/to/kernel/source/tree/scripts/checkpatch.pl /usr/local/bin
注意:此插件需要 checkpatch.pl
0.32 或更高版本。
代码风格检查器配置
为了使 SublimeLinter 能够执行 checkpatch
,您必须确保其路径对 SublimeLinter 可用。在继续操作之前,请阅读并按照文档中“查找代码风格检查器可执行文件”部分的步骤进行操作。
一旦安装并配置了 checkpatch
,您就可以继续安装 SublimeLinter-contrib-checkpatch 插件(如果尚未安装)。
插件安装
请使用 Package Control 安装代码检查插件。这将确保新版本可用时插件会更新。如果您想从源代码安装以便修改源代码,那么您可能已经知道自己在做什么,所以我们在这里不涉及这方面的内容。
通过Package Control安装,请按照以下步骤进行
在Sublime Text中,打开命令面板并输入
install
。在您应该看到的命令列表中,您会看到Package Control: Install Package
。如果该命令没有高亮显示,请使用键盘或鼠标选择它。Package Control在获取可用的插件列表时会有几秒的延迟。当插件列表出现时,请输入
checkpatch
。在条目列表中,您应该看到SublimeLinter-contrib-checkpatch
。如果该条目没有高亮显示,请使用键盘或鼠标选择它。
设置
有关SublimeLinter如何与设置一起工作的通用信息,请参阅设置。有关通用代码检查器设置的信息,请参阅代码检查器设置。
除了标准的SublimeLinter设置之外,SublimeLinter-contrib-checkpatch还提供自己的设置。
设置 | 描述 |
---|---|
root | 内核树根的路径。 |
您必须设置此路径以指向有效的内核源码树(或者您可以在checkpatch
参数设置中添加“–no-tree”,但在这种情况下checkpatch将无法报告所有可能的错误/警告)。
贡献
如果您想贡献增强功能或修复,请执行以下步骤
- Fork插件库。
- 基于最新的
master
创建一个单独的主题分支进行开发。 - 提交并推送到主题分支。
- 发起pull request。
- 要有耐心。;-)
请注意,修改应遵循以下编码规范
- 缩进为4个空格。
- 代码应通过flake8和pep257的代码检查。
- 垂直空白有助于可读性,不要害怕使用它。
- 请使用描述性的变量名称,除非它们是非常著名的缩写,否则不要使用缩写。
感谢您帮忙!