Development/gerrit/ko

From The Document Foundation Wiki
Jump to: navigation, search

이 페이지는 코드 검토 도구 gerrit.libreoffice.org의 설명 항목 페이지이며 리브레오피스에서 어떻게 사용하는지 설명합니다.

게릿 알아서 설정하기


Setting yourself up for gerrit

Before you start: Troubleshooting help

The instructions below should be easy and quick to follow. However, if you get stuck somewhere, here is how you get help:

Register in Gerrit for first time

Gerrit uses The Document Foundation's Single-On service for authentication. Create an account there if you don't have one already (several other sites, such as this wiki, use it too). Then simply launch gerrit and click on the “Sign in” link at the top right of the page. You'll be redirected to our central authentication portal, and then back to Gerrit once authenticated.

Setting yourself up for gerrit - the easy way

If you have a checkout of libreoffice/core already, you can just run ./logerrit setup, which will try to automatically setup keys and configure ssh for you, and if it can't it will guide you through these steps: if necessary, just follow the steps.

The program will tell you to go to https://gerrit.libreoffice.org, click Register and remember your username. The program will also generate a public SSH key, print it and save it to /home/[username]/.ssh/id_rsa.pub. This key will begin with 'ssh-rsa'. You must enter this key during the registration process on the website (or add it later in SSH Public Keys under Settings in order for gerrit to work.

If ./logerrit test fails and ssh -vvv logerrit informs you about ~/.ssh/config having bad permissions, run chmod 600 config in ~/.ssh.

Detailed and nitty-gritty setup topics

Setting yourself up for gerrit - the manual way

  1. Create an account at https://gerrit.libreoffice.org
  2. You must set your username in your gerrit account settings). Users are associated by username and SSH key. This username is referred to as YOUR_USERNAME_HERE below.
  3. Generate an SSH keypair for gerrit and upload the public key in the preferences (of course you can also reuse an existing key)
  4. Add the following to your ${HOME}/.ssh/config (both sections are identical except for the "Host" line):
     Host logerrit gerrit.libreoffice.org
           IdentityFile /path/to/your/private-key
           User YOUR_USERNAME_HERE (cf. above)
           Port 29418
           HostName gerrit.libreoffice.org
    

    Note that /path/to/your/private-key must include the file name as well. For example: ~/.ssh/id_rsa

  5. Setup your git repo so that it pushes to gerrit using the SSH key:
    git config remote.origin.pushurl ssh://logerrit/core
    
  6. and you are ready to go!

Now push !

See: How to submit patches

다른 방법은 직접 접근해서 이리저리 만져보는 방법이며, 세부 방법은 Development/gerrit/setupen에 있습니다.

게릿에 패치 보내기

기여자 명단에 자신을 추가하기

리브레오피스 프로젝트에 처음 패치를 기여한다면, 개발자 및 기여자 명단en에 우선 자신을 추가하고(방법은 페이지에 다 나와있습니다) 기여 라이선스 상태를 적어넣으십시오.

검토할 패치 제출하기

바꾼 내용을 만들고 검토할 내용을 게릿으로 push 하십시오 (공식 게릿 문서는 여기en에 있습니다).

git checkout -b <a_local_branch_name_of_your_choice>
# Do your code changes, make sure it will build
git add file [file ...] # all the new files _and_ changed files
git commit
./logerrit submit master

참고: `logerrit` 명령을 동작하게끔 게릿 설정을 했는지 먼저 확인하십시오. 방법은 여기en에 있습니다.

참고: git add + git commit 단계는 'git gui' 명령으로 처리할 수 있으며, 제출 제목줄은 65문자를 넘으면 안되며, 제출 메시지는 한 줄 당 문자 갯수가 70개를 넘으면 안됨을 기억하세요.

참고: 마스터 브랜치로 제출하고나면, 마스터 브랜치 최근 버전으로 (re)base하여, 젠킨스에서 가능한한 ccache를 통해 CI 를 빌드하는 이득을 취할 수 있습니다.

참고: 리브레오피스는 정해둔 규칙에 따르기 위해 패치를 점검할 때 clang-format을 따릅니다. clang-format의 특정 버전을 활용합니다(이렇게 하여 마이너 출시버전 간 그리고 다른 버전간의 비일관성 문제를 해결합니다). 시스템에 clang-format 을 미리 설치해두지 않으면, git commit 을 실행할 때 경고가 뜨며, 필요한 바이너리를 어떻게 설치하는지에 대한 방법도 나타납니다. 어떤 버전을 미리 설치해두었다면, 경고는 뜨지 않거나(다만 일관적이지 못한 결과물로 빌드봇에서 문제가 나타나면 다른 방식으로 포매팅을 바꾸라고 알려줍니다), 미리 설치한 버전이 동작하지 않을 수도 있습니다(명령행 옵션에 문제가 있다는 식으로 메시지가 뜨거나...). 리브레오피스에서 사용하는 버전은 다음 주소에서 찾을 수 있습니다: https://dev-www.libreoffice.org/bin/.

마지막 줄은 특별한 내용이며 master 브랜치의 검토 큐에 대한 리뷰 큐로 이름이 붙은 로컬 브랜치로 모든 패치를 push 합니다(릴리즈 브랜치 또는 다른 브랜치 중 한 곳으로 패치를 제출하려 한다면, 바로 수정하세요). 보통의 기여자분들은 전자메일 주소를 게릿 계정과 맞추셔야합니다. 그렇지 않으면 push할 수 없습니다.

push가 끝나면, git에서 검토 대기중인 주소를 알려줍니다. URL은 https://gerrit.libreoffice.org/#/c/229/ 비스무레하게 나타냅니다.

패치를 검토하는 중에는 패치의 새 버전을 쉽게 올릴 수 있도록 로컬 브랜치를 그대로 두는게 좋습니다. 그 동안에

git checkout master

명령으로 마스터 브랜치로 돌아올 수 있... 고 위 과정을 통해 다른 패치 작업을 시작할 수 있습니다(로컬 브랜치를 만들고, 코드 작성후, 제출, 그리고 게릿으로 push).

패치 제출 더 보기

위 내용 말고도, Development/GitReviewen에서 설명하는대로 "git review" 명령을 사용해볼 수 있습니다.


Development/gerrit/SubmitPatch/ko에서 다음 내용을 찾아볼 수 있습니다.

  • 새 버전 제출
  • 초안 패치 제출

Development/Submodulesen에서 하위 모듈에 패치하는 방법에 대해 다음 내용을 찾아볼 수 있습니다.

  • 사전
  • helpcontent2 (도움말 파일)
  • 번역

게릿 참고자료 더 보기

그 외 읽을거리