下一個: , 上一個: , 上層: 變更日誌   [目錄][索引]


6.8.3 簡單變更

某些簡單種類的變更在變更日誌中不需要太多細節。

如果變更的描述夠簡短,它可以作為自己的標題行。

2019-08-29  Eli Zaretskii  <eliz@gnu.org>

	* lisp/simple.el (kill-do-not-save-duplicates): Doc fix.  (Bug#36827)

當你以簡單的方式變更函式的呼叫順序,並且你變更了該函式的所有呼叫者以使用新的呼叫順序時,不需要為你變更的所有呼叫者建立個別的條目。 只要在被呼叫的函式的條目中寫「所有呼叫者已變更」——像這樣

* keyboard.c (Fcommand_execute): New arg SPECIAL.
All callers changed.

當你僅變更註解或文件字串時,只需為檔案寫一個條目就足夠了,無需提及函式。 變更日誌中只要寫「文件修正」就足夠了。

當你在許多檔案中進行變更,這些變更機械性地源自一個底層變更時,只需描述這個底層變更就足夠了。 這是一個影響儲存庫中所有檔案的變更範例

2019-01-07  Paul Eggert  <eggert@cs.ucla.edu>

	Update copyright year to 2019

	Run 'TZ=UTC0 admin/update-copyright $(git ls-files)'.

測試套件檔案是軟體的一部分,因此我們建議為了變更日誌的目的將它們視為程式碼。

對於非軟體檔案(手冊、說明檔案、媒體檔案等),技術上沒有必要建立變更日誌條目。 這是因為它們不易受到難以理解的錯誤影響。 要更正錯誤,你不需要知道錯誤段落的歷史; 將檔案內容與實際情況進行比較就足夠了。

然而,當專案從貢獻者那裡獲得著作權轉讓時,你應該為非軟體檔案保留變更日誌,以便使作者身份記錄更準確。 因此,我們建議為你專案手冊的 Texinfo 來源保留變更日誌。


下一個: , 上一個: , 上層: 變更日誌   [目錄][索引]