コマンド・ドキュメントで「[]」または「<>」とはどういう意味ですか？

Question

コマンド文書によっては、「[]」または「<>」がよくあります。例：

git diff [options] [<commit>] [--] [<path>…​] 
git diff [options] --cached [<commit>] [--] [<path>…​] 
git diff [options] <commit> <commit> [--] [<path>…​] 

これはどういう意味ですか？

Answer 1

この表記法は、gitにのみ使用されるのではなく、一般的なコマンドの文書化に使用されます。

大カッコ内の引数はオプションです。あなたは与えられた位置で自由に使用することができますが、オプションを提示しないこともできます。あなたの例では、任意の引数のない最初の行に対応するgit diffと書くことができます。

山括弧内の項目はそのまま使用するのではなく、意味のある内容に置き換える必要があります。あなたの例では、<commit>は有効なコミット識別子に置き換えてください。 git diff d6cd1e2bd19e03a81132a23b2025920577f84e37。