메뉴얼 보는 법 : git help와 --help
- git help를 입력하면 깃의 사용법과 기본적인 명령어 목록이 표시됩니다.
- Pro Git의 레퍼런스 파트에 가면 세부사항을 편하게 볼 수 있습니다.
- 또한 터미널에서 대부분의 명령어에 --help 옵션을 주면 메뉴얼 페이지로 이동합니다. 대부분 메뉴얼 페이지의 정보는 바로 위의 Pro Git에 게재된 것과 같습니다.
/* ex) */
git add --help
git commit --help메뉴얼 읽는 법: [], <>, |, 축약어, 대문자, options,
아래 목록은 대부분의 메뉴얼에서 공통적으로 등장하는 파트입니다.
- name
- synopsis
- description
- options
- examples
다른 것은 읽어보면 이해할 수 있는데 synopsis부분은 조금 보기 불편할 겁니다.
Pro git 레퍼런스의 checkout SYNOPSIS 파트를 예시로 읽는 법을 설명해보겠습니다.
계속 등장하는 같은 명령어
시놉시스에서 git chckout이 매 행마다 반복되고 있는 이유는 매 행이 다른 명령이기 때문입니다. 각 행은 다른 옵션과 기본값을 가지며 이에 따라 다르게 동작합니다.
예를 들어 1행의 명령은 HEAD를 이동시키지만 5행은 삭제한 파일을 복구하는데 쓸 수 있습니다.
여담이지만 checkout은 계속 기능이 확장된 명령이기 때문에, git cli에 익숙하지 않다면 2.23이후로 좀 더 작은 의미로 분화한 switch, restore등의 명령어를 사용하는 것이 좀 더 명확하고 이해하기 쉽습니다.
[]의 의미
대괄호 []는 내부 값이 옵셔널하다는 의미입니다. 명령을 내릴 때 옵션을 주어 동작을 변화시킬 수 있습니다. 굳이 제공하지 않는다면 디폴트에 정의된 방식대로 행동합니다.
<>의 의미
<>는 placeholder입니다. <>안의 조건에 들어맞는 여러 대상을 지정할 수 있습니다. 5행을 예로 들어봅시다.
git checkout [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>…위의 [<tree-ish>]에는 commit, tag, HEAD등 tree-ish의 조건을 만족하는 온갖 대상이 들어갈 수 있습니다.
tag, HEAD는 커밋을 가리키는 포인터입니다.
| (파이프라인)의 의미
파이프라인은 해당 옵션 내에서 선택할 수 있는 여러 선택지를 의미합니다. 예를 들어 --ours와 --theirs는 동시에 선택할 수 없는 명령입니다. 두 옵션을 동시에 입력한다면 git은 어느 한 쪽을 적용하거나 오류를 반환할수도 있습니다.
--와 -,
checkout에는 없지만 간혹 [--patch | -p]와 같은 형식으로 표시된 옵션을 만나기도 합니다. 이 때 -p는 --patch의 축약형입니다.
/* ex) 대부분의 옵션은 예상할 수 있는 방식으로 축약됩니다. */
git push [-f | --force]
/*
* 그러나 예상하기 어려운 형태로 축약되는 옵션도 있습니다.
* 익숙해질 때까지는 확인하고 사용하는 것이 좋습니다.
*/
git push [-u | --set-upstream]대문자와 소문자
축약된 옵션 중 -c와 -C처럼 대소문자가 구별된 경우가 있습니다.
이 경우 대부분 대문자에는 --force의 의미가 추가됩니다만, 역시 확인하고 사용하는 편이 좋습니다.
/*
* -d 의 경우 아직 브랜치가 merge되지 않았다면 삭제를 거부
* -D의 경우 그냥 삭제
*/
git branch (-d | -D) feat/login 혹은[<options>]의 의미
switch처럼 [<options>]가 붙어있다면 메뉴얼 하단의 options파트에 별도로 서술했다는 의미입니다.
참고
