5.12.1
CPANで確認する
Other versions:
5.40.0
5.38.0
5.36.0
5.34.0
5.32.0
5.30.0
5.28.0
5.26.1
5.24.1
5.22.1
5.20.1
5.10.1
Source
編集

名前

perlrepository - Using the Perl source repository

perlrepository - Perl ソースリポジトリを使う

概要

All of Perl's source code is kept centrally in a Git repository at perl5.git.perl.org. The repository contains many Perl revisions from Perl 1 onwards and all the revisions from Perforce, the version control system we were using previously. This repository is accessible in different ways.

Perlのソースコードはすべて、perl5.git.perl.org の Git リポジトリに 集中管理されています。 このリポジトリには、Perl 1 以降の多くの Perl リビジョンと、 以前使用していたバージョン管理システムである Perforce のすべての リビジョンが含まれています。 このリポジトリには、さまざまな方法でアクセスできます。

The full repository takes up about 80MB of disk space. A check out of the blead branch (that is, the main development branch, which contains bleadperl, the development version of perl 5) takes up about 160MB of disk space (including the repository). A build of bleadperl takes up about 200MB (including the repository and the check out).

フルリポジトリは約 80 MBのディスクスペースを使用します。 blead ブランチ(つまり、perl 5 の開発バージョンである bleadperl を含む メイン開発ブランチ)からのチェックアウトは、約 160 MBのディスクスペース (リポジトリを含む)を使用します。 bleadperl のビルドは、約 200 MB(リポジトリとチェックアウトを含む)を 使用します。

リポジトリにアクセスする

Web 経由の読み込みアクセス

You may access the repository over the web. This allows you to browse the tree, see recent commits, subscribe to RSS feeds for the changes, search for particular commits and more. You may access it at:

Web 経由でリポジトリにアクセスできます。 これにより、ツリーの参照、最近のコミットの表示、変更の RSS フィードの購読、 特定のコミットの検索などが可能になります。 次の場所からアクセスできます:

  http://perl5.git.perl.org/perl.git

A mirror of the repository is found at:

リポジトリのミラーは以下にあります:

  http://github.com/mirrors/perl

Git 経由の読み込みアクセス

You will need a copy of Git for your computer. You can fetch a copy of the repository using the Git protocol (which uses port 9418):

あなたのコンピュータ用の Git が必要です。 Git プロトコル(ポート 9418 を使用)を使用して、リポジトリのコピーを フェッチできます。

  % git clone git://perl5.git.perl.org/perl.git perl-git

This clones the repository and makes a local copy in the perl-git directory.

これにより、リポジトリは複製され、perl-git ディレクトリに ローカルコピーが作成されます。

If your local network does not allow you to use port 9418, then you can fetch a copy of the repository over HTTP (this is at least 4x slower):

ローカルネットワークでポート 9418 の使用が許可されていない場合は、 HTTP 経由でリポジトリのコピーをフェッチできます(これは少なくとも 4 倍 低速です)。

  % git clone http://perl5.git.perl.org/perl.git perl-http

This clones the repository and makes a local copy in the perl-http directory.

これにより、リポジトリが複製され、perl-http ディレクトリに ローカルコピーが作成されます。

リポジトリへの書き込みアクセス

If you are a committer, then you can fetch a copy of the repository that you can push back on with:

コミッタであれば、プッシュバック可能なリポジトリのコピーを 取得することができます。

  % git clone ssh://perl5.git.perl.org/perl.git perl-ssh

This clones the repository and makes a local copy in the perl-ssh directory.

これにより、リポジトリが複製され、perl-ssh ディレクトリに ローカルコピーが作成されます。

If you cloned using the git protocol, which is faster than ssh, then you will need to modify the URL for the origin remote to enable pushing. To do that edit .git/config with git-config(1) like this:

ssh よりも高速な git プロトコルを使用してクローンを作成した場合は、 プッシュを有効にするために origin remote のための URL を 変更する必要があります。 そうするためには、.git/config を次のように編集します:

  % git config remote.origin.url ssh://perl5.git.perl.org/perl.git

You can also set up your user name and e-mail address. Most people do this once globally in their ~/.gitconfig by doing something like:

ユーザー名と電子メールアドレスを設定することもできます。 ほとんどの人は、以下のようにすることで ~/.gitconfig でグローバルに 一度これを行います:

  % git config --global user.name "ﾃ�var Arnfj旦r丹 Bjarmason"
  % git config --global user.email [email protected]

However if you'd like to override that just for perl then execute then execute something like the following in perl-git:

しかし、perl だけに対してこれを変更したい場合は、 perl-git で次のようなものを実行します:

  % git config user.email [email protected]

It is also possible to keep origin as a git remote, and add a new remote for ssh access:

origin を git remote として維持し、ssh アクセス用の新しい remote を 追加することも可能です:

  % git remote add camel perl5.git.perl.org:/perl.git

This allows you to update your local repository by pulling from origin, which is faster and doesn't require you to authenticate, and to push your changes back with the camel remote:

これにより、origin からプルしてローカルリポジトリを更新できます; これはより高速で、認証を必要としません; また、camel リモートで変更をプッシュバックすることもできます。

  % git fetch camel
  % git push camel

The fetch command just updates the camel refs, as the objects themselves should have been fetched when pulling from origin.

fetch コマンドは単に camel refs を更新するだけです; なぜなら、オブジェクト自体は origin からプルするときに フェッチされるべきだからです。

camel と dromedary に関する注意

The committers have SSH access to the two servers that serve perl5.git.perl.org. One is perl5.git.perl.org itself (camel), which is the 'master' repository. The second one is users.perl5.git.perl.org (dromedary), which can be used for general testing and development. Dromedary syncs the git tree from camel every few minutes, you should not push there. Both machines also have a full CPAN mirror in /srv/CPAN, please use this. To share files with the general public, dromedary serves your ~/public_html/ as http://users.perl5.git.perl.org/~yourlogin/

コミッタは、perl5.git.perl.org にサービスを提供する二つの サーバにアクセスできます。 perl5.git.perl.org 自身 (camel) で、 これが「マスター」リポジトリです。 二つ目は users.perl5.git.perl.org (dromedary) で、 一般的なテストと開発に使用できます。 dromedary は数分ごとに camel から git ツリーを同期するので、そこに プッシュしてはいけません。 両方のマシンには /srv/CPAN に完全な CPAN ミラーもあるので、 これを使ってください。 dromedary はファイルを一般公開するために、 ~/public_html/ を http://users.perl5.git.perl.org/~yourlogin/ として 提供しています。

These hosts have fairly strict firewalls to the outside. Outgoing, only rsync, ssh and git are allowed. For http and ftp, you can use http://webproxy:3128 as proxy. Incoming, the firewall tries to detect attacks and blocks IP addresses with suspicious activity. This sometimes (but very rarely) has false positives and you might get blocked. The quickest way to get unblocked is to notify the admins.

これらのホストは、外部に対してかなり厳格なファイアウォールを持っています。 送信は rsync、ssh、git だけが許可されています。 http と ftp に対しては、プロキシとして http://webproxy:3128 を使用できます。 受信は、ファイアウォールは攻撃を検出し、疑わしいアクティビティを持つ IP アドレスをブロックしようとします。 これは時に(非常にまれに)誤検出があり、ブロックされる可能性があります。 ブロックを解除する最も簡単な方法は、管理者に通知することです。

These two boxes are owned, hosted, and operated by booking.com. You can reach the sysadmins in #p5p on irc.perl.org or via mail to [email protected]

これら二つのボックスは、booking.com によって所有され、ホストされ、 運営されています。 システム管理者には、irc.perl.org の #p5p か、 [email protected] へのメールで連絡できます。

リポジトリの概要

Once you have changed into the repository directory, you can inspect it.

リポジトリディレクトリに変更を加えたら、そのディレクトリを検査できます。

After a clone the repository will contain a single local branch, which will be the current branch as well, as indicated by the asterisk.

クローン作成後、リポジトリには単一のローカルブランチが含まれます。 このローカルブランチは、アスタリスクで示されているように、 現在のブランチにもなります。

  % git branch
  * blead

Using the -a switch to branch will also show the remote tracking branches in the repository:

branch に -a スイッチを使用すると、リポジトリ内の リモートトラッキングブランチも表示されます:

  % git branch -a
  * blead
    origin/HEAD
    origin/blead
  ...

The branches that begin with "origin" correspond to the "git remote" that you cloned from (which is named "origin"). Each branch on the remote will be exactly tracked by theses branches. You should NEVER do work on these remote tracking branches. You only ever do work in a local branch. Local branches can be configured to automerge (on pull) from a designated remote tracking branch. This is the case with the default branch blead which will be configured to merge from the remote tracking branch origin/blead.

"origin" で始まるブランチは、クローン元の "git remote" ("origin" という名前) に対応します。 リモートの各ブランチは、これらのブランチによって正確に追跡されます。 これらのリモート追跡ブランチでは絶対に作業しないでください。 ローカルブランチでのみ作業します。 ローカルブランチは、指定されたリモート追跡ブランチから (プル時に)自動マージするように構成できます。 これは、リモート追跡ブランチ origin/blead からマージするように 構成されているデフォルトブランチ blead の場合です。

You can see recent commits:

最近のコミットを見られます:

  % git log

And pull new changes from the repository, and update your local repository (must be clean first)

リポジトリから新しい変更をプルし、ローカルリポジトリを更新します (最初にクリーンにする必要があります)。

  % git pull

Assuming we are on the branch blead immediately after a pull, this command would be more or less equivalent to:

プルの直後にブランチ blead にいると仮定すると、このコマンドは 以下とほぼ等価になります:

  % git fetch
  % git merge origin/blead

In fact if you want to update your local repository without touching your working directory you do:

実際、作業ディレクトリにアクセスせずにローカルリポジトリを更新したい場合は、 次のようにします:

  % git fetch

And if you want to update your remote-tracking branches for all defined remotes simultaneously you can do

また、定義されたすべてのリモートに対してリモート追跡ブランチを 同時に更新したい場合は、以下のように行うことができます:

  % git remote update

Neither of these last two commands will update your working directory, however both will update the remote-tracking branches in your repository.

最後の二つのコマンドはどちらも作業ディレクトリを更新しませんが、どちらも リポジトリ内のリモート追跡ブランチを更新します。

To switch to another branch:

他のブランチに切り替えるには:

  % git checkout origin/maint-5.8-dor

To make a local branch of a remote branch:

リモートブランチのローカルブランチを作るには:

  % git checkout -b maint-5.10 origin/maint-5.10

To switch back to blead:

blead に戻るには:

  % git checkout blead

現在の状態を確認する

The most common git command you will use will probably be

おそらくもっともよく使う git コマンドは:

  % git status

This command will produce as output a description of the current state of the repository, including modified files and unignored untracked files, and in addition it will show things like what files have been staged for the next commit, and usually some useful information about how to change things. For instance the following:

このコマンドは、変更されたファイルや無視されていない 追跡されていないファイルなど、リポジトリの現在の状態の説明を 出力として生成します。 さらに、次のコミットのためにステージングされたファイルや、 通常は変更方法に関する有用な情報を表示します。 たとえば、次のようになります:

  $ git status
  # On branch blead
  # Your branch is ahead of 'origin/blead' by 1 commit.
  #
  # Changes to be committed:
  #   (use "git reset HEAD <file>..." to unstage)
  #
  #       modified:   pod/perlrepository.pod
  #
  # Changed but not updated:
  #   (use "git add <file>..." to update what will be committed)
  #
  #       modified:   pod/perlrepository.pod
  #
  # Untracked files:
  #   (use "git add <file>..." to include in what will be committed)
  #
  #       deliberate.untracked

This shows that there were changes to this document staged for commit, and that there were further changes in the working directory not yet staged. It also shows that there was an untracked file in the working directory, and as you can see shows how to change all of this. It also shows that there is one commit on the working branch blead which has not been pushed to the origin remote yet. NOTE: that this output is also what you see as a template if you do not provide a message to git commit.

これは、コミットのためにステージングされたこの文書に変更があったことと、 まだステージングされていないワーキングディレクトリに さらに変更があったことを示しています。 また、ワーキングディレクトリに追跡されていないファイルが あったことも示しています; また、これらすべてを変更する方法を示しています。 また、origin リモートにまだプッシュされていないワーキングブランチ blead に一つのコミットがあることも示しています。 注: この出力は、git commit にメッセージを提供しない場合に テンプレートとして表示されるものでもあります。

Assuming that you'd like to commit all the changes you've just made as a a single atomic unit, run this command:

今行ったすべての変更を一つのアトミックユニットとしてコミットしたい場合は、 次のコマンドを実行します:

   % git commit -a

(That -a tells git to add every file you've changed to this commit. New files aren't automatically added to your commit when you use commit -a If you want to add files or to commit some, but not all of your changes, have a look at the documentation for git add.)

(-a は git に対して、変更したすべてのファイルをこのコミットに 追加するように指示します。 commit -a を使用しても、新しいファイルは自動的にコミットに追加されません。 ファイルを追加したい場合や、一部の変更をコミットしたい場合は、 git add の文書を参照してください。

Git will start up your favorite text editor, so that you can craft a commit message for your change. See "Commit message" below for more information about what makes a good commit message.

Git は、あなたが変更内容のコミットメッセージを作成できるように、 お気に入りのテキストエディタを起動します。 適切なコミットメッセージを作成する方法に関するさらなる情報については、 後述の "Commit message" を参照してください。

Once you've finished writing your commit message and exited your editor, git will write your change to disk and tell you something like this:

コミットメッセージを書き終えてエディタを終了すると、 git は変更をディスクに書き込み、以下のようなメッセージを出力します:

  Created commit daf8e63: explain git status and stuff about remotes
   1 files changed, 83 insertions(+), 3 deletions(-)

If you re-run git status, you should see something like this:

git status を再実行すると、以下のようなものが得られます:

  % git status
  # On branch blead
  # Your branch is ahead of 'origin/blead' by 2 commits.
  #
  # Untracked files:
  #   (use "git add <file>..." to include in what will be committed)
  #
  #       deliberate.untracked
  nothing added to commit but untracked files present (use "git add" to track)

When in doubt, before you do anything else, check your status and read it carefully, many questions are answered directly by the git status output.

何か疑問がある場合には、何かをする前に自分のステータスをチェックして 注意深く読んでください; 多くの疑問に対しては、git status 出力が直接答えてくれます。

パッチを投稿する

If you have a patch in mind for Perl, you should first get a copy of the repository:

Perl 用のパッチを考えている場合は、まずリポジトリのコピーを 入手する必要があります。

  % git clone git://perl5.git.perl.org/perl.git perl-git

Then change into the directory:

それからディレクトリを変更します:

  % cd perl-git

Alternatively, if you already have a Perl repository, you should ensure that you're on the blead branch, and your repository is up to date:

あるいは、すでに Perl リポジトリを持っている場合は、 blead ブランチにいて、リポジトリが最新であることを確認する必要があります:

  % git checkout blead
  % git pull

It's preferable to patch against the latest blead version, since this is where new development occurs for all changes other than critical bug fixes. Critical bug fix patches should be made against the relevant maint branches, or should be submitted with a note indicating all the branches where the fix should be applied.

最新の blead バージョンに対してパッチを適用することをお勧めします。 これは、重大なバグ修正以外のすべての変更に対して新たな開発が行われる 場所であるためです。 重大なバグ修正パッチは、関連するメインブランチに対して作成するか、 修正が適用されるすべてのブランチを示すメモとともに提出する必要があります。

Now that we have everything up to date, we need to create a temporary new branch for these changes and switch into it:

すべてが最新の状態になったので、これらの変更に対して一時的な 新しいブランチを作成し、そのブランチに切り替える必要があります:

  % git checkout -b orange

which is the short form of

これは以下のものの短縮形です

  % git branch orange
  % git checkout orange

Creating a topic branch makes it easier for the maintainers to rebase or merge back into the master blead for a more linear history. If you don't work on a topic branch the maintainer has to manually cherry pick your changes onto blead before they can be applied.

トピックブランチを作成することで、メンテナはよりリニアな履歴のために master blead にリベースまたはマージバックすることが簡単になります。 トピックブランチで作業しない場合、 メンテナは変更を適用する前に手動で blead にチェリーピックする 必要があります。

That'll get you scolded on perl5-porters, so don't do that. Be Awesome.

perl5-porters で叱られることになるので、そんなことはしないでください。 うまくやりましょう。

Then make your changes. For example, if Leon Brocard changes his name to Orange Brocard, we should change his name in the AUTHORS file:

次に、変更を加えます。 たとえば、Leon Brocard が名前を Orange Brocard に変更した場合、 AUTHORS ファイル内の名前を変更する必要があります:

  % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS

You can see what files are changed:

どのファイルを変更したかを見られます:

  % git status
  # On branch orange
  # Changes to be committed:
  #   (use "git reset HEAD <file>..." to unstage)
  #
  #    modified:   AUTHORS
  #

And you can see the changes:

そして変更が見られます:

  % git diff
  diff --git a/AUTHORS b/AUTHORS
  index 293dd70..722c93e 100644
  --- a/AUTHORS
  +++ b/AUTHORS
  @@ -541,7 +541,7 @@    Lars Hecking                   <[email protected]>
   Laszlo Molnar                  <[email protected]>
   Leif Huhn                      <[email protected]>
   Len Johnson                    <[email protected]>
  -Leon Brocard                   <[email protected]>
  +Orange Brocard                 <[email protected]>
   Les Peters                     <[email protected]>
   Lesley Binks                   <[email protected]>
   Lincoln D. Stein               <[email protected]>

Now commit your change locally:

ここで変更をローカルにコミットします:

  % git commit -a -m 'Rename Leon Brocard to Orange Brocard'
  Created commit 6196c1d: Rename Leon Brocard to Orange Brocard
   1 files changed, 1 insertions(+), 1 deletions(-)

You can examine your last commit with:

最後のコミットを以下のようにして検査できます:

  % git show HEAD

and if you are not happy with either the description or the patch itself you can fix it up by editing the files once more and then issue:

説明またはパッチ自体に満足できない場合は、ファイルをもう一度編集してから 次のコマンドを発行することで修正できます:

  % git commit -a --amend

Now you should create a patch file for all your local changes:

ここで全てのローカルな変更のためのパッチファイルを作るべきです:

  % git format-patch origin
  0001-Rename-Leon-Brocard-to-Orange-Brocard.patch

You should now send an email to [email protected] with a description of your changes, and include this patch file as an attachment. (See the next section for how to configure and use git to send these emails for you.)

[email protected] 宛に変更内容を記載したメールを送信し、 このパッチファイルを添付ファイルとして送ってください (これらのメールを送信するために git を設定して使う方法については、 次の節を参照してください)。

If you want to delete your temporary branch, you may do so with:

一時的なブランチを削除したいなら、以下のようにできます:

  % git checkout blead
  % git branch -d orange
  error: The branch 'orange' is not an ancestor of your current HEAD.
  If you are sure you want to delete it, run 'git branch -D orange'.
  % git branch -D orange
  Deleted branch orange.

Using git to send patch emails

In your ~/git/perl repository, set the destination email to the perl5-porters mailing list.

~/git/perl リポジトリで、宛先メールを perl5-porter メーリングリストに 設定します。

  $ git config sendemail.to [email protected]

Then you can use git directly to send your patch emails:

その後、git を直接使ってパッチメールを送ることができます:

  $ git send-email 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch

You may need to set some configuration variables for your particular email service provider. For example, to set your global git config to send email via a gmail account:

特定の電子メールサービスプロバイダに対していくつかの設定変数を設定する 必要があるかもしれません。 例えば、gmail アカウント経由で電子メールを送信するように グローバル git を設定するには:

  $ git config --global sendemail.smtpserver smtp.gmail.com
  $ git config --global sendemail.smtpssl 1
  $ git config --global sendemail.smtpuser [email protected]

With this configuration, you will be prompted for your gmail password when you run 'git send-email'. You can also configure sendemail.smtppass with your password if you don't care about having your password in the .gitconfig file.

この設定では、'git send-email' を実行するときに gmail パスワードの入力を求められます。 .gitconfig ファイルにパスワードを保存したくない場合は、 sendemail.smtppass にパスワードを設定することもできます。

派生ファイルに関する注意

Be aware that many files in the distribution are derivative--avoid patching them, because git won't see the changes to them, and the build process will overwrite them. Patch the originals instead. Most utilities (like perldoc) are in this category, i.e. patch utils/perldoc.PL rather than utils/perldoc. Similarly, don't create patches for files under $src_root/ext from their copies found in $install_root/lib. If you are unsure about the proper location of a file that may have gotten copied while building the source distribution, consult the MANIFEST.

ディストリビューション内の多くのファイルは 派生的なものであることに注意してください -- それらのファイルにパッチを当てることは避けてください; なぜなら、git はそれらに対する変更を見ることができず、 ビルドプロセスがそれらを上書きするからです。 代わりにオリジナルにパッチを当ててください。 ほとんどのユーティリティ(perldoc など)はこのカテゴリにあります; すなわち、utils/perldoc ではなく utils/perldoc.PL にパッチを当てます。 同様に、$install_root/lib にあるコピーから $src_root/ext 以下のファイルに パッチを作成しないでください。 ソースディストリビューションのビルド中にコピーされた可能性のあるファイルの 適切な場所がわからない場合は、MANIFEST を調べてください。

As a special case, several files are regenerated by 'make regen' if your patch alters embed.fnc. These are needed for compilation, but are included in the distribution so that you can build perl without needing another perl to generate the files. You must test with these regenerated files, but it is preferred that you instead note that 'make regen is needed' in both the email and the commit message, and submit your patch without them. If you're submitting a series of patches, it might be best to submit the regenerated changes immediately after the source-changes that caused them, so as to have as little effect as possible on the bisectability of your patchset.

特別なケースとして、パッチが embed.fnc を変更した場合、 'make regen' によっていくつかのファイルが再生成されます。 これらはコンパイルに必要ですが、ファイルを生成するために 別の perl を必要とすることなく perl を構築できるように、 ディストリビューションに含まれています。 これらの再生成されたファイルを使用してテストする必要がありますが、 代わりに電子メールとコミットメッセージの両方に'make regen is needed' という 注意を追加し、それらなしでパッチを送信することをお勧めします。 一連のパッチを送信する場合は、パッチセットの bisect 可能性への影響を できるだけ少なくするために、再生成された変更をその原因となった ソース変更の直後に送信することをお勧めします。

What should we recommend about binary files now? Do we need anything?

あなたのパッチを受け入れてもらうために

If you are submitting a code patch there are several things that you need to do.

コードパッチを送信する場合は、いくつか行う必要があります。

Commit message

As you craft each patch you intend to submit to the Perl core, it's important to write a good commit message.

Perl コアに投稿しようとするパッチを作成する際には、 適切なコミットメッセージを作成することが重要です。

Your commit message should start with a description of the problem that the patch corrects or new functionality that the patch adds.

コミットメッセージは、パッチによって修正される問題の説明、または パッチによって追加される新機能の説明から始める必要があります。

As a general rule of thumb, your commit message should let a programmer with a reasonable familiarity with the Perl core quickly understand what you were trying to do, how you were trying to do it and why the change matters to Perl.

一般的な経験則として、コミットメッセージによって、Perl コアにある程度 精通したプログラマーは、何をしようとしているのか、 どのようにしようとしているのか、そしてなぜ変更が Perl にとって 重要なのかをすぐに理解できるはずです。

What

Your commit message should describe what part of the Perl core you're changing and what you expect your patch to do.

コミットメッセージには、Perlコアのどの部分を変更しようとしているのか、 パッチに何を期待しているのかを記述する必要があります。

Why

Perhaps most importantly, your commit message should describe why the change you are making is important. When someone looks at your change in six months or six years, your intent should be clear. If you're deprecating a feature with the intent of later simplifying another bit of code, say so. If you're fixing a performance problem or adding a new feature to support some other bit of the core, mention that.

おそらく最も重要なのは、コミットメッセージに、 自分が行っている変更がなぜ重要なのかを記述すべきだということです。 6 ヶ月や6 年後に誰かがあなたの変更を見たとき、 あなたの意図は明確であるべきです。 後で別のコードを単純化するために機能を非推奨にしているのであれば、 そう書いてください。 パフォーマンスの問題を修正したり、コアの他の部分をサポートするための 新機能を追加しているのであれば、そのことに言及してください。

How

While it's not necessary for documentation changes, new tests or trivial patches, it's often worth explaining how your change works. Even if it's clear to you today, it may not be clear to a porter next month or next year.

文書の変更、新しいテスト、簡単なパッチなどでは必要ありませんが、 変更がどのように機能するかを説明する価値があることがよくあります。 今日ははっきりしていても、来月や来年にははっきりしないかもしれません。

A commit message isn't intended to take the place of comments in your code. Commit messages should describe the change you made, while code comments should describe the current state of the code. If you've just implemented a new feature, complete with doc, tests and well-commented code, a brief commit message will often suffice. If, however, you've just changed a single character deep in the parser or lexer, you might need to write a small novel to ensure that future readers understand what you did and why you did it.

コミットメッセージは、コード内のコメントに代わるものではありません。 コミットメッセージには変更内容が記述され、コードコメントにはコードの 現在の状態が記述されます。 新機能を実装したばかりで、文書、テスト、コメント付きのコードが 揃っている場合は、簡単なコミットメッセージで十分なことがよくあります。 ただし、パーサや字句解析器の奥深くにある 1 文字を変更しただけの場合は、 将来の読者が自分のしたこととその理由を確実に理解できるように、 短い小説を書く必要があるかもしれません。

Comments, Comments, Comments

(コメント、コメント、コメント)

Be sure to adequately comment your code. While commenting every line is unnecessary, anything that takes advantage of side effects of operators, that creates changes that will be felt outside of the function being patched, or that others may find confusing should be documented. If you are going to err, it is better to err on the side of adding too many comments than too few.

コードに適切なコメントを付けるようにしてください。 すべての行にコメントを付ける必要はありませんが、演算子の副作用を利用するもの、 パッチされている関数の外部で感じられる変更を生成するもの、 または他の人が混乱を感じる可能性のあるものはすべて 文書化する必要があります。 過ちを起こす場合は、コメントの数が少なすぎる過ちよりも、 コメントの数が多すぎる過ちの方がましです。

Style

(スタイル)

In general, please follow the particular style of the code you are patching.

一般に、パッチを適用するコードは特定のスタイルに従ってください。

In particular, follow these general guidelines for patching Perl sources:

特に、Perl ソースにパッチを適用する場合は、次の一般的なガイドラインに 従ってください:

    8-wide tabs (no exceptions!)
    4-wide indents for code, 2-wide indents for nested CPP #defines
    try hard not to exceed 79-columns
    ANSI C prototypes
    uncuddled elses and "K&R" style for indenting control constructs
    no C++ style (//) comments
    mark places that need to be revisited with XXX (and revisit often!)
    opening brace lines up with "if" when conditional spans multiple
        lines; should be at end-of-line otherwise
    in function definitions, name starts in column 0 (return value is on
        previous line)
    single space after keywords that are followed by parens, no space
        between function name and following paren
    avoid assignments in conditionals, but if they're unavoidable, use
        extra paren, e.g. "if (a && (b = c)) ..."
    "return foo;" rather than "return(foo);"
    "if (!foo) ..." rather than "if (foo == FALSE) ..." etc.
Testsuite

(テストスイート)

If your patch changes code (rather than just changing documentation) you should also include one or more test cases which illustrate the bug you're fixing or validate the new functionality you're adding. In general, you should update an existing test file rather than create a new one.

パッチによってコードが変更された場合(単なる文書の変更ではなく)、 修正しようとしているバグを説明するか、 追加しようとしている新機能を検証するテストケースを一つ以上含める 必要があります。 一般的には、新しいテストファイルを作成するのではなく、 既存のテストファイルを更新するべきです。

Your testsuite additions should generally follow these guidelines (courtesy of Gurusamy Sarathy <[email protected]>):

テストスイートの追加は、一般的に次のガイドラインに従う必要があります (Gurusamy Sarthy <[email protected]> による):

    Know what you're testing.  Read the docs, and the source.
    Tend to fail, not succeed.
    Interpret results strictly.
    Use unrelated features (this will flush out bizarre interactions).
    Use non-standard idioms (otherwise you are not testing TIMTOWTDI).
    Avoid using hardcoded test numbers whenever possible (the
      EXPECTED/GOT found in t/op/tie.t is much more maintainable,
      and gives better failure reports).
    Give meaningful error messages when a test fails.
    Avoid using qx// and system() unless you are testing for them.  If you
      do use them, make sure that you cover _all_ perl platforms.
    Unlink any temporary files you create.
    Promote unforeseen warnings to errors with $SIG{__WARN__}.
    Be sure to use the libraries and modules shipped with the version
      being tested, not those that were already installed.
    Add comments to the code explaining what you are testing for.
    Make updating the '1..42' string unnecessary.  Or make sure that
      you update it.
    Test _all_ behaviors of a given operator, library, or function:
      - All optional arguments
      - Return values in various contexts (boolean, scalar, list, lvalue)
      - Use both global and lexical variables
      - Don't forget the exceptional, pathological cases.

パッチを受け入れる

If you have received a patch file generated using the above section, you should try out the patch.

前述の節でを使って生成されたパッチファイルを受け取った場合は、 パッチを試してみてください。

First we need to create a temporary new branch for these changes and switch into it:

まず、これらの変更のための一時的な新しいブランチを作成し、そのブランチに 切り替える必要があります:

  % git checkout -b experimental

Patches that were formatted by git format-patch are applied with git am:

git format-patch でフォーマットされたパッチは、git am で適用されます:

  % git am 0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
  Applying Rename Leon Brocard to Orange Brocard

If just a raw diff is provided, it is also possible use this two-step process:

生の diff だけが提供されている場合は、次の 2 段階のプロセスを 使用することもできます:

  % git apply bugfix.diff
  % git commit -a -m "Some fixing" --author="That Guy <[email protected]>"

Now we can inspect the change:

ここで変更を検査できます:

  % git show HEAD
  commit b1b3dab48344cff6de4087efca3dbd63548ab5e2
  Author: Leon Brocard <[email protected]>
  Date:   Fri Dec 19 17:02:59 2008 +0000

    Rename Leon Brocard to Orange Brocard

  diff --git a/AUTHORS b/AUTHORS
  index 293dd70..722c93e 100644
  --- a/AUTHORS
  +++ b/AUTHORS
  @@ -541,7 +541,7 @@ Lars Hecking                        <[email protected]>
   Laszlo Molnar                  <[email protected]>
   Leif Huhn                      <[email protected]>
   Len Johnson                    <[email protected]>
  -Leon Brocard                   <[email protected]>
  +Orange Brocard                 <[email protected]>
   Les Peters                     <[email protected]>
   Lesley Binks                   <[email protected]>
   Lincoln D. Stein               <[email protected]>

If you are a committer to Perl and you think the patch is good, you can then merge it into blead then push it out to the main repository:

もしあなたが Perl のコミッタで、パッチが良いものだと思うなら、 それを blead にマージしてメインのリポジトリにプッシュすることができます:

  % git checkout blead
  % git merge experimental
  % git push

If you want to delete your temporary branch, you may do so with:

一時的なブランチを削除したいなら、以下のようにできます:

  % git checkout blead
  % git branch -d experimental
  error: The branch 'experimental' is not an ancestor of your current HEAD.
  If you are sure you want to delete it, run 'git branch -D experimental'.
  % git branch -D experimental
  Deleted branch experimental.

作業ディレクトリを掃除する

The command git clean can with varying arguments be used as a replacement for make clean.

git clean コマンドはさまざまな引数で make clean の代わりに 使うことができます。

To reset your working directory to a pristine condition you can do:

作業ディレクトリを初期状態にリセットするには、次のようにします:

  % git clean -dxf

However, be aware this will delete ALL untracked content. You can use

ただし、これによりすべての追跡されていないコンテンツが削除されます。 次のようにすると:

  % git clean -Xf

to remove all ignored untracked files, such as build and test byproduct, but leave any manually created files alone.

ビルドやテストの副産物など、すべての無視された 追跡されていないファイルを削除します。 ただし、手動で作成したファイルは残します。

If you only want to cancel some uncommitted edits, you can use git checkout and give it a list of files to be reverted, or git checkout -f to revert them all.

コミットされていない編集だけをキャンセルしたい場合は、 git checkout を使用して元に戻すファイルのリストを与えるか、 git checkout -f を使用してすべてを元に戻すことができます。

If you want to cancel one or several commits, you can use git reset.

1つまたは複数のコミットをキャンセルしたい場合は、git reset を 使うことができます。

bisect

git provides a built-in way to determine, with a binary search in the history, which commit should be blamed for introducing a given bug.

git には、履歴の二分検索を使って、どのコミットが特定のバグを 引き起こしたと非難されるべきかを判断する手段が組み込まれています。

Suppose that we have a script ~/testcase.pl that exits with 0 when some behaviour is correct, and with 1 when it's faulty. You need an helper script that automates building perl and running the testcase:

スクリプト ~/testcase.pl があり、動作が正しい場合は 0 で終了し、 動作が正しくない場合は 1 で終了するとします。 perl の構築とテストケースの実行を自動化するヘルパースクリプトが必要です:

  % cat ~/run
  #!/bin/sh
  git clean -dxf
  # If you can use ccache, add -Dcc=ccache\ gcc -Dld=gcc to the Configure line
  # if Encode is not needed for the test, you can speed up the bisect by
  # excluding it from the runs with -Dnoextensions=Encode
  sh Configure -des -Dusedevel -Doptimize="-g"
  test -f config.sh || exit 125
  # Correct makefile for newer GNU gcc
  perl -ni -we 'print unless /<(?:built-in|command)/' makefile x2p/makefile
  # if you just need miniperl, replace test_prep with miniperl
  make -j4 test_prep
  [ -x ./perl ] || exit 125
  ./perl -Ilib ~/testcase.pl
  ret=$?
  [ $ret -gt 127 ] && ret=127
  git clean -dxf
  exit $ret

This script may return 125 to indicate that the corresponding commit should be skipped. Otherwise, it returns the status of ~/testcase.pl.

このスクリプトは、対応するコミットをスキップすることを示す 125 を 返す場合があります。 それ以外の場合は、~/testcase.plのステータスを返します。

You first enter in bisect mode with:

まず bisect モードに入ります:

  % git bisect start

For example, if the bug is present on HEAD but wasn't in 5.10.0, git will learn about this when you enter:

例えば、バグが HEAD にあっても 5.10.0 にはなかった場合、git は 以下のように入力することでこれを学習します:

  % git bisect bad
  % git bisect good perl-5.10.0
  Bisecting: 853 revisions left to test after this

This results in checking out the median commit between HEAD and perl-5.10.0. You can then run the bisecting process with:

この結果、HEAD と perl-5.10.0 の中間のコミットが チェックアウトされます。 次のようにして bisect 処理を実行します:

  % git bisect run ~/run

When the first bad commit is isolated, git bisect will tell you so:

最初の不正なコミットが分離されると、git bisect は次のように言います:

  ca4cfd28534303b82a216cfe83a1c80cbc3b9dc5 is first bad commit
  commit ca4cfd28534303b82a216cfe83a1c80cbc3b9dc5
  Author: Dave Mitchell <[email protected]>
  Date:   Sat Feb 9 14:56:23 2008 +0000

      [perl #49472] Attributes + Unknown Error
      ...

  bisect run success

You can peek into the bisecting process with git bisect log and git bisect visualize. git bisect reset will get you out of bisect mode.

git bisect log と git bisect visualize で bisect 処理を 覗き見ることができます。 git bisect resetは bisect モードを解除します。

Please note that the first good state must be an ancestor of the first bad state. If you want to search for the commit that solved some bug, you have to negate your test case (i.e. exit with 1 if OK and 0 if not) and still mark the lower bound as good and the upper as bad. The "first bad commit" has then to be understood as the "first commit where the bug is solved".

最初の good 状態は、最初の bad 状態の祖先である必要があることに 注意してください。 何らかのバグを 解決した コミットを検索したい場合は、テストケースを 反転させ、 (つまり、OK なら 1 で終了し、そうでないなら 0 で終了する)、 下限を good、上限を bad とマークする必要があります。 「最初の不正なコミット」は、「バグが解決された最初のコミット」と 解釈する必要があります。

git help bisect has much more information on how you can tweak your binary searches.

git help bisect には、二分探索を微調整する方法に関する情報が豊富に 用意されています。

GitHub 経由でパッチを投稿する

GitHub is a website that makes it easy to fork and publish projects with Git. First you should set up a GitHub account and log in.

GitHub は、Git でプロジェクトをフォークして公開することを容易にする ウェブサイトです。 まず、GitHub アカウントを設定してログインする必要があります。

Perl's git repository is mirrored on GitHub at this page:

Perl の git リポジトリは GitHub のこのページにミラーリングされています:

  http://github.com/mirrors/perl/tree/blead

Visit the page and click the "fork" button. This clones the Perl git repository for you and provides you with "Your Clone URL" from which you should clone:

このページにアクセスして、"fork"ボタンをクリックしてください。 これは Perl git リポジトリをクローンし、クローン元の "Your Clone URL" を 提供します:

  % git clone [email protected]:USERNAME/perl.git perl-github

The same patch as above, using github might look like this:

前述と同じパッチで、github を使うと次のようになります:

  % cd perl-github
  % git remote add upstream git://perl5.git.perl.org/perl.git
  % git pull upstream blead
  % git checkout -b orange
  % perl -pi -e 's{Leon Brocard}{Orange Brocard}' AUTHORS
  % git commit -a -m 'Rename Leon Brocard to Orange Brocard'
  % git push origin orange

The orange branch has been pushed to GitHub, so you should now send an email to [email protected] with a description of your changes and the following information:

orange ブランチは GitHub にプッシュされたので、[email protected] に 変更内容および以下の情報をメール送信してください:

  http://github.com/USERNAME/perl/tree/orange
  [email protected]:USERNAME/perl.git branch orange

GitHub 経由のブランチをマージする

If someone has provided a branch via GitHub and you are a committer, you should use the following in your perl-ssh directory:

誰かが GitHub 経由でブランチを提供しており、あなたがコミッタである場合、 perl-ssh ディレクトリで以下を使用する必要があります:

  % git remote add dandv git://github.com/dandv/perl.git
  % git fetch dandv

Now you can see the differences between the branch and blead:

これで、そのブランチと blead の差分を見られるようになりました:

  % git diff dandv/blead

And you can see the commits:

そしてコミットを表示できます:

  % git log dandv/blead

If you approve of a specific commit, you can cherry pick it:

特定のコミットを承認する場合は、次のようにして選択できます:

  % git cherry-pick 3adac458cb1c1d41af47fc66e67b49c8dec2323f

Or you could just merge the whole branch if you like it all:

または、必要に応じてブランチ全体をマージすることもできます:

  % git merge dandv/blead

And then push back to the repository:

そして、リポジトリにプッシュバックします:

  % git push

トピックブランチと履歴の書き換え

Individual committers should create topic branches under yourname/some_descriptive_name. Other committers should check with a topic branch's creator before making any change to it.

個々のコミッターは、yourname/some_descriptive_name の下にトピックブランチを作成する必要があります。 他のコミッターは、トピックブランチに変更を加える前に、その作成者に 確認する必要があります。

The simplest way to create a remote topic branch that works on all versions of git is to push the current head as a new branch on the remote, then check it out locally:

すべてのバージョンの git で動作する、リモートトピックブランチを作成する 最も簡単な方法は、現在の head をリモートの新しいブランチとしてプッシュし、 ローカルでチェックアウトすることです。

  $ branch="$yourname/$some_descriptive_name"
  $ git push origin HEAD:$branch
  $ git checkout -b $branch origin/$branch

Users of git 1.7 or newer can do it in a more obvious manner:

git 1.7 以降のユーザは、もっと明らかな方法を使うことが出来ます:

  $ branch="$yourname/$some_descriptive_name"
  $ git checkout -b $branch
  $ git push origin -u $branch

If you are not the creator of yourname/some_descriptive_name, you might sometimes find that the original author has edited the branch's history. There are lots of good reasons for this. Sometimes, an author might simply be rebasing the branch onto a newer source point. Sometimes, an author might have found an error in an early commit which they wanted to fix before merging the branch to blead.

yourname/some_descriptive_name の作成者でない場合、元の作成者が ブランチの履歴を編集したことに気付くことがあります。 これには多くの正当な理由があります。 場合によっては、単にブランチを新しいソースポイントに基づいて 作り直すことになることもあります。 場合によっては、ブランチを blead にマージする前に、 初期のコミットで修正したいエラーを見つけたこともあります。

Currently the master repository is configured to forbid non-fast-forward merges. This means that the branches within can not be rebased and pushed as a single step.

現在、マスターリポジトリは、非 fast-forward のマージを禁止するように 構成されています。 これは、中のブランチはリベースとプッシュを単一ステップとしては できないことを意味します。

The only way you will ever be allowed to rebase or modify the history of a pushed branch is to delete it and push it as a new branch under the same name. Please think carefully about doing this. It may be better to sequentially rename your branches so that it is easier for others working with you to cherry-pick their local changes onto the new version. (XXX: needs explanation).

プッシュされたブランチの履歴を再取得または変更する唯一の方法は、 そのブランチを削除し、同じ名前で新しいブランチとしてプッシュすることです。 これを行うことについては慎重に検討してください。 他のユーザーが新しいバージョンにローカルの変更を簡単に チェリーピックできるように、 ブランチの名前を順番に変更した方がよい場合があります(XXX:説明が必要)。

If you want to rebase a personal topic branch, you will have to delete your existing topic branch and push as a new version of it. You can do this via the following formula (see the explanation about refspec's in the git push documentation for details) after you have rebased your branch:

個人的なトピックブランチをリベースしたい場合は、 既存のトピックブランチを削除し、新しいバージョンとして プッシュする必要があります。 これは、ブランチをリベースした後、次の公式 (詳細は git push 文書の refspec に関する説明を参照)で行うことができます。

   # first rebase
   $ git checkout $user/$topic
   $ git fetch
   $ git rebase origin/blead

   # then "delete-and-push"
   $ git push origin :$user/$topic
   $ git push origin $user/$topic

NOTE: it is forbidden at the repository level to delete any of the "primary" branches. That is any branch matching m!^(blead|maint|perl)!. Any attempt to do so will result in git producing an error like this:

注意: リポジトリレベルで"プライマリ"ブランチを削除することは 禁止されています。 これは m!^(blead maint perl)! にマッチングするブランチです。 削除しようとすると、gitは次のようなエラーを生成します:

    $ git push origin :blead
    *** It is forbidden to delete blead/maint branches in this repository
    error: hooks/update exited with error code 1
    error: hook declined to update refs/heads/blead
    To ssh://perl5.git.perl.org/perl
     ! [remote rejected] blead (hook declined)
     error: failed to push some refs to 'ssh://perl5.git.perl.org/perl'

As a matter of policy we do not edit the history of the blead and maint-* branches. If a typo (or worse) sneaks into a commit to blead or maint-*, we'll fix it in another commit. The only types of updates allowed on these branches are "fast-forward's", where all history is preserved.

ポリシーとして、blead ブランチと maint-* ブランチの履歴は編集 しません。 タイプミス(またはそれ以上)が blead または maint-* へのコミットに 忍び込んだ場合は、別のコミットで修正します。 これらのブランチで許可されている更新のタイプは "fast-forward" だけで、 すべての履歴が保存されます。

Annotated tags in the canonical perl.git repository will never be deleted or modified. Think long and hard about whether you want to push a local tag to perl.git before doing so. (Pushing unannotated tags is not allowed.)

標準的な perl.git リポジトリ内の注釈付きタグは、削除や 変更されることはありません。 ローカルタグを perl.git にプッシュする前に、じっくり考えてみてください (注釈なしタグのプッシュは許可されていません)。

メンテナンスバージョンにコミットする

Maintenance versions should only be altered to add critical bug fixes.

メンテナンスバージョンは、重要なバグ修正を追加する場合にのみ変更してください。

To commit to a maintenance version of perl, you need to create a local tracking branch:

perl のメンテナンスバージョンにコミットするには、 ローカル追跡ブランチを作成する必要があります。

  % git checkout --track -b maint-5.005 origin/maint-5.005

This creates a local branch named maint-5.005, which tracks the remote branch origin/maint-5.005. Then you can pull, commit, merge and push as before.

これにより、リモートブランチ origin/maint-5.005 を追跡する maint-5.005 という名前のローカルブランチが作成されます。 次に、以前と同じようにプル、コミット、マージ、プッシュを行うことができます。

You can also cherry-pick commits from blead and another branch, by using the git cherry-pick command. It is recommended to use the -x option to git cherry-pick in order to record the SHA1 of the original commit in the new commit message.

git cherry-pick コマンドを使用して、blead と別のブランチから コミットをチェリーピックすることもできます。 元のコミットの SHA1 を新しいコミットメッセージに記録するために、 git cherry-pick に -x オプションを使うことを勧めます。

GRAFTS

The perl history contains one mistake which was not caught in the conversion: a merge was recorded in the history between blead and maint-5.10 where no merge actually occurred. Due to the nature of git, this is now impossible to fix in the public repository. You can remove this mis-merge locally by adding the following line to your .git/info/grafts file:

Perl履歴には、変換で検出されなかった誤りが一つ含まれています: blead と maint-5.10 の間の履歴にマージが記録されましたが、 実際にはマージは発生しませんでした。 git の性質上、パブリックリポジトリで修正することは現在不可能です。 .git/info/graft ファイルに次の行を追加することで、 この誤ったマージをローカルで削除できます。

  296f12bbbbaa06de9be9d09d3dcf8f4528898a49 434946e0cb7a32589ed92d18008aaa1d88515930

It is particularly important to have this graft line if any bisecting is done in the area of the "merge" in question.

問題の「マージ」領域で bisect が行われる場合、この graft 行を 指定することが特に重要です。

SEE ALSO

The git documentation, accessible via git help command.

git help command でアクセスできる git 文書。

Powered by Amon2, 翻訳, サイト. Operated by Japan Perl Association