RCS 簡介

keyword 相關資訊

$Header$ 全路徑名(full pathname)+日期(date)+作者(author)+描速(state)+正 lock 該檔案者(locker)

$Id$ RCS 檔名+日期(date)+作者(author)+描速(state)+目前 lock 住該檔案者(locker)

$Date$ 日期

$Log$ 關於該版本的 log 的訊息

$Author$ 作者

$locker$ 目前 lock 住該檔案者

$revision$ revision number

$source$ 全路徑名(full pathname)

3.3.2.2 IDKeyword 的使用:

上述的這些識別關鍵字串( IdKeyword )該加在何處, RCS 又如何來解釋各個字串, 可以分下面兩個部份說明:

(1) 識別關鍵字串( IdKeyword )該加在何處?

(2) RCS 如何來解釋各個識別關鍵字串( IdKeyword )?

(1) 識別關鍵字串( IdKeyword )該加在何處?

這些識別關鍵字串( IdKeyword )的使用是將其加在檔案本文之內, 通常加在檔頭的部份, 一來醒目容易找尋, 也容易跟原本的檔案內容區分開來。加入的方式下頁圖(1)所示, 若在 test.c 的檔頭加上 $ID$ 則 RCS 在從 archive file 中取出( check out )時會用 $Id$ 代表的相關資訊加在 $ 符號裡面, 下頁圖(2) 所示。

圖一

圖二

(2) RCS 如何來解釋各個識別關鍵字串( IdKeyword )?

RCS 中在用指令 co 從 archive file 取出檔案時, 識別關鍵字串( IdKeyword ) 會被相關資訊取代, 這些相關資訊可以利用在指令 co 後加上參數( option )來指定識別關鍵字串( IdKeyword ) 解釋的方式, 例如上例若用指令

co -kv test.c

利用這些參數可以令 RCS 依照不同的方式來解釋識別關鍵字串( IdKeyword ), 以下是相關的的參數列表( option ):

Option	解釋方式	說明
-kkv	keyword 本身 + 相關資訊	這是 default 的解釋方式如上最後第二個例子
-kkvl	keyword 本身 + 相關資訊 + locker	如 -kkv 再加上 lock 該檔者
-kk	keyword 本身	只示 keyword 本身不加解釋
-kv	相關資訊	只示相關資訊不加 keyword 本身

3.3.2.3 識別關鍵字串( IdKeyword ) 的檢視與利用:

識別關鍵字串( IdKeyword )的形成, 無非是想讓使用者更方便的得到一些各版本的基本資訊, 加入識別關鍵字串( IdKeyword )對使用者會有那些方便, 說明如下:

(1)識別關鍵字串( IdKeyword ) 的檢視。

(2)識別關鍵字串( IdKeyword ) 的利用。

(1)識別關鍵字串( IdKeyword ) 的檢視:

欲看到檔案中的識別關鍵字串( IdKeyword ), 可以使用指令 ident 來取得, 例如在檔案 test.c 中加入 Keyword $date$ 使用指令 ident 則:

若 test.c 產生 test.o 則識別關鍵字串( IdKeyword )亦會加在 test.o 檔中, 可使用 ident 看到。如下:

(2)識別關鍵字串( IdKeyword ) 的利用:

除了幫助使用者方便的得到一些各版本的基本資訊, 也可以利用檔案間識別關鍵字串( IdKeyword )比較而獲得一些訊息。如上例中可以看到 test.c 和 test.o 檔生成時間的差異, 此外也可以用指令 rcsdiff 或 rcsmerge 來比較或整合。因為識別關鍵字串( IdKeyword )會直接寫入檔案之中, 在比較版本內容( rcsdiff )或整合版本內容( rcsmerge )時要考慮 IDKeyword 是否要一起比較或整合, 這可以利用 3.3.2.1 )中列表的參數來控制。

3.4 Using Mark-Symbol

所謂的標記符號是指一個版本除 revision number 外賦予的符號名稱。如果各個版本的區分只用 revision number, 則當檔案的版本多了之後, 想要找到其中特定的版本就不容易了。因為只從 revision number 很難知道該版本的內容, 所以 RCS 還可以給各版本一個標記符號( mark symbol ), 利用標記可以更清楚的知道各版本之間的關係。以下將分成兩個部份來說明標記符號( mark symbol )的使用與應用:

3.4.1 如何產生標記符號:

3.4.2 標記符號的好處:

分別敘述如下:

3.4.1 How to Creating Mark-Symbol

標記符號( mark symbol )的使用並沒限制符號的形式, 除了幾個 RCS 的特殊字元不能使用外(包括$ (錢字號) ,(逗號) .(句點) ;(分號) :(冒號) 以及 @ 等符號), 對於符號的長度等都不加限制。一般建議的形式是用數字跟 "_" 來建構標記符號( mark symbol ), 例如 sym1_0 sym1_0_1 等。產生標記符號可以在生成該版本時用指令 ci -n 加入或之後用 RCS -n 加入, 例如欲在檔案 test.c 的版本 1.2 處產生標記符號( mark symbol ) r1_0 則使用指令:

ci -nr1_0 test

rcs -nr1_0:1.2 test

產生出來的標記符號( mark symbol )可以用 rlog 指令看到:

一個版本可以有多個標記符號如欲在版本 1.2 處產生標記符號 r1_0 及 r1_0_head 則使用指令:

rcs -nr1_0:1.2 -nr1_0_head:1.2 test

如欲取消版本 1.2 的標記符號 r1_0 則使用指令:

rcs -nr1_0 test (-n 後不接 :\,[revision number] )

3.4.2 What Mark-Symbol Is Good For?

使用標記符號除了可以代替 revision number 來指定版本外, 其它的好處就是:

(1) 幫助辨視檔案版本。

(2) snapshot 的建立。

分別說明如下:

(1) 幫助辨視檔案版本:

它比 revision number 更能傳達該版本的特性, 所以可以給相關的版本同樣的標記符號, 例如 r1_0 r1_1 ... 來標示這些版本之間的關係。可以用指令 rlog -h 來看所有被標示的版本, 如下

(2) snapshot 的建立:

一個程式或文件發展的過程中可能結合數個檔案, 每個檔案間會因為修改的次數的不同, 而產生不同個數個版本, 這將使得不易藉由版本序號( revision number ) 來區分不同檔案間那幾個版本是相關的。snapshot 的產生便是藉由給檔案間相關版本統一的名稱, 來標記他們之間的關係, 這名稱便可以利用標記符號( mark symbol )來產生。特別是在 Emacs 中對檔案間 snapshot 的產生提供一些特別的功能, 有可以對目錄下所有檔案統一產生或讀取 snapshot 的功能(見附錄 C )。

例如筆者在發展此文件使用 latex 來編排時, 各章節分別以不同的檔案編寫, 檔案關係如下:

則如需要分別使用 CJK 和 Poorman 兩種模式, 則此文件可利用 RCS 來儲存, 因為兩者只有在前頭設定和 Chapter、Section 的標題上不同而已, 只要稍加修改便可互換模式。用 RCS 可以把不同模式用不同版本儲存起來, 利用 Mark-Symbol 可以清楚的標示各檔案相關的版本如下:

3.5 Comparing and Merging Between Revision

RCS 可以比較檔案中任兩個版本之間的差異, 跟 diff 的功能類似, 不同的只是 RCS 的 rcsdiff 是比較同一檔案不同版本間的差異, 而 diff 則是比較不同檔案之間內容的差異, 比較版本間的差異, 可以幫助除錯( debug )的工作。

如下圖, 在版本 1.3 的地方發現錯誤( bug )於是回頭找尋錯誤發生的階段, 發現錯誤是在版本 1.2 發生的, 在除錯完成後產生了校正版本 1.2.1.1。如果版本 1.3 已經快完成某個階段性的目標且棄之可惜, 此時則可以用整合( merge )的功能將版本 1.2.1.1 和版本 1.2 的不同處與版本 1.3 整合起來, 得到新的工作檔案。以下將分別討論 RCS 如何比較版本間的差異( rcsdiff )與整合( rcsmerge ):

3.5.1 Comparing Difference Between Revisions

將以下列圖示檔案 test.c 的版本結構, 說明針對不同的版本有下列三種比較方式 :

(1) 目前工作檔案與最近儲存版本的比較:

rcsdiff test.c (比較 working file 與版本 1.3 )

都不指定版本時, rcsdiff 會比較目前工作檔案( working file )與最近儲存的版本。所謂的最近儲存的版本是指主幹( default branch )上最後存入的一個版本。

(2) 目前工作檔案與任一版本的比較:

rcsdiff -r1.2 test.c (比較 working file 與版本 1.2 )

可以用 -r" 來指定欲比較的版本跟目前工作檔案比較。

(3) 任意兩個版本的比較:

rcsdiff -r1.2 -r1.2.1.1 test.c (比較版本 1.2 與 1.2.1.1)

比較兩個任意的版本。

當在檔案中使用 IdKeyword 且用 rcsdiff 做比較時 IdKeyword 的部份可以被視為檔案內文而被比較(見 3.3.2 節), 例如使用 $date$ 時, 可以比較出版本產生時間的差異。(見 3.3.2.3 節)

3.5.2 Merging revision

欲將檔案 pf.c 版本 1.2 與 1.2.1.1 的不同處與版本 1.3 整合, 可以使用 rcsmerge 和 co -j 兩個指令, 分別敘述如下:

首先需取出版本 1.3 的可寫入檔然後使用指令:

rcsmerge -r1.2 -r1.2.1.1 pf.c

則整合後的檔案將寫入工作檔案( working file ) pf.c 中。

(2) 使用指令 co -j :

在從 archive file 中取出工作檔案時即整合之, 使用指令:

co -l -r1.3 -j1.2:1.2.1.1 pf.c

也可以一次整合多個檔案的相異處, 例如欲將 1.2 和 1.2.1.1 的不同處與 1.3 和 1.3.1.1 的不同處跟 1.4 整和起來時, 則使用指令:

co -l -r1.4 -j1.2:1.2.1.1,1.3:1.3.1.1 pf.c

3.6 Setting Access List

只有記錄為該檔案的可存取者, 才能存取該檔案的版本。欲將一使用者加入可存取行列, 需將其名子寫入該檔 access list 中, 例如加使用者 jhchen 至檔案 test.c 的 access list 需使用指令 rcs -a :

rcs -ajhchen test.c

或是將另一個檔案 f.c,v 的 access list 拷備到檔案 test.c 的 access list 則利用 option -A:

rcs -Af.c test.c

加入的 access list 可以用指令 rlog 看到:

若欲將使用者 jhchen 從 access list 中去除, 則使用指令:

rcs -ejhchen test.c

若欲將檔案 test.c 的 access list 全部清除除, 則使用指令:

rcs -e test.c

A. The Instruction Set of RCS

指令	使用參數	說明
ci (check in)		產生或寫入 archive file
	-d"date"	給定版本生成時間
	-f	強制產生新版本(不管是否寫入相同版本內容)
	-w"name"	給定生成該版本的作者名
	-m"log-file"	直接以檔案的形式寫入附記( log )
	-n[symbol]	在寫入 archive file 同時, 給定標記符號( mark symbol )
	-r[number]	寫入時指定版本的 rivision number
	-t"description"	直接以檔案的形式寫入描述( description )
	-l	寫入後再取出該版本為工作檔案( lock )
	-u	寫入後再取出該版本為工作檔案( unlock )
co (check out)		從 archive file 讀出工作檔案
	-d[date]	取出在指定時間前最後生成的版本
	-f	強制取出版本內容取代目前工作檔案
	-j	取出並整合指定的版本內容
	-l	lock 取出版本
	-p	取出版本內容至標準輸出( standard output )
	-r[number]	指定取出版本
	-w[name]	取出指定作者名之版本
	-u	取出 unlock 的版本內容
rcs	-A[file]	將其它檔案的可存取名單寫入該檔的可存取名單
	-a[name]	將使用者寫入可存取名單
	-b[branch number]	設定主支( default branch )
	-e[name]	將使用者自可存取名單內剔除
	-l[number]	lock 該版本但不取出
	-m	更改檔案版本的附注( log ) 的內容
	-n[symbol]	產生或去除標記符號( mark symbol )
	-o[number]	從檔案的 archive file 中移除某版本
	-t	改檔案版本的描述( description ) 的內容
	-u[number]	去除該版本 lock 的狀態
rcsclean		清除 unlock 的工作檔案
	-n	顯示命令列但不執行
	-u	清除工作檔案
rcsdiff		比較版本內容的差異(包括 IDKeyword)
	-kk	比較版本內容的差異(不包括 IDKeyword)
	-kkvl	指定 IDKeyword 的比較方式
	-r	指定欲比較版本
rcsmerge	-r	整合檔案版本(包括 IDKeyword)
	-kk	整合檔案版本(不包括 IDKeyword)
	-kkvl	指定 IDKeyword 的整合方式
rlog		列出檔案各版本附記(log)一覽表
	-b	列出檔案主分支( default branch )的附記(log)一覽表
	-h	列出檔案附記(log) 的標頭(header)
	-L	若該檔友被 lock 則列出各版本附記(log)一覽表
	-R	列出檔案的 archive file 路徑與名稱
	-t	列出檔案附記(log)的標頭(header)+ 描述(description)

B. Using Version Control with Makefile

Version control 工作環境的優點是可以利用對不同版本的儲存, 來幫助程式或文件發展。對於工作流程可以用 Make 來簡化及管理。Make 的使用是透過 Makefile 的編寫, 安排各個工作程序中檔案的關係與巨集( marco )使用。以下將以從介紹 Makefile 的功能與編寫評/font>始, 以發展 C 的程式 pf.c 為例子, 說明如何利用 make 來支援 version control 的工作環境。

B.1 What Makefile Can Do for Version Control ?

(1) 安排工作程序中檔案間的關係, 並做檔案 time-dependence 的檢查。

(2) 巨集的使用。

分別說明如下:

(1) 安排工作程序中檔案間的關係, 並做檔案 time-dependence 的檢查:

Makefile 的主要功能主要是依檔案間的關係, 做檔案間 time-dependence 的檢查。例如在編譯 C 的程式 pf.c 時, 會產生 pf.c 的 object 檔 pf.o 以供鏈結, 則可在 Makefile 中加入下面幾行:

pf.o : pf.c

cc -c pf.c

其中在符號 : 之前的 pf.o 稱為 target , 可針對 target 執行如下的指令:

make pf.o

執行此命令時會檢查檔案 pf.o 的最近被更新( update )時間是否比檔案 pf.c 的最近被更新時間晚, 若檔案 pf.c 最近被更新的時間較晚, 表示 pf.o 的內容並非被最新版的 pf.c 所生成, 則會執行下面的命令列( command line ):

cc -c pf.c

否則將不再重新編譯 pf.c 檔, 直接以現存的 pf.o 檔供鏈結。

(2) 巨集的使用:

巨集的形成是針對某個欲完成目的, 把過程中各個步驟組織在一起, 然後用一個代號來代表這一些動作, Makefile 中可以形成巨集如下:

clean :

make rcsci

rm -f $(AllFILE)

執行指令 make clean 時, 相當於執行下面的兩行指令:

make rcsci

rm -f $(AllFILE)

B.2 How to write Makefile for VC ?

Makefile 的編寫, 首先需確定完成工作要有哪些操作( operation ), 以及這些操作與檔案或外部環境的關係等等。對於如何利用 Makefile 來支援 version control 的工作環境, 需要有哪些操作以及需要如何來配合工作環境, 可以分為下列兩個部份加以說明:

B.2.1 Makefile 中要有那些 target。

B.2.2 目錄的安排與 Makefile 的關係

B.2.1 Makefile 中要有那些 target :

Makefile 中利用 target 的安排, 來達成檔案間 time-dependence 的檢查與特定操作的設定。GNU 定的 coding standard 中有定出一般 Makefile 標準的 target, 在下面的例子中將討論在 version control(VC) 的環境下, 該有哪些 target 來支援 VC, 檔案的目錄結構與 Makefile 如下:

rlog $(VCFILES)>difffile

@less difffile

@rm difffile
all :

make rcsco

cc -o prog $(Objs) $(Lib)
test : $(Objs)

cc -o $@ $(Objs) $(Lib)
rcsco:

co $(VCFILES)
rcsci:

ci $(VCFILES)
pf.o: pf.c

cc -c pf.c
pf.c: RCS/pf.c,v

co -r$(revision_pf.c) pf.c
rcsclean:

rm $(VCFILES)
clean :

rm $(Lib) prog
test : $(Objs)

cc -o $@ $(Objs) $(Lib)

all 和 test:

VC 的工作環境主要是利用版本的儲存, 來達到檔案編寫與測試時的方便, target all 和 test 一個要得到該目錄下最後的工作結果, 一個則是以目前的工作檔案內容來編譯測試。在 target all 之下的命令列中, 命令 make rcsco 有點遞回呼叫的用法, 在 Makefile 中叫用自己的 Makefile 。

rcsco 、 rcsci 和 rcsclean:

上例中 rcsco 、 rcsci 跟 rcsclean 像是 macro 的用法, 主要是將目錄下所有做 VC 的檔案從 archive file 讀出( check in )、寫入( check out ) 或清除( clean )。

pf.o 、pf.c 和 lib5.a:

這三個 target 都在做檔案間 time-dependence 的檢查。

利用這些 target 可以得到下面的工作程序圖:

B.2.2 目錄的安排與 Makefile 的關係:

利用目錄的安排可以很快的知道在目錄下有那類的資料, 幫助資料的尋找。所以在軟體發展的過程中, 常把不同屬性的程式或資料放置在不同的目錄下。

對於放置在不同目錄下的程式或資料, 可以用 Make 來整合, 這主要是透過 Makefile 進出其它目錄並再叫用其它目錄下的 makefile 。如此可以在每個目錄下都用 Makefile 來組織目錄下的程式或資料, 再透過 Makefile 間的互相叫用而達成整合的目的。

在上面的例子中, 若程式 pf.c 需要有加、乘的某種功能, 則可產生子目錄 lib 來發展 cal.o 使其具有該功能, 以下討論在利用目錄的安排來分類資料時, 目錄下 Makefile 的使用。下面是目錄的結構與相對的 Makefile:

Objs = pf.o
VCFILES= pf.c $(Lib)
Lib= $(LPATH)cal.o
FILES=$(VCFILES)
REVISION = 1.1 1.2
revision_f.c=
revision_cal.o=
LPATH= lib/
view :

rlog $(VCFILES)>difffile

@less difffile

@rm difffile
all :

make rcsco

cc -o prog $(Objs) $(Lib)
test : $(Objs) $(Lib)

cc -o $@ $(Objs) $(Lib)
rcsco:

co $(VCFILES)
rcsci:

ci $(VCFILES)
$(Lib):

cd $(LPATH) --------> enter the sub-directory lib/

make all --------> use the Makefile under sub-directory lib/
pf.o: pf.c

cc -c pf.c
rcsclean:

rm $(VCFILES)
clean :

rm $(Objs) $(Lib) prog

-----------------------------------------------

--- this is the Makefile of sub-directory "lib"---
Objs = sum.o product.o
VCFILES= sum.c product.o
FILES=$(VCFILES)
view :
rlog $(VCFILES)>difffile
@less difffile
@rm difffile
all :
make rcsco
cc -c -o cal.o $(Objs)
test : $(Objs)
cc -o $@ $(Objs)
rcsco:
co $(VCFILES)
rcsci:
ci $(VCFILES)
sum.o: sum.c
cc -c sum.c
product.o : product.c
cc -c product.c
rcsclean:
rm $(VCFILES)
clean :
rm $(Objs) cal.o

C. The Emacs Enviorment For Version Control

Emacs 是有結合 Version Control( 以下以 VC 簡稱)的編輯器( Editer ), 能直接在編輯的環境下, 對編輯的檔案做 VC 的動作, 使得 VC 能與編輯環境結合, 簡化工作程序。在 emacs 中關於 VC 的編輯環境有下列幾個主要的特性:

分別說明如下:

在 Emacs 中欲編輯檔案需先將檔案放置在編輯暫存器( buffer )中, Emacs 可以一次產生數個編輯暫存器( buffer )來同時編輯不同的檔案。

在編輯程式或文件的過程中，常常需要不斷的做存取檔案的動作，以利測試、修改或暫存。在檔案修改時, 因為一個程式或文件常常結合數個檔案, 有些修改往往不只針對單一的檔案, 所以有時會需要同時對數個檔案做編輯的動作。Emacs 提供的編輯環境, 主要是利用 buffer 使得使用者一次可以編輯數個相關的檔案，以利整體的修改與整合。

(2)利用目錄( directory )為工作單位

在 Emacs 中強調應確實的以目錄來做檔案的分類與管理, 視其為編輯時的工作單位, 像是提供 VC 的 dired mode 以方便對一個目錄下的檔案做相關的編輯動作, 還有 Snapshots 的產生與取得, 都是針對目錄下所有做 VC 的檔案一次產生。所以同一目錄下做 VC 的檔案, 應是需相結合的相關檔案, 如此才有利 Snapshots 的產生以及編輯時的方便。

(3)藉由變數的設定來調整工作環境

Emacs 本身可以透過變數( variable )的設定來調整工作環境, 包括路徑的設定、執行命令時 message 的處理、做 VC 時附記( log )與檔頭( header )的產生等等, 利用這些變數的設定可以讓使用者獲致合適、便利的工作環境。

所有關於 VC 的變數都是以 "vc-" 開頭, 可以利用 Emacs 中的 help( C-h v)來看這些變數。其中有些變數一開始是看不到的, 需進入 VC mode 或是執行過 VC 的命令後才會被掛( hook )進來, 而變數被掛( hook )進來後才能改變其設定。這些變數有的是真假值的設定, 有些則是字串變數的設定, 用到的是 LISP 相關的語法。在 Emacs 中欲設定變數值可使用命令 M-x set-variable 。以下在第一小節將先介紹, 以建有 hot key 的幾個基本功能來實作 VC 的動作。第二小節是所有 emacs 中關於 VC 的功能的使用與列表。第三小節則討論 emacs 的編輯環境如何與外部環境結合。

C.1 The Version Control Mode for Emacs

Emacs 可選擇使用 RCS( revision control system )或 SCCS( source code control system )來做 VC, 其 default 的設定是使用 RCS 。Emacs 中關於 VC 的指令, 除了 C-x C-q ( check in or check out )之外都是以 C-x v 評/font>頭, 對於如何使用 emacs 中 VC 的功能, 將以下列幾個部份:

C.1.1 Getting start for version control in emacs。

C.1.2 Editing file with version control in emacs。

C.1.3 Creating Log message and ChangeLog file。

C.1.4 Comparing revision。

C.1.5 Creating snapshots。

C.1.6 Creating Idkeyword。

分別說明如下:

C.1.1 Getting start for version control in emacs

在 Emacs 中是透過不同的模式( mode )提供使用者不同需要的工作環境。如欲對 Emacs 中編輯的檔案做 VC , 需先進入 VC mode, 然後 Emacs 才會將相關的功能( function ) 引進使用。對於如何進入 VC mode , 關鍵在於編輯的檔案有無 VC 的 archive file 存在, 以下列兩種情形說明:

(1) 檔案尚未產生 archive file :

尚未產生 archive file 的檔案 (可能是從外部讀進來的檔案或是在 Emacs 中新編的檔案) 欲進入 VC mode 的方式, 便是產生該檔案存放各版本的 archive file , 此動作稱為 Register in 可使用命令:

C-x v i

產生( creat )該檔案的 archive file。如果要用 RCS 做 VC , 可在產生 archive file 前先於工作目錄之下產生 RCS/ 的子目錄, 則 emacs 會自動使用 RCS 並將 archive file 存放在該子目錄之下, 且之後的存取動作 emacs 都會自動到在該子目錄下存取。存取時若在工作目錄下沒有設立 SCCS 或 RCS 的子目錄, 則 emacs 的 default 設定會使用 RCS 來做 VC。

一般在 Shell 中使用 RCS 做寫入 archive file 的動作後, 都會自動移除( remove )原先的工作檔案( working file ),但在 Emacs 中檔案存入 archive file 之後, 會保留住原先的工作檔案( working file ), 如欲令 Emacs 在檔案寫入 archive file ( check in )之後, 自動移除( remove )原先的工作檔案( working file ), 則需更改變數 vc-keep-worfiles 的值為 nil ( 原設定為 t ), 設定時使用命令:

M-x set-variable

然後會在 emacs 下方出現下面訊息:

Set variable :

要求指定欲更改的變數。此時便可鍵入變數 vc-keep-worfiles , 然後會再出現下列訊息:

Set vc-initial-comment to value :

則鍵入 nil, 如此可令 Emacs 在寫入archive file ( check in )之後, 自動移除( remove )原先的工作檔案( working file )。

(2) 編輯檔案已存在 archive file :

Emacs 在讀入檔案前若在該檔案所處目錄下或該目錄下的 RCS/ 子目錄中, 存在該檔案做 VC 的 archive file , 則在檔案讀入 Emacs 後該檔會自動進入 VC mode 和唯讀狀態( read only ), 在 emacs 下方橫條形的狀態顯示區, 會出現 %% 如下:

其中 %% 符號表示唯讀, (RCS : 1.2) 顯示用 RCS 做 VC 而版本編號( revision number )為 1.2。

C.1.2 Editing file with version control in emacs

VC 的編輯環境, 主要是幫助對檔案中各個不同版本的編輯。編輯時 Emacs 會將正在編輯的版本 lock 起來, lock 的動作在防止同時編輯同一版本的發生, 當其它使用者欲對被 lock 住的版本編輯時, 會產生警告訊息要求其它使用者要放棄編輯動作或奪取 lock權。除此之外, 也可以防止同一個使用者因疏乎而重覆編輯同一版本。以下將分成三個部份, 討論如何在 VC 的環境下基本編輯檔案版本

(1) 檔案的讀取

(2) 編輯時檔案狀態的改變

(3) 存入或取消編輯後的版本

(1) 檔案的讀取:

Emacs 在讀取做 VC 的檔案時, 與讀取一般檔案無異, 可使用命令 C-x C-f 讀出檔案到一個編輯暫存器內( buffer ), 讀取時會先檢查該檔是否存在在目錄下, 若有則直接讀進該檔, 否則 emacs 會從其 archive file 中取出該檔最後存入一個版本。

(2) 編輯時檔案狀態的改變:

在做 VC 下的檔案讀出( check out )後, 有唯讀( read only )及可寫入( writable )兩種狀態, emacs 中利用命令:

C-x C-q

來切換唯讀( read only )和可寫入( writable )狀態。一般從 archive file 讀出的檔案版本, 會先進入唯讀( read only )狀態, 若使用者欲編寫該檔則需切換至可寫入( writable )狀態並 lock 該檔。等到編輯完畢切換成唯讀( read only )狀態, Emacs 便會將該版本寫入( check in ) archive file。

(3) 存入或取消編輯後的版本:

如上所述 emacs 取出檔案剛開始是在唯讀狀態( read only ), 使用 C-x C-q 可以進入可寫入( writable )狀態來修改檔案, 修改結束後則再使用 C-x C-q 將新的版本寫入( check in ) archive file 中, 並改回唯讀( read only )狀態。在使用 C-x C-q 將新的版本寫入( check in ) archive file 時, emacs 會出現以下的畫面要求輸入該版本的 log , 需使用 C-c C-c 來結束附記( log )的撰寫。

在第一次產生檔案的 archive file 並將初始版本 1.1 存入時, 並不會要求輸入附記( log ), Emacs 會自動以 Initial revision 做為初始版本的附記( log )敘述。如欲在存入初始版本時產生附記( log ), 可以更改變數 vc-initial-comment 為非 nil( default ) 的值。設定時使用命令:

M-x set-variable

然後會在 emacs 下方出現下面訊息:

Set variable :

要求指定欲更改的變數。此時便可鍵入變數 vc-initial-comment , 然後會再出現下列訊息:

Set vc-initial-comment to value :

則鍵入非 nil 的值。如此則在第一次 check-in 時就會要求輸入初始版本的附記( log )。

如果修改了某個版本內容, 在還未寫入 archive file 之前決定要放棄此次修改, 回復此版本先前的內容, 則使用:

C-x v u

如果要取消某個已存入 archive file 的版本, 則使用:

C-x v c

可以將目前在 buffer 的版本從 archive file 中去除, 而以下一個最近的版本取代之。

C.1.3 Creating Log message and ChangeLog file

在編輯程式或文件時, emacs 可針對所在目錄產生 ChangeLog 檔, 以存下各個檔案的變更記錄, 也可針對檔案取出各個版本的附記( log )。以下將對各版本附記( log )的取得與 ChangeLog 檔的產生, 分別討論如下:

(1) 檔案各個版本之附記 log 的取得:

在每個版本生成之時 emacs 便會要求使用者輸入該版本的附記( log )。附記( log )可提供使用者記錄每個版本生成的原因、被修改的部份、當時編輯該版本的想法、以及使用的技巧等等, 幫助日後可以較快獲知該版本的內容與其它版本的比較。RCS 的指令 rlog 可取得某個檔案各版本的附記( log )一覽表, 此附記( log )一覽表的取得將有助於對各個版本內容與生成目地的了解, 在 emcs 中可使用命令:

C-x v l

獲得對於該檔案各版本的附記( log )一覽表, 如下所示:

ChaangeLog 檔的產生主要記載所在目錄下, 所有的檔案變更記錄。Emacs 可以針對各別目錄下所有做 VC 的檔案, 產生 ChangeLog 檔以存下所有做 VC 的檔案之更改記錄。此更改的記錄以時間編排, 使用者可以藉此看工作流程與修改的記錄, 知道那些檔案版本在那段時間內是被修改過的, 在 emacs 中使用命令:

C-x v a

可以得到在該目錄下所有做 VC 檔案的 ChangeLog 檔, 該檔是依照時間順序編排的, 根據時間記載在該目錄下所有做 VC檔案的變更記錄, 並以各檔案版本的附記( log )做為描述, 一個由 emacs 為做 VC 檔案所產生的 Changelog 檔將如下示:

emacs 的 ChangeLog 檔並非只專為做 VC 的檔案產生, 在 emacs 中可以使用命令:

M-x add-change-log-entry

將一般檔案的變更記錄加入 ChangeLog 檔中。

C.1.4 Comparing revision

在編輯的過程中若遇到困難, 使用者常希望知道自己在從一個版本發展成另一個版本的過程中, 加了那些內容或做了那些修改, 而檔案版本的比較就是將檔案版本的不同處印出, 這些不同處往往是除錯( debug )時重要的訊息。在 Emacs 中對於檔案版本的比較主要提供比較目前在 buffer 中的工作檔案與上一個版本間的差別, 使用命令:

C-x v =

會在 emacs 的視窗上出現如下(vc-diff)的顯示區, 顯示比較的結果:

如果欲比較的並非是目前在 buffer 中的工作檔案與上一個版本的內容, 而是要指定比較某個檔案任意兩個版本間的差異, 則需使用命令:

M-x vc-version-diff

然後依序照要求輸入檔名及欲比較版本名。

C.1.5 Creating snapshots

一個程式或文件常是結合數個檔案發展, 每個檔案的發展過程中因為修改的次數不同, 造成發展的版本亦難以控制, 此時若欲結合各檔案適當的版本就必需標示好那些版本是相關的, 而 snapshots 的產生就是在做檔案間相關版本的標示動作。

C-x v s

則會出現以下訊息:

New snapshot name :

要求輸入欲給定的符號名( symbol ), emacs 會以該輸入的符號名( symbol )做為目錄下各檔最後存入版本的標記符號( mark-symbol )。此標記符號( mark-symbol ) 產生的方式是針對目錄下所有檔案的最後一個版本, 同時產生相同的標記符號( mark-symbol ), 所以 emacs 是以目錄作為工作單位, 用目錄來區分檔案之間的關係, 因此在產生 Snapshots 的同時, 目錄下不可有被 lock 的檔案版本存在, 如此可以確保在產生 Snapshots 之時, 所有檔案存入的最後一個版本就是要產生 Snapshots 的版本。

在產生 snapshot 之後, 可以使用下列命令取出目錄下所有做 VC 的檔案中, 相對於某個 snapshot 的版本:

C-x v r

在 emacs 視窗的下方會出現:

Snaposhot name to retrieve:

可以使用標記符號 ( mark-symbol ) 或是版本序號 ( verision nomber ) 來指定欲取出的版本。一般來說使用版本序號( verision nomber )是比較沒有意義的, 因為上述的動作是對所在目錄下, 所有作 VC 的檔案都取出指定的版本, 除非使用者利用相同的版本序號 ( verision nomber )來記錄各檔案相關的版本, 否則應使用產生 Snaposhot 的標記符號 ( mark-symbol )來指定欲取出的版本, 如此可以同時把目錄下各檔案相關的版本取出。

C.1.6 Creating Idkeyword

識別關鍵字串( Idkeyword )的利用在方便取得檔案版本的某些訊息, 在 emacs 中若欲在檔案中使用識別關鍵字串( Idkeyword ), 可以使用指令:

C-x v h

則 emacs 會在 cusor 所在的地方, 產生預先設定的識別關鍵字串( Idkeyword )。這個預先設定的識別關鍵字串( Idkeyword )其 default 值是 %ID%( SCCS 為 %W%) 字串, 這個 default 的設定可藉由變數 vc-header-alist 更改。

對於 vc-header-alist 的更改, 可以在進入 emacs 後才改, 也可以在 .emacs 中更改。以下將說明這兩種更改的方法:

(1) 進入 emacs 後才改:

在 emacs 中欲更改 vc-header-alist 變數, 首先必需進入 VC mode, 並且需先叫識別關鍵字串( Idkeyword )( 即需先使用命令 C-x v h ), 否則將無法在 emacs 中找到該變數。之後再使用命令:

M-x set-variable

然後會在 emacs 下方出現下面訊息:

Set variable :

要求指定欲更改的變數。此時便可鍵入變數 vc-header-alist , 然後會再出現下列訊息:

Set vc-header-alist to value :

如果欲將 vc-header-alist 改成 $Date$ ( default 是 $Id$), 則需鍵入:

Set vc-header-alist to value : '( RCS $Date$ )

即可將變數 vc-header-alist 改成 $Date$。上述的設定模式類似 lisp 的語法, 針對 RCS 而設立。變數 vc-header-alist 的完整設定為 '(( SCCS \%W\% )(RCS \$Id\$ )(CVS \$Id\$ )

(2) 在 .emacs 檔中設立:

在 .emacs 檔中可以預先設立某些環境, 使得叫用 emacs 使用時, 會先依 .emacs 檔中設定的環境來執行。而 .emacs 檔是用 lisp 語言寫的, 如果要設立 vc-header-alist 為$Date$ 則需在 .emacs 檔中加入下面一行:

(setq '( RCS \$Date\$ ))

則在一開始進入 emacs 時, 便會將變數 vc-header-alist 設成 $Date$。

C.2 The Function of Emacs

在 emacs 中的 VC 除了上述的基本動作外, 還提供了很多的功能( function )來支援編輯, 這些功能( function )可透過 M-x ( ESC-x) 來叫用。對於有那些功能( function )可以使用, 跟 emacs 是否進入 VC mode 有關, emacs 是在進入 VC mode 之後才將大部份的功能( function )引進, 在未進 VC mode 之前, 很多功能無法叫用。以下將對就進入 VC mode 前後, 討論可叫用的功能( function )並列表:

(1) 在未進入 VC mode 之前 :

在未進入 VC 之前, 只有下列幾個功能( function )是可使用的, 這些功能大多是針對檔案本身, 而非對檔案版本。列表如下:

function	hot key	說明
vc-register	C-x v i	產生 archive file 並進入 VC mode
vc-rename-file		更改檔案名稱
vc-retrieve-snapshot	C-x v r	指定 snapshot 取出檔案版本
vc-toggle-read-only	C-x C-q	切換檔案讀寫狀態 (Check-in 與 Check-out 的動作)
vc-update-change-log	C-x v a	將檔案變更記錄寫入 Changelog

(2) 在進入 VC mode 之後 :

在進入 VC mode 之後, Emacs 會把大部份主要功能( function )引進, 這些功能大致上是第一小節介紹的基本功能( function ), 也是進入 VC mode 之後主要的動作, 這些進入 VC mode 才有的的功能( function )如下表列:

function	hot key	說明
vc-cancel-version	C-x v c	取消該版本
vc-create-snapshot	C-x v s	對目錄下所有做 vc 檔案的最後一個版本產生 snapshot
vc-diff	C-x v =	比較目前工作檔案與最後存入版本之差異
vc-directory	C-x v d	出示目錄下被 lock 的檔案並進入 dired mode
vc-insert-headers	C-x v h	插入標頭檔
vc-next-action	C-x v v	進行下一個 vc 的動作
vc-print-log	C-x v l	取出該檔案的 log 檔
vc-revert-buff	C-x v u	取消更動版本內容
vc-version-other-window		以新的檔案名編輯檔案版本

然而有些功能仍是在 emacs 中執行過 version control 的指令之後, 才會被引進 emacs 中, 這些功能多是設計輔助對檔案版本的搜尋、比較與編輯等, 表列如下

function	hot key	說明
vc-comment-search-forward		搜尋以後各版本 log 檔的內容
vc-comment-search-reverse		搜尋以前各版本 log 檔的內容
vc-comment-to-change-log		加變耕記錄於 ChangeLog 檔
vc-directory-18		檢查所屬目錄下被 lock 的檔案
vc-ediff		利用 diff 檔支援編輯檔案
vc-finish-logentry	C-c C-c	結束 log 檔的編輯
vc-next-comment		循環向後讀出版本的描速
vc-previous-comment		循環向前讀出版本的描速( log )
vc-revert-buffer1		將 auto-save 的檔案內容存入目前 buffer
vc-steal-lock		奪取檔案寫入權利
vc-version-diff		指定檔案與檔案內之版本做比較

C.3 The Editing Environment for Version Control

Emacs 除了提供各種 VC 與編輯的功能, 在 Emacs 中還可以叫用 shell 中的指令( M-shift ! )並傳回結果, 這使得在編輯或修改程式和文件的同時, 也可以在 emacs 中直接測試結果。這些測試的動作可以透過 Makefile 的編寫來組織相關的工作環境與檔案版本。所以在 emacs 中利用 buffer 的切換, 可以同時對相關檔案及 Makefile 作編輯暨整合測試的動作, 使得所有檔案或文件的發展的過程, 可以完全在 emacs 中完成。

keyword	相關資訊
$Header$	全路徑名(full pathname)+日期(date)+作者(author)+描速(state)+正 lock 該檔案者(locker)
$Id$	RCS 檔名+日期(date)+作者(author)+描速(state)+目前 lock 住該檔案者(locker)
$Date$	日期
$Log$	關於該版本的 log 的訊息
$Author$	作者
$locker$	目前 lock 住該檔案者
$revision$	revision number
$source$	全路徑名(full pathname)