git官方文档阅读指南

1. 进入git文档;
2. 点击 Reference - Getting and Creating Projects - init;
3. 看到一页git init 的使用说明。

如果你英语足够好，说明里的绝大部分内容都可以看懂。不过仍有几点值得我们注意。

---

1  关于概要

每条命令文档下都有一块该命令概要(synopsis)的区域。

图1 git init 下的 synopsis

1.1 每一行都是一种完整的用法：

git init 的概要给出了git init 的三种用法，每种用法之间的参数不能相互混淆。

1. git init [-q | --quiet] [--bare] [--template=<template_directory>]
2. git init [--separate-git-dir <git dir>]
3. git init [--shared[=<permission>]][directory]

1.2 参数声明

git 在 github文档 中给出了概要中几种参数声明的定义。如果你想看详细定义可以点击这里查看。给出几种比较常见的参数定义：

1. 占位符(placeholder)被用小写字母拼写并包围在尖括号。用户需要用自己的字符替换占位符：<file> <new-branch-name>
2. 可选参数(optional part)被包围在方括号中：[<extra>]
3. 多个可选参数(multiple alternatives)在方括号中使用竖线分割：[-q | --quiet] [--utf8 | --no-utf8]
4. 表明可接受多参数时使用连续的三个点紧跟在参数后：<file>...