OSDN Git Service

info/GNU_which: Add some explanations.
[linuxjm/jm.git] / guide / GNU_coreutils.rst
index 6bd493a..2a3f0db 100644 (file)
@@ -7,15 +7,6 @@ GNU coreutils 翻訳ガイド
 準備
 ====
 
-GNU coreutils のマニュアルのレポジトリは git の submodule になっている。
-作業時は以下のように submodule を展開する。
-
-.. code-block:: console
-
-   git://scm.osdn.jp/gitroot/linuxjm/jm.git
-   cd jm
-   git submodule update --init --recursive
-
 ``help2man`` と ``help2man`` のメッセージカタログをインストールしておく必要がある。
 Debian/Ubuntu の場合は ``help2man`` と ``language-pack-ja`` をインストールする。
 
@@ -29,7 +20,7 @@ Debian/Ubuntu の場合は ``help2man`` と ``language-pack-ja`` をインスト
 翻訳の手順
 ==========
 
-GNU coreutils ã\81®ã\83\9eã\83\8bã\83¥ã\82¢ã\83«ã\81¯ ``help2man`` ã\82\92使ã\81£ã\81¦ç\94\9fæ\88\90ã\81\97ています。
+GNU coreutils ã\81®ã\83\9eã\83\8bã\83¥ã\82¢ã\83«ã\81¯ ``help2man`` ã\82\92使ã\81£ã\81¦ç\94\9fæ\88\90ã\81\95ã\82\8cています。
 翻訳は以下の 2 つの組み合わせで生成されています。
 
 * GNU coreutils のコマンドの ``--help`` の出力
@@ -38,14 +29,14 @@ GNU coreutils のマニュアルは ``help2man`` を使って生成していま
 翻訳を始める前に
 ----------------
 
-``make all`` を実行すると ``GNU coreutils`` のソースが ``source`` 以下に展開され、
+``make`` を実行すると ``GNU coreutils`` のソースが ``source`` 以下に展開され、
 man page の自動生成の環境が整います。
 
 .. code-block:: console
 
    $ cd <JM repo top>
    $ cd manual/GNU_coreutils
-   $ make all
+   $ make
 
 補足事項
 
@@ -54,6 +45,34 @@ man page の自動生成の環境が整います。
 * トップディレクトリで ``make install`` を実行すると、
   ``help2man.ja/*.1`` が ``draft/man1`` にコピーされる。
 
+翻訳作業
+--------
+
+``source/po/ja.po`` と ``help2man.ja/*.x`` を編集して翻訳を行います。
+ファイルの詳細は :ref:`下記 <coreutils-files>` を参照のこと。
+
+これらのファイルに変更を加えた場合、 ``make`` を実行すると、
+対応するページが ``help2man.ja/*.1`` に生成されます。
+生成されたファイルを確認しながら、翻訳作業を繰り返します。
+
+翻訳校正
+--------
+
+.. warning::
+
+   暫定ルールです。方法が定まってきたらここに反映しましょう。
+
+以下をメーリングリストに投稿します。
+
+* 生成された manpage
+* 対応する ``*.x`` ファイル
+* coreutils の ``ja.po`` を変更した場合は ``ja.po`` の差分
+
+.. _coreutils-files:
+
+ファイルの説明
+==============
+
 coreutils の ja.po
 ------------------
 
@@ -63,12 +82,25 @@ coreutils の ja.po
 管理されています。
 
 変更が必要な場合は上記で展開された ``source/po/ja.po`` を編集します。
-変更後に上記の ``make all`` を実行すると、
+変更後に上記の ``make`` を実行すると、
 ``help2man.ja/`` 以下に ``*.1`` が生成されます。
 
-変更を行ったものは基本的に
-`Translation Project <http://translationproject.org/team/ja.html>`_
-に反映するのが筋だと思います。
+変更を行った場合は、編集した ``source/po/ja.po`` を
+``ja.po/ja.po.<VERSION>`` にコピーしておきます。
+すでに ``ja.po/ja.po.<VERSION>`` が存在している場合は、
+「翻訳を始める前に」の ``make`` の中で、
+``source/po/ja.po`` は ``ja.po/ja.po.<VERSION>`` へのシンボリックリンク
+になっているため、上記のコピーは不要です。
+
+.. note::
+
+   なお、 ``ja.po`` に変更を行った場合は、基本的に
+   `Translation Project <http://translationproject.org/team/ja.html>`_
+   に反映するのが筋だと思います。これにより、次回以降の GNU coreutils
+   のリリースに変更が反映されます。
+   ただし、今のリリースバージョンへの反映はできないため、
+   JM リポジトリで ``ja.po/ja.po.<VERSION>`` を管理するのは
+   一定程度意味があると思われる。
 
 help2man.ja/\*.x
 ----------------
@@ -76,17 +108,9 @@ help2man.ja/\*.x
 ``help2man.ja/\*.x`` は help2man が生成する man page に組み込まれます。
 
 ``help2man.ja`` の翻訳では、
-原文は roff の場合と同じく ``.\"O`` で始めるものとします。
-
-変更の翻訳への反映方法は ``ja.po`` の場合と同じく
-``make html`` を実行します。
-
-翻訳校正 (暫定ルール)
-=====================
+原文は roff の場合と同じく ``.\"O`` でコメントアウトするものとします。
 
-* ``*.x`` を投稿する。
-  original の翻訳者が manpage も投稿してもよい。
+すでにファイルがある場合は、
+``help2man.orig`` 内の対応するファイルの内容が ``help2man.ja`` の方にも
+反映されているかを確認すること。
 
-* JM git repo に登録時に manpage を committer が生成する。
-  mandiff.py などで HTML を生成して、original と翻訳の比較ができるようにする。
-  Makefile のルールを追加しておきたい。