名前¶

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

概要¶

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

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

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

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

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

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

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

  http://github.com/github/perl

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

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

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

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

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

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

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

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

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

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

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

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

  [remote "origin"]
  url = git://perl5.git.perl.org/perl.git

以下のようなものに変更します:

  [remote "origin"]
  url = ssh://perl5.git.perl.org/gitroot/perl.git

注: /gitroot がオプションになるようにシンボリックリンクが設定されていて、 SSH がデフォルトのプロトコルなので、"url" を実際には perl5.git.perl.org:/perl.git に短縮できます。

ユーザー名と電子メールアドレスも設定できます。 例えば:

  % git config user.name "Leon Brocard"
  % git config user.email [email protected]

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

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

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

  % git fetch camel
  % git push camel

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

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

リポジトリの概要¶

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

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

  % git branch
  * blead

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

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

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

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

  % git log

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

  % git pull

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

  % git fetch
  % git merge origin/blead

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

  % git fetch

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

  % git remote update

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

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

  % git checkout origin/maint-5.8-dor

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

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

blead に戻るには:

  % git checkout blead

現在の状態を確認する¶

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

  % git status

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

  $ 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

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

既に触れた全ての変更をコミットすると仮定すると:

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

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)

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

パッチを投稿する¶

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

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

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

  % cd perl-git

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

  % git checkout blead
  % git pull

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

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

  % git checkout -b orange

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

  % git branch orange
  % git checkout orange

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

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

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

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

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

  % 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]>

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

  % 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(-)

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

  % git show HEAD

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

  % git commit -a --amend

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

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

[email protected] に電子メールを送信して、変更内容を説明し、 このパッチファイルを添付ファイルとして添付してください。

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

  % 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.

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

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

バイナリファイルに関する注意¶

patch(1) ユーティリティはバイナリファイルを扱うことができないので、 パッチでバイナリファイルを使わないようにするか、 ファイルを動的に生成するか、uupacktool.pl ユーティリティを使って バイナリファイルをエンコードするかのいずれかを行うことが重要です。

モジュールのテストスイートに gzip でエンコードされたファイルを含める 必要がある場合は、uupacktool.pl ユーティリティを使用して、 次のように行うことができます:

    $ perl uupacktool.pl -v -p -D lib/Some/Module/t/src/t.gz
    Writing lib/Some/Module/t/src/t.gz into lib/Some/Module/t/src/t.gz.packed

これは、t.gz ファイルを対応するエンコードされたファイルに置き換えます。 make test 中、テストが実行される前に、perl の Makefile は MANIFEST に記述されているすべての .packed ファイルを元の名前に復元します。 これは、テストスイートがこのパッキングスキームを認識する必要がなく、 変更する必要もないことを意味します。

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

パッチに最初に含める必要があるのは、パッチによって修正される問題の説明です。 (文書パッチではなく)コードパッチの場合は、 バグを説明する小さなテストケースも含める必要があります (既存のテストファイルへのパッチが推奨されます)。

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

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

(テストスイート)

When submitting a patch you should make every effort to also include an addition to perl's regression tests to properly exercise your patch. Your testsuite additions should generally follow these guidelines (courtesy of Gurusamy Sarathy <[email protected]>):

パッチを送信する際には、perl の退行テストを追加して、 パッチを適切に適用するように、あらゆる努力を払う必要があります。 テストスイートの追加は、一般的に次のガイドラインに従う必要があります (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.

パッチを受け入れる¶

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

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

  % git checkout -b experimental

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

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

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

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

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

  % 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]>

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

  % git checkout blead
  % git merge experimental
  % git push

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

  % 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.

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

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

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

  git clean -dxf

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

  git clean -Xf

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

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

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

bisect¶

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

スクリプト ~/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
  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=$?
  git clean -dxf
  exit $ret

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

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

  % git bisect start

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

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

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

  % git bisect run ~/run

最初の不正なコミットが分離されると、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

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

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

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

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

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

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

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

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

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

前述と同じパッチを作成し、新しいブランチを作成します:

  % cd perl-github
  % git remote add upstream git://github.com/github/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

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

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

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

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

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

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

  % git diff dandv/blead

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

  % git log dandv/blead

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

  % git cherry-pick 3adac458cb1c1d41af47fc66e67b49c8dec2323f

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

  % git merge dandv/blead

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

  % git push

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

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

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

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

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

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

SEE ALSO¶

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