阿里云-云小站(无限量代金券发放中)
【腾讯云】云服务器、云数据库、COS、CDN、短信等热卖云产品特惠抢购

学会使用 diff 和 patch 命令协同开发

79次阅读
没有评论

共计 2338 个字符,预计需要花费 6 分钟才能阅读完成。

导读 本文我们就来聊聊,怎么使用 diff 和 patch 命令进行协作开发。

之前我在公司上班的时候,需要经常跟外国同事一起协同开发(之前在外企上班)。由于是异地协作,所以沟通几乎全部是通过邮件。

我们有使用 Git 进行代码版本管理,但有时为了快速验证,外国同事非常喜欢发个 patch 包过来让我们做测试。这也是我第一次在工作中使用 diff 和 patch 命令。

简单来讲,diff 命令可以用来创建一个差异文件,然后接收者可以使用 patch 命令将这部分差异代码应用到自己的代码里,达到协同开发的目的。

本文我们就来聊聊,怎么使用 diff 和 patch 命令进行协作开发。

一个简单的例子

大家的业务及所使用的编程语言都不一样,所以为了便于叙述与理解,这里不使用具体的代码,而是一起编写一个具有一定逻辑的步骤文档。

假设你和我正在合作编写一个描述如何泡茶的文件。

下面是你写的代码部分:

Boil water.  
Warm the teapot.  
Add tea and water to the teapot.  
Place a tea cosy over the teapot.  
Steep for 6 minutes.  
Pour tea into cup.  
Add milk.

你家不种茶,也没有泡茶经验,所以这里有很多优化空间。

我家毕竟是多年种茶老司机,也培养出多名优秀的卖茶女业务代表,所以我大笔一挥,改进了一下泡茶步骤。

我先将文件复制为 tea-revision.md,然后在此基础上进行修改,得到以下内容:

Warm a teapot in the proving drawer of your oven.  
Boil water.  
Add tea leaves to a tea strainer.  
Add strainer and water to teapot.  
Steep for 6 minutes. Keep it warm with a tea cosy.  
Pour tea into cup.  
Optionally, add warm milk.

在这里,有几行代码语句没有任何改动,比如 Boil water 和 Pour tea into cup;新增了几行代码,比如第一行,而有些行则进行了改动(增加或减少了部分内容)。

这么优秀的代码,你不应用的话太可惜了~

使用 diff 命令创建差异

我如果直接把写好的代码丢给你,你肯定一头雾水,需要自己去对比两份代码的差异,费时费力。这时 diff 命令就派上用场了。

diff 命令可以直观显示两个文件之间的差异,使用 –unified(或者简写为 -u)选项可以显示哪些行被添加或删除。默认情况下,diff 会将差异结果输出打印到终端。

$ diff --unified tea.md tea-revised.md   
--- tea.md      2021-11-13 10:26:25.082110219 +1300  
+++ tea-revised.md      2021-11-13 10:26:32.049110664 +1300  
@@ -1,7 +1,7 @@  
+Warm a teapot in the proving drawer of your oven.  
 Boil water.  
-Warm the teapot. 
-Add tea and water to the teapot.  
-Place a tea cosy over the teapot.  
-Steep for 6 minutes.  
+Add tea leaves to a tea strainer.  
+Add strainer and water to teapot.  
+Steep for 6 minutes. Keep it warm with a tea cosy. 
 Pour tea into cup.  
-Add milk.  
+Optionally, add warm milk.

在这个差异显示中,加号(+)表示添加到原文件中的内容,而减号(–)表示删除或更改的行。

根据差异创建 patch 文件

现在我们有了两份代码的差异部分了,我们可以根据差异生成补丁文件。patch 文件的生成很简单,只需要使用标准 Bash 重定向将 diff 命令的结果输出就行了:

$ diff -u tea.md tea-revised.md > tea.patch

该文件的内容与输出到终端的内容完全相同,我们可以使用 cat 或 vim 命令来查看这个文件。说个题外话,使用 Emacs 工具来查看的话,它会根据每行是被添加还是被减去来对每一行使用颜色区分,非常直观。

学会使用 diff 和 patch 命令协同开发

使用 patch 文件应用更改

当我生成好了补丁文件之后,我就可以将它发给你(QQ/ 微信,邮件,或者其它方式都行),你就可以将它应用到你的旧文件中。

这里我们需要使用 patch 命令应用补丁:

$ patch tea.md tea.patch

应用了补丁之后,你就得到了一个与我的版本相同的文件:

$ cat tea.md  
Warm a teapot in the proving drawer of your oven.  
Boil water.  
Add tea leaves to a tea strainer.  
Add strainer and water to teapot.  
Steep for 6 minutes. Keep it warm with a tea cosy. 
Pour tea into cup.  
Optionally, add warm milk.

随着开发的进行,我们会进行多次代码增减,在这过程中我们可以多次生成补丁并应用,然后互相审核,一起为代码做贡献。

命令安装

在 Linux 和 macOS 系统上,已经默认拥有 diff 和 patch 命令。但在 Windows 系统上就需要自己安装了,一个简单的方法就是通过 Cygwin 来获得这两个命令。

如果你曾尝试通过邮件或微信来协作处理文件,并且发现自己试图描述需要进行更改的位置,那么 diff 和 patch 这两个工具非常适合你,可以省去很多沟通成本。

阿里云 2 核 2G 服务器 3M 带宽 61 元 1 年,有高配

腾讯云新客低至 82 元 / 年,老客户 99 元 / 年

代金券:在阿里云专用满减优惠券

正文完
星哥说事-微信公众号
post-qrcode
 0
星锅
版权声明:本站原创文章,由 星锅 于2024-07-25发表,共计2338字。
转载说明:除特殊说明外本站文章皆由CC-4.0协议发布,转载请注明出处。
【腾讯云】推广者专属福利,新客户无门槛领取总价值高达2860元代金券,每种代金券限量500张,先到先得。
阿里云-最新活动爆款每日限量供应
评论(没有评论)
验证码
【腾讯云】云服务器、云数据库、COS、CDN、短信等云产品特惠热卖中