GIT 예제

PX4에 코드 기여

PX4 기능 추가 절차는 다음과 같습니다. 다음 예제를 따라 PX4에 기여 결과를 공유할 수 있습니다.

• Sign up for github if you haven't already

• Fork the PX4-Autopilot repo (see here)

• 포크된 저장소를 로컬 컴퓨터에 복제합니다.

  cd ~/wherever/
  git clone https://github.com/<your git name>/PX4-Autopilot.git

• 복제한 디렉토리로 이동하여, 하위 모듈을 초기화 및 업데이트하고, 원 업스트림 PX4-Autopilot URL을 추가합니다.

  cd PX4-Autopilot
  git submodule update --init --recursive
  git remote add upstream https://github.com/PX4/PX4-Autopilot.git

• You should have now two remote repositories: One repository is called upstream that points to PX4/PX4-Autopilot, and one repository origin that points to your forked copy of the PX4 repository.

• 이것은 다음 명령어로 확인할 수 있습니다.

  git remote -v

• Make the changes that you want to add to the current main.

• 기능을 나타내는 의미 있는 이름으로 새 분기를 생성합니다.

  git checkout -b <your feature branch name>

  you can use the command git branch to make sure you're on the right branch.

• 해당 파일을 추가하여 커밋의 변경 사항을 추가합니다.

  git add <file name>

  If you prefer having a GUI to add your files see Gitk or git add -p.

• 변경 사항을 설명하는 메시지와 함께 추가된 파일을 커밋합니다.

  git commit -m "<your commit message>"

  For a good commit message, please refer to the Source Code Management section.

• Some time might have passed and the upstream main has changed. PX4 prefers a linear commit history and uses git rebase. To include the newest changes from upstream in your local branch, switch to your main branch

  git checkout main

  Then pull the newest commits from upstream main

  git pull upstream main

  Now your local main is up to date. Switch back to your feature branch and rebase on your updated main

  git checkout <your feature branch name>
  git rebase main

• 이제 로컬 커밋을 분기된 저장소로 푸시할 수 있습니다.

  git push origin <your feature branch name>

• You can verify that the push was successful by going to your forked repository in your browser: https://github.com/<your git name>/PX4-Autopilot.git

  새 분기가 분기된 저장소로 푸시되었다는 메시지가 표시되어야 합니다.

• 이제 풀 리퀘스트(PR)를 생성합니다. On the right hand side of the "new branch message" (see one step before), you should see a green button saying "Compare & Create Pull Request". 그런 다음 변경 사항을 나열하여야 하며, 의미 있는 제목(하나의 커밋 PR의 경우 일반적으로 커밋 메시지)과 메시지(어떤 이유로 작업을 하였는 지 설명)를 추가할 수 있습니다. Check other pull requests for comparison)

• 완료하였습니다. PX4 담당자가 기여 내용을 검토후, 병합 여부를 결정합니다. 때때로 변경 사항에 대한 질문을 확인하십시오.

Changing Source Trees

We recommend using PX4 make commands to switch between source code branches. This saves you having to remember the commands to update submodules and clean up build artifacts (build files that are not removed will result in "untracked files" errors after the switch).

To switch between branches:

1. Clean up the current branch, de-initializing submodule and removing all build artifacts:

   make clean
   make distclean

2. Switch to a new branch or tag (here we first fetch the fictional branch "PR_test_branch" from the upstream remote):

   git fetch upstream PR_test_branch
   git checkout PR_test_branch

3. Get the submodules for the new branch:

   make submodulesclean

특정 릴리스 가져오기

Specific PX4 point releases are made as tags of the release branches, and are named using the format v<release>. These are listed on Github here (or you can query all tags using git tag -l).

To get the source code for a specific older release (tag):

1. Clone the PX4-Autopilot repo and navigate into PX4-Autopilot directory:

   git clone https://github.com/PX4/PX4-Autopilot.git
   cd PX4-Autopilot

   :::note

   You can reuse an existing repo rather than cloning a new one. In this case clean the build environment (see changing source trees):

   make clean
   make distclean

:::

2. Checkout code for particular tag (e.g. for tag v1.13.0-beta2)

   git checkout v1.13.0-beta2

3. Update submodules:

   make submodulesclean

Get a Release Branch

Releases branches are branched of main, and used to backport necessary changes from main into a release. The branches are named using the format release/<release_number> (e.g. release/v1.13). The are listed here.

To get a release branch:

• Clone the PX4-Autopilot repo and navigate into PX4-Autopilot directory:

  git clone https://github.com/PX4/PX4-Autopilot.git
  cd PX4-Autopilot

  :::note

  You can reuse an existing repo rather than cloning a new one. In this case clean the build environment (see changing source trees):

  make clean
  make distclean

:::

• Fetch the desired release branch. For example, assuming you want the source for PX4 v1.14:

  git fetch origin release/1.14

• Checkout the code for the branch

  git checkout release/1.14

• Update submodules:

  make submodulesclean

하위 모듈 업데이트

하위 모듈을 업데이트하는 방법에는 여러 가지가 있습니다. Either you clone the repository or you go in the submodule directory and follow the same procedure as in Contributing code to PX4.

하위 모듈 업데이트에 대한 풀 요청 실행

This is required after you have done a PR for a submodule X repository and the bug-fix / feature-add is in the current main of submodule X. Since the Firmware still points to a commit before your update, a submodule pull request is required such that the submodule used by the Firmware points to the newest commit.

cd Firmware

• 하위 모듈 업데이트에 대한 수정 사항/기능을 설명하는 새로운 분기를 만듭니다.

  git checkout -b pr-some-fix

• 하위 모듈 하위 디렉토리로 이동합니다.

  cd <path to submodule>

• PX4 하위 모듈이 반드시 최신 커밋을 가리킬 필요는 없습니다. Therefore, first checkout main and pull the newest upstream code.

  git checkout main
  git pull upstream main

• Firmware 디렉토리로 돌아가서, 평소처럼 변경 사항을 추가, 커밋 및 푸시합니다.

  cd -
  git add <path to submodule>
  git commit -m "Update submodule to include ..."
  git push upstream pr-some-fix

풀 요청 체크아웃

병합할 분기가 해당 사람의 포크에만 존재하더라도, 누군가의 풀 요청(변경 사항이 아직 병합되지 않음)을 테스트할 수 있습니다. 다음 과정을 수행합니다.

git fetch upstream  pull/<PR ID>/head:<branch name>

PR ID is the number right next to the PR's title (without the #) and the <branch name> can also be found right below the PR ID, e.g. <the other persons git name>:<branch name>. 그 후 다음을 사용하여 로컬에서 새로 생성된 분기를 조회할 수 있습니다.

git branch

그런 다음 해당 분기로 전환합니다.

git checkout <branch name>

일반적인 함정

분기된 저장소로 강제 푸시

첫 번째 풀 요청후에, PX4 커뮤니티의 사람들이 변경 사항을 검토합니다. 대부분의 경우 검토에 따라 로컬 지점을 수정하여야 함을 의미합니다. After changing the files locally, the feature branch needs to be rebased again with the most recent upstream/main. 그러나, 리베이스 후에는 더 이상 기능 분기를 분기된 저장소에 직접 푸시할 수 없지만, 대신 강제 푸시를 사용하여야 합니다.

git push --force-with-lease origin <your feature branch name>

리베이스 병합 충돌

If a conflict occurs during a git rebase, please refer to this guide.

풀 병합 충돌

If a conflict occurs during a git pull, please refer to this guide.

오래된 git 태그로 인한 빌드 오류

The build error Error: PX4 version too low, expected at least vx.x.x occurs if git tags are out of date.

이것은 업스트림 리포지토리 태그를 가져와서 해결할 수 있습니다.

git fetch upstream --tags